VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: Layout

Source Location: /graphics.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Layout

Layout encapsulation to allow any component to hold controls and render them in very different ways


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods

Class: Persistent

Persistent::allowserialize()
This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign()
Assigns the source properties to this object.
Persistent::assignError()
Raises an assignation error.
Persistent::assignTo()
Assigns this object to another object.
Persistent::inSession()
This method determines if this object exists in the current session.
Persistent::readNamePath()
Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner()
Owner of the component.
Persistent::serialize()
Stores this object into the session.
Persistent::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.

Class: Object

Object::__construct()
Constructs an object and initializes its data before the object is first used.
Object::className()
Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs()
Determines whether an object is of a specific type.
Object::classParent()
Returns the type of the immediate ancestor of a class.
Object::inheritsFrom()
Determines the relationship of two object types.
Object::methodExists()
Check if a method exists declared on this object instance.
Object::readProperty()
Reads a property from the streams
Object::__get()
To virtualize properties
Object::__set()
To virtualize properties

Class Details

[line 71]
Layout encapsulation to allow any component to hold controls and render them in very different ways



Tags:



[ Top ]


Class Variables

$_cols = 5

[line 116]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_control = null

[line 73]



Tags:

access:  public

Type:   mixed


[ Top ]

$_rows = 5

[line 100]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_usepixeltrans = 1

[line 127]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method cmp_obj [line 201]

integer cmp_obj( $a, $b)

Compares top position of two objects, for internal use



Tags:

return:  0=top are equals, +1 $a->Top > $b->Top, -1 $a->Top < $b->Top
see:  Layout::dumpRELLayout()


Parameters:

   $a  
   $b  

[ Top ]

method defaultCols [line 125]

void defaultCols( )



[ Top ]

method defaultRows [line 114]

void defaultRows( )



[ Top ]

method defaultType [line 98]

void defaultType( )



[ Top ]

method defaultUsePixelTrans [line 140]

void defaultUsePixelTrans( )



[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

method getCols [line 123]

integer getCols( )

Columns for this layout, used in GRIDBAG_LAYOUT and ROW_LAYOUT



Tags:



[ Top ]

method getRows [line 112]

integer getRows( )

Rows for this layout, used in GRIDBAG_LAYOUT and COL_LAYOUT



Tags:



[ Top ]

method getType [line 96]

enum getType( )

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




[ Top ]

method getUsePixelTrans [line 138]

boolean getUsePixelTrans( )

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.




[ Top ]

method readOwner [line 102]

void readOwner( )



Overrides Persistent::readOwner() (Owner of the component.)

[ Top ]

method setCols [line 124]

void setCols( $value)



Parameters:

   $value  

[ Top ]

method setRows [line 113]

void setRows( $value)



Parameters:

   $value  

[ Top ]

method setType [line 97]

void setType( $value)



Parameters:

   $value  

[ Top ]

method setUsePixelTrans [line 139]

void setUsePixelTrans( $value)



Parameters:

   $value  

[ Top ]


Documentation generated on Sat, 13 Jun 2009 10:51:44 -0700 by phpDocumentor 1.4.1