NAME

Spreadsheet::HTML::Presets - Preset tables for fun and games.

DESCRIPTION

This is a container for Spreadsheet::HTML preset methods. These methods are not meant to be called from this package. Instead, use the Spreadsheet::HTML interface:

use Spreadsheet::HTML;
my $table = Spreadsheet::HTML->new( data => [[1],[2]] );

# or
use Spreadsheet::HTML qw( layout );
print layout( data => [[1],[2]] );

METHODS

• layout( %params )

  Layout tables are not recommended, but if you choose to use them you should label them as such. This adds W3C recommended layout attributes to the table tag and features: emit only <td> tags, no padding or pruning of rows, forces no HTML entity encoding in table cells.

• checkerboard( colors, %params )

  Preset for tables with checkerboard colors.

  checkerboard( colors => [qw(yellow orange)], extra => 'blue' )

  Attempts to form diagonal patterns by adding an extra color if need be. colors default to red and green and extra defaults to white.

• animate( direction, interval, jquery, %params )

  Moves the contents of each cell in the direction specified. Valid values are up, down, left and right.

  Set the timer with interval (defaults to 200 miliseconds).

  animate( direction => 'right', interval => 300 )

  Can optionally use x and/or y instead of direction to specify which axis(es) to animate.

  Uses Google's jQuery API unless you specify another URI via the jquery param. Javascript will be minified via Javascript::Minifier if it is installed.

• conway( on, off, fade, interval, jquery, %params )

  Game of life. From an implementation i wrote back in college.

  conway( on => 'red', off => 'gray' )

  Set the timer with interval (defaults to 200 miliseconds).

  conway( interval => 75 )

  If you have Color::Spectrum installed (and optionally Color::Library) then you can turn fade on for more effects:

  # without Color::Library
  conway( on => '#FF0000', off => '#999999', fade => 1 )
  
  # with Color::Library
  conway( on => 'red', off => 'gray', fade => 1 )

  Uses Google's jQuery API unless you specify another URI via the jquery param. Javascript will be minified via Javascript::Minifier if it is installed.

• calculator( jquery )

  Generates a simple calculator.

  Uses Google's jQuery API unless you specify another URI via the jquery param. Javascript will be minified via Javascript::Minifier if it is installed.

• checkers( %params )

  Generates a static checkers game board (US).

• chess( %params )

  Generates a static chess game board.

• dk( %params )

• shroom( %params )

CUSTOMIZATION

You can use the methods in this package as an example for constructing your own custom Spreadsheet::HTML generators.

use Spreadsheet::HTML;

sub my_generator {
    my ($self,$data,$params);
    $self = shift if ref($_[0]) =~ /^Spreadsheet::HTML/;
    ($self,$data,$params) = $self 
        ? $self->_args( @_ ) 
        : Spreadsheet::HTML::_args( @_ );

    # pull out custom named parameters from $params
    my $color = $params->{color};

    my @params = (
        # add custom params that client CAN overide here
        @_,
        # add custom params that client can NOT overide here
    );

    $self ? $self->generate( @params ) : Spreadsheet::HTML::generate( @params );
}

It is not pretty, but it keeps the named parameters in line even if stray, bare array references are used by the client:

$table->my_generator( [ 'data here' ], color => 'red' );

A simpler, less flexible form is available if you do not need to pull out client params:

use Spreadsheet::HTML;

sub my_generator {
    my $self = shift if ref($_[0]) =~ /^Spreadsheet::HTML/;

    my @params = (
        # add custom params that client CAN overide here
        @_,
        # add custom params that client can NOT overide here
    );

    $self ? $self->generate( @params ) : Spreadsheet::HTML::generate( @params );
}

Plans are in the works to simplify this "API," possibly even to provide a real plugin interface.

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2015 Jeff Anderson.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.