Cory G Watson > Layout-Manager-0.34 > Layout::Manager::Compass

Download:
Layout-Manager-0.34.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Source   Latest Release: Layout-Manager-0.35

NAME ^

Layout::Manager::Compass - Compass based layout

DESCRIPTION ^

Layout::Manager::Compass is a layout manager that takes hints based on the four cardinal directions (north, east, south and west) plus a center area that takes up all remaining space (vertically).

In other words, the center area will expand to take up all space that is NOT used by components placed at the edges. Components at the north and south edges will take up the full width of the container.

  +--------------------------------+
  |              north             |
  +-----+--------------------+-----+
  |     |                    |     |
  |  w  |                    |  e  |
  |  e  |       center       |  a  |
  |  s  |                    |  s  |
  |  t  |                    |  t  |
  |     |                    |     |
  +-----+--------------------+-----+
  |              south             |
  +--------------------------------+

Components are placed in the order they are added. If two items are added to the 'north' position then the first item will be rendered above the second. The height of the north edge will equal the height of both components combined.

Items in the center split the available space, heightwise. Two center components will each take up 50% of the available height and 100% of the available width.

Compass is basically an implementation of Java's BorderLayout

SYNOPSIS ^

  $cont->add_component($comp1, 'north');
  $cont->add_component($comp2, 'east');

  my $lm = Layout::Manager::Compass->new;
  $lm->do_layout($cont);

POSITIONING ^

When you add a component with add_component the second argument should be one of: north, south, east, west or center. Case doesn't matter. You can also just provide the first letter of the word and it will do the same thing.

METHODS ^

do_layout

Size and position the components in this layout.

AUTHOR ^

Cory Watson, <gphat@cpan.org>

COPYRIGHT & LICENSE ^

Copyright 2008 - 2010 Cory G Watson

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

syntax highlighting: