Toshimasa Ishibashi - 石橋 利真 > Imager-DTP-0.06 > Imager::DTP::Textbox



Annotate this POD


New  1
Open  0
View/Report Bugs
Module Version: 0.04   Source  


Imager::DTP::Textbox - multi-byte text handling module with text wrapping and line alignment, for use with Imager.


   use Imager::DTP::Textbox::Horizontal;  # or Vertical
   # first, define font & text string
   my $font  = Imager::Font->new(file=>'path/to/foo.ttf',type=>'ft2',
   my $text  = 'The Greater Of Two Evils';
   # create instance
   my $tb = Imager::DTP::Textbox::Horizontal->new(
   # draw the text string on target image
   my $target = Imager->new(xsize=>250,ysize=>250);
   $target->box(filled=>1,color=>'#FFFFFF'); # with white background
   # and write out image to file


Imager::DTP::Textbox is a module intended for handling sentences and paragraphs consisted with multi-byte characters, such as Japanese and Chinese. It supports text wrapping and line alignment, and is able to draw text string vertically from top to bottom as well. All the text string provided (by setText() method) will be splitted by "\n", and each chunk will be turned into Imager::DTP::Line instance internally. So in another words, Imager::DTP::Textbox can be described as "a big box to put lines and letters in order". It's like WWW Browser's textarea input, or Adobe Illustrator's textbox tool.

   # creating instance - basic way
   my $tb = Imager::DTP::Textbox::Horizontal->new();
   $tb->setText(text=>$text,font=>$font); # set text with font
   $tb->setWspace(pixel=>5); # set space between letters
   $tb->setLeading(percent=>180); # set space between lines
   $tb->setAlign(halign=>'left',valign=>'top'); # set text alignment
   $tb->setWrap(width=>200,height=>150); # set text wrapping
   $tb->setLetterScale(x=>1.2,y=>0.5); # set letter transform scale
   # creating instance - or the shorcut way
   my $tb = Imager::DTP::Textbox::Horizontal->new(
               text=>$text,     # set text
               font=>$font,     # set font
               wspace=>5,       # set word distance (pixels)
               leading=>150,    # set line distance (percent)
               halign=>'left',  # set horizontal alignment
               valign=>'top',   # set vertical alignment
               wrapWidth=>200,  # set text wrap width
               wrapHeight=>180, # set text wrap height
               xscale=>1.5,     # set letter transformation x scale
               yscale=>0.5,     # set letter transformation y scale


Imager::DTP::Textbox is an ABSTRACT CLASS. The extended class would be Imager::DTP::Textbox::Horizontal and Imager::DTP::Textbox::Vertical. (Yes, I know the package name is much longer than it should be... I took the advantage of comprehension). So you must "use" the extended class (either of Horizonal or Vertical), and not the Imager::DTP::Textbox itself. The difference between Horizontal and Vertical is as follows:


letters are drawn from left to right, line stacks from top to bottom.


letters are drawn from top to bottom, line stacks from right to left.




Can be called with or without options.

   use Imager::DTP::Textbox::Horizontal;
   my $tb = Imager::DTP::Textbox::Horizontal->new();
   # or set all/any options at the same time
   my $font  = Imager::Font->new(file=>'path/to/foo.ttf',type=>'ft2',
   my $text  = "Hello me... meet the real me.\n";
      $text .= "And my misfits way of life.";
   my $tb = Imager::DTP::Textbox::Horizontal->new(text=>$text,
            font=>$font, wspace=>5, leading=>150, halign=>'left',
            valign=>'top', wrapWidth=>200, wrapHeight=>180,
            xscale=>1.2, yscale=>0.5);


Set text string to the instance. Text must not be undef or '', and font option is not optional either. For multi-byte letters/characters, text must be encoded to utf8, with it's internal utf8-flag ENABLED (This could be done by using utf8::decode() method).

   my $font  = Imager::Font->new(file=>'path/to/foo.ttf',type=>'ft2',
   my $text  = 'Smashing through the boundaries,';
      $text .= 'Lunacy has found me...';

By default, each time the method is called, it replaces the previous text with the provided new text. But by putting the "add" option, it will add new text to the end of the current text.

   my $moreText = 'Cannot stop the battery!';

Font is optional this time. If there is any previous text set, the new text will automatically inherit the font preference of last line, last letter's font preference.

The following characters will be translated to corresponding string internally:

\r => \n
\r\n => \n

"\n" will be used as a delimiter for splitting text string to each line object, and "\t" will stay the same until the time of draw() method call (see description of Imager::DTP::Line->draw() method for what will happen then).


Set size for blank spaces inserted in between each letters. See Imager::DTP::Line->setWspace() for more description.

   # setting a 5 pixel word space


The word "leading" in DTP application means "space between two consecutive lines". Thus, by setting some value (in percentage) here will affect the distance between each line. The default value is 150%, so setting any value greater than this will widen the distance, and setting smaller value (like 50%) will make the lines come closer (and with 50%, it will probably end up with two lines overlapping a little).

   # set leading to 180%

The percentage is based on the ascent value of a letter, which has the maximum value out of all the letters held inside.


Set horizontal and vertical alignment of lines, as if viewed from draw() method's x and y point.


Available options are:

halign (horizontal alignment)

left / center / right

valign (vertical alignment)

top / center / bottom

The default alignment for each extended class is as follows:


halign => 'left' valign => 'top'


halign => 'right' valign => 'top'


Set the maximum width and height of the bounding box, for the lines and letters to be wrapped inside. By setting these values to 0 will disable text wrapping (which is the default setting). Width will always be the horizontal measure, and height will be the vertical measure, no matter which extended class you choose (Imager::DTP::Textbox::Horizontal or Vertical).

   # set x axis bounding to 200 pixels
   # set both x/y axis bounding to 100 pixels

Wrapping logic is letter-based, meaning text may be wrapped right in the middle of a "word", which is a normal wrapping rule for multi-byte texts (at least for Japanese, yes) in DTP applications. But with single-byte character word, this logic will make the sentence look ugly, so I've added some logic for single-byte character words to "always wrap at the beginning of the word". With it, alphabetical sentences and paragraphs will look OK, although hyphenation is not implemented (yet).


Setting x/y scale will make each letter transform to the specified ratio. See <Imager::DTP::Letter>->setScale() method for further description.

   # make width of each letter to 80%
   # make width 120% and height 60%


Draw all the lines and letters held with-in, to the target image (Imager object).

   my $target = Imager->new(xsize=>250,ysize=>250);

Each letter is drawn with Imager::DTP::Letter->draw() method, which internally is using Imager->String() method, so you can pass any extra Imager::String options to it by setting in 'others' option (See more details in Imager::DTP::Letter->draw() method description).

   # passing Imager::String options

There is an extra debug option, which will draw a 'width x height' dark gray box underneath the textbox, a light grax box underneath each line, and a black bounding box for each letters. Handy for checking each object's bounding size/position.

   # debug mode

Obtaining text drawn image

By NOT passing any target option, the method will return an Imager object, with all the lines and letters drawn to it. This is usefull when you want to perform some transformation (such as X/Y scaling, cropping, color filtering) to these text string.

   # obtaining text drawn image
   # x/y position will be forced at (0,0)
   my $newimg = $tb->draw();
   # apply some Imager's transformation method
   my $scaled = $newimg->scaleX(pixels=>100);


Calling these methods will return a property value corresponding to the method name.


Returns a reference (pointer) to an array containing all the Imager::DTP::Line object held internally.


Returns the current value of leading.


Return the actuall width of textbox. Actuall here means "not the wrapping width", but the precise width of the lines and letters held inside.


Return the actuall height of textbox. Actuall here means "not the wrapping height", but the precise height of the lines and letters held inside.


Returns the current value of horizontal alignment.


Returns the current value of vertical alignment.


Returns the current value of horizontal text wrap bounding.


Returns the current value of vertical text wrap bounding.



Toshimasa Ishibashi, <>


Copyright 2005 Toshimasa Ishibashi, all rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


Imager, Imager::DTP

syntax highlighting: