Most components do the majority of their setup in the <B>prepareB>. The goal of
prepare is to establish its minimum height and width so that it can be
properly positioned by a layout manager.
This is not a method of Component, but a phase introduced by the use of
Layout::Manager. If the component is a container then each of its
child components (even the containers) will be positioned according to the
minimum height and width determined during <B>prepareB>. Different layout
manager implementations have different rules, so consult the documentation
for each for details. After this phase has completed the origin, height and
width should be set for all components.
This final phase provides and opportunity for the component to do any final
changes to its internals before being passed to a driver for drawing.
An example might be a component that draws a fleuron at its extremities.
Since the final height and width isnt known until this phase, it was
impossible for it to position these internal components until now. It may
even defer creation of this components until now.
Handled by Graphics::Primitive::Driver.
new Creates a new Component.
background_color Set this components background color. border Set this components border, which should be an instance of Border. callback Optional callback that is fired at the beginning of the finalize phase. This allows you to add some sort of custom code that can modify the component just before it is rendered. The only argument is the component itself. class Set/Get this components class, which is an abitrary string. Graphics::Primitive has no internal use for this attribute but provides it for outside use. color Set this components foreground color. fire_callback Method to execute this components callback. get_tree Get a tree for this component. Since components are by definiton leaf nodes, this tree will only have the one member at its root. has_callback Predicate that tells if this component has a callback. height Set this components height. inside_bounding_box Returns a Rectangle that defines the edges of the inside box for this component. This box is relative to the origin of the component. inside_height Get the height available in this container after taking away space for padding, margin and borders. inside_width Get the width available in this container after taking away space for padding, margin and borders. margins Set this components margins, which should be an instance of Insets. Margins are the space outside the components bounding box, as in CSS. The margins should be outside the border. maximum_height Set/Get this components maximum height. Used to inform a layout manager. maximum_width Set/Get this components maximum width. Used to inform a layout manager. minimum_height Set/Get this components minimum height. Used to inform a layout manager. minimum_inside_height Get the minimum height available in this container after taking away space for padding, margin and borders. minimum_inside_width Get the minimum width available in this container after taking away space for padding, margin and borders. minimum_width Set/Get this components minimum width. Used to inform a layout manager. name Set this components name. This is not required, but may inform consumers of a component. Pay attention to that librarys documentation. origin Set/Get the origin point for this component. outside_height Get the height consumed by padding, margin and borders. outside_width Get the width consumed by padding, margin and borders. finalize Method provided to give component one last opportunity to put its contents into the provided space. Called after prepare. padding Set this components padding, which should be an instance of Insets. Padding is the space inside the components bounding box, as in CSS. This padding should be between the border and the components content. page If true then this component represents stand-alone page. This informs the driver that this component (and any children) are to be renderered on a single surface. This only really makes sense in formats that have pages such as PDF of PostScript. prepare Method to prepare this component for drawing. This is an empty sub and is meant to be overridden by a specific implementation. preferred_height Set/Get this components preferred height. Used to inform a layout manager. preferred_width Set/Get this components preferred width. Used to inform a layout manager. to_string Get a string representation of this component in the form of:
$name $x,$y ($widthx$height)
visible Set/Get this components visible flag. width Set/Get this components width.
Cory Watson, <firstname.lastname@example.org>
Please report any bugs or feature requests to bug-geometry-primitive at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geometry-Primitive>. I will be notified, and then youll automatically be notified of progress on your bug as I make changes.
Copyright 2008-2009 by Cory G Watson.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
|perl v5.20.3||GRAPHICS::PRIMITIVE::COMPONENT (3)||2015-01-04|