{
my $class = shift;
my $self = $class->SUPER::new(@_);
-
- $self->{TXTOBJ} = Excel::Template::Factory->create('TEXTOBJECT');
-
+
+ $self->{TXTOBJ} = Excel::Template::Factory->_create('TEXTOBJECT');
+
return $self;
}
-sub get_text
+sub _get_text
{
my $self = shift;
my ($context) = @_;
-
+
my $txt = $context->get($self, 'TEXT');
if (defined $txt)
{
- my $txt_obj = Excel::Template::Factory->create('TEXTOBJECT');
+ my $txt_obj = Excel::Template::Factory->_create('TEXTOBJECT');
push @{$txt_obj->{STACK}}, $txt;
$txt = $txt_obj->resolve($context);
}
- elsif ($self->{TXTOBJ})
- {
- $txt = $self->{TXTOBJ}->resolve($context)
- }
else
{
-# $txt = Unicode::String::utf8('');
- $txt = '';
+ $txt = $self->{TXTOBJ}->resolve($context)
}
-
+
return $txt;
}
+my %legal_types = (
+ 'blank' => 'write_blank',
+ 'formula' => 'write_formula',
+ 'number' => 'write_number',
+ 'string' => 'write_string',
+ 'url' => 'write_url',
+);
+
sub render
{
my $self = shift;
- my ($context) = @_;
+ my ($context, $method) = @_;
+
+ unless ( $method )
+ {
+ my $type = $context->get( $self, 'TYPE' );
+ if ( defined $type )
+ {
+ my $type = lc $type;
+
+ if ( exists $legal_types{ $type } )
+ {
+ $method = $legal_types{ $type };
+ }
+ else
+ {
+ warn "'$type' is not a legal cell type.\n"
+ if $^W;
+ }
+ }
+ }
+
+ $method ||= 'write';
+
+ my ($row, $col) = map { $context->get($self, $_) } qw(ROW COL);
+
+ my $ref = $context->get( $self, 'REF' );
+ if (defined $ref && length $ref)
+ {
+ $context->add_reference( uc( $ref ), $row, $col );
+ }
+
+ # Apply the cell width to the current column
+ if (my $width = $context->get($self, 'WIDTH'))
+ {
+ $width =~ s/\D//g;
+ $width *= 1;
+ if ($width > 0)
+ {
+ $context->active_worksheet->set_column($col, $col, $width);
+ }
+ }
- $context->active_worksheet->write(
- (map { $context->get($self, $_) } qw(ROW COL)),
- $self->get_text($context),
+ $context->active_worksheet->$method(
+ $row, $col,
+ $self->_get_text($context),
$context->active_format,
);
=head1 INHERITANCE
-Excel::Template::Element
+L<ELEMENT|Excel::Template::Element>
=head1 ATTRIBUTES
=item * TEXT
-This is the text to write to the cell. This can either be text or a parameter
-with a dollar-sign in front of the parameter name.
+This is the text to write to the cell. This can either be text or a parameter with a dollar-sign in front of the parameter name.
=item * COL
-Optionally, you can specify which column you want this cell to be in. It can be
-either a number (zero-based) or an offset. See Excel::Template for more info on
-offset-based numbering.
+Optionally, you can specify which column you want this cell to be in. It can be either a number (zero-based) or an offset. See L<Excel::Template> for more info on offset-based numbering.
+
+=item * REF
+
+Adds the current cell to the a list of cells that can be backreferenced. This is useful when the current cell needs to be referenced by a formula. See L<BACKREF|Excel::Tepmlate::Element::Backref> and L<RANGE|Excel::Tepmlate::Container::Range>.
+
+=item * WIDTH
-=back 4
+Sets the width of the column the cell is in. The last setting for a given column
+will win out.
+
+=item * TYPE
+
+This allows you to specify what write_*() method will be used. The default is to call write() and let L<Spreadsheet::WriteExcel> make the right call. However, you may wish to override it. L<Excel::Template> will not do any form of validation on what you provide. You are assumed to know what you're doing.
+
+The legal types (taken from L<Spreadsheet::WriteExcel>) are:
+
+=over 4
-There will be more parameters added, as features are added.
+=item * blank
+
+=item * formula
+
+=item * number
+
+=item * string
+
+=item * url
+
+=back
+
+q.v. L<Spreadsheet::WriteExcel> for more info.
+
+=back
=head1 CHILDREN
-Excel::Template::Element::Formula
+L<FORMULA|Excel::Template::Element::Formula>
=head1 EFFECTS
-This will consume one column on the current row.
+This will consume one column in the current row.
=head1 DEPENDENCIES
<cell text="$Param2"/>
<cell>Some <var name="Param"> text here</cell>
-In the above example, four cells are written out. The first two have text hard-
-coded. The second two have variables. The third and fourth items have another
-thing that should be noted. If you have text where you want a variable in the
-middle, you have to use the latter form. Variables within parameters are the
-entire parameter's value.
-
-Please see Spreadsheet::WriteExcel for what constitutes a legal formula.
-
-=head1 BACK-REFERENCES
+In the above example, four cells are written out. The first two have text hard-coded. The second two have variables. The third and fourth items have another thing that should be noted. If you have text where you want a variable in the middle, you have to use the latter form. Variables within parameters are the entire parameter's value.
-Currently, you can only use a hard-coded formula. The next release will add the
-capability to have a formula reference other nodes in the template dynamically.
+Please see L<Spreadsheet::WriteExcel> for what constitutes a legal formula.
=head1 AUTHOR
-Rob Kinyon (rkinyon@columbus.rr.com)
+Rob Kinyon (rob.kinyon@gmail.com)
=head1 SEE ALSO
-ROW, VAR, FORMULA
+L<ROW|Excel::Template::Container::Row>, L<VAR|Excel::Template::Element::Var>, L<FORMULA|Excel::Template::Element::Formula>
=cut
projects / p5sagit/Excel-Template.git / blobdiff