Description
Object | --Persistent | --Layout
Located in File: /graphics.inc.php
Layout encapsulation to allow any component to hold controls and render them in very different ways
- see: - FocusControl::Layout
Properties
Summary: | Cols | Columns for this layout, used in GRIDBAG_LAYOUT and ROW_LAYOUT |
| Rows | Rows for this layout, used in GRIDBAG_LAYOUT and COL_LAYOUT |
| Type | Type of this layout, it can be any value of the available ones: |
| UsePixelTrans | Specifies if the code generated should use a transparent pixel or not |
 | Owner | Owner of the component. [Publishes Persistent::Owner] |
Defined in class Persistent |
||
| NamePath | Used to serialize/unserialize. It returns the full path to identify this component. |
| Owner | Owner of the component. |
property Cols (line 123)
integer Cols
Columns for this layout, used in GRIDBAG_LAYOUT and ROW_LAYOUT
Info
- see - Layout::Rows
property Rows (line 112)
integer Rows
Rows for this layout, used in GRIDBAG_LAYOUT and COL_LAYOUT
Info
- see - Layout::Cols
property Type (line 96)
enum Type
Type of this layout, it can be any value of the available ones:
FLOW_LAYOUT - Controls are rendered without any layout, that is, one after another
XY_LAYOUT - Controls are rendered in their fixed pos, but using HTML tables
ABS_XY_LAYOUT - Controls are rendered using absolute position
REL_XY_LAYOUT - Controls are rendered using relative positions
GRIDBAG_LAYOUT - Controls are rendered in a grid, you can set the Rows and Cols
ROW_LAYOUT - Controls are rendered in a single row, Cols property sets how many cells
COL_LAYOUT - Controls are rendered in a single column, Rows property sets how many cells
property UsePixelTrans (line 138)
boolean UsePixelTrans
Specifies if the code generated should use a transparent pixel or not
To preserve compatibility with older browsers, tables must use a transparent pixel on empty cells to make the table behave correctly, on modern browsers you can set this property to false.
property NamePath
Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePathMethods
Summary: | cmp_obj | Compares top position of two objects, for internal use |
| | dumpABSLayout | Dump an absolute layout |
| | dumpColLayout | Dump a col layout |
| | dumpFlowLayout | Dump a flow layout, basically, no layout at all |
| | dumpGrid | Dump a grid layout |
| | dumpGridBagLayout | Dump a table layout |
| | dumpLayoutContents | Dump the layout contents depending on the layout type. |
| | dumpRELLayout | Dump a fixed coordinate layout using relative coordinates |
| | dumpRowLayout | Dump a row layout |
| | dumpXYLayout | Dump a fixed coordinate layout using tables |
Defined in class Persistent |
||
| serialize | Stores this object into the session. |
| unserialize | This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call. |
Defined in class Object |
||
| __construct | Constructs an object and initializes its data before the object is first used. |
| className | Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument). |
| classParent | Returns the type of the immediate ancestor of a class. |
Method cmp_obj (line 201)
integer cmp_obj( $a, $b)
Compares top position of two objects, for internal use
Parameters
- $a:
- $b:
Info
- return - 0=top are equals, +1 $a->Top > $b->Top, -1 $a->Top < $b->Top
- see - Layout::dumpRELLayout
Method dumpABSLayout (line 149)
void dumpABSLayout( [array $exclude = array()])
Dump an absolute layout
Dump all controls on the layout using absolute pixel coordinates.
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpColLayout (line 617)
void dumpColLayout( [array $exclude = array()])
Dump a col layout
Dumps a 1 col layout
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpFlowLayout (line 525)
void dumpFlowLayout( [array $exclude = array()])
Dump a flow layout, basically, no layout at all
This type of layout simply dumps controls in their creation order, one after another.
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpGrid (line 632)
void dumpGrid( [array $exclude = array()], integer $cols, integer $rows, string $width)
Dump a grid layout
This method is used for rowlayout, collayout and grid layout.
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
- integer $cols: Number of columns for the grid
- integer $rows: Number of rows for the grid
- string $width: Width for the layout
Method dumpGridBagLayout (line 593)
void dumpGridBagLayout( [array $exclude = array()])
Dump a table layout
This method dump all controls inside using the cols and rows set and using tables.
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpLayoutContents (line 571)
void dumpLayoutContents( [array $exclude = array()])
Dump the layout contents depending on the layout type.
It checks the type it has to dump and calls the appropiate method, you can also exclude certain controls to be rendered by passing an array with the classnames of the components you don't want to get rendered
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpRELLayout (line 219)
void dumpRELLayout( [array $exclude = array()])
Dump a fixed coordinate layout using relative coordinates
Dump all controls in the layout generating div tags using relative coordinates
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpRowLayout (line 605)
void dumpRowLayout( [array $exclude = array()])
Dump a row layout
Dumps a 1 row layout.
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping
Method dumpXYLayout (line 278)
void dumpXYLayout( [array $exclude = array()])
Dump a fixed coordinate layout using tables
Dump all controls in the layout generating tables and placing controls inside the right cells.
Parameters
- array $exclude: Classnames of the controls you want to exclude from dumping