SwatObject
└─SwatUIObject
└─SwatCellRendererContainer
public abstract class SwatCellRendererContainer
extends SwatUIObject
| Field Summary | |
|---|---|
| protected SwatCellRendererSet | The set of SwatCellRenderer objects contained in this container. |
| Fields inherited from Swat.SwatUIObject | |
|---|---|
| classes, html_head_entry_set, parent, visible | |
| Constructor Summary | |
|---|---|
Creates a new cell renderer container. |
|
| Method Summary | |
|---|---|
| void | addChild(SwatCellRenderer child) Add a child object to this object. |
| SwatCellRendererMapping | addMappingToRenderer(SwatCellRenderer renderer, string data_field, string property, SwatUIObject object) Links a data-field to a cell renderer property of a cell renderer within this container. |
| void | addRenderer(SwatCellRenderer renderer) Adds a cell renderer to this container's set of renderers. |
| SwatUIObject | copy(string id_suffix) Performs a deep copy of the UI tree starting with this UI object. |
| array | Gets descendant states. |
| array | getDescendants(string class_name) Gets descendant UI-objects. |
| SwatUIObject | getFirstDescendant(string class_name) Gets the first descendant UI-object of a specific class. |
| SwatCellRenderer | Gets the first cell renderer in this container. |
| SwatHtmlHeadEntrySet | Gets the SwatHtmlHeadEntry objects needed by this cell renderer container. |
| SwatCellRenderer | getRenderer(mixed renderer_id, string the) Gets a cell renderer of this container by its unique identifier. |
| SwatCellRenderer | getRendererByPosition(mixed position, $position the) Gets a cell renderer in this container based on its ordinal position. |
| string | Gets inline JavaScript used by all cell renderers within this cell renderer container. |
| array | Gets the cell renderers of this container. |
| void | setDescendantStates(array states) Sets descendant states. |
| Methods inherited from Swat.SwatUIObject | |
|---|---|
| addComment, addJavaScript, addStyleSheet, addTangoAttribution, copy, getCSSClassNames, getCSSClassString, getFirstAncestor, getHtmlHeadEntrySet, getInlineJavaScript, getUniqueId, isVisible | |
protected SwatCellRendererSet $renderers = null
The set of SwatCellRenderer objects contained in this container
public SwatCellRendererContainer()
Creates a new cell renderer container
public void addChild(SwatCellRenderer child)
Add a child object to this object
child - the reference to the child object to add.public SwatCellRendererMapping addMappingToRenderer(SwatCellRenderer renderer, string data_field, string property, SwatUIObject object)
Links a data-field to a cell renderer property of a cell renderer within this container
renderer - the cell renderer in this container onto which the data-field is to be mapped.data_field - the field of the data model to map to the cell renderer property.property - the property of the cell renderer to which the $data_field is mapped.object - optional. The object containing the property to map when the property does not belong to the cell renderer itself. If unspecified, the $property must be a property of the given cell renderer.public void addRenderer(SwatCellRenderer renderer)
Adds a cell renderer to this container's set of renderers
renderer - the renderer to add.public SwatUIObject copy(string id_suffix)
Performs a deep copy of the UI tree starting with this UI object
id_suffix - optional. A suffix to append to copied UI objects in the UI tree.public array getDescendantStates()
Gets descendant states
Retrieves an array of states of all stateful UI-objects in the widget subtree below this cell renderer container.
public array getDescendants(string class_name)
Gets descendant UI-objects
class_name - optional class name. If set, only UI-objects that are instances of $class_name are returned.public SwatUIObject getFirstDescendant(string class_name)
Gets the first descendant UI-object of a specific class
class_name - class name to look for.public SwatCellRenderer getFirstRenderer()
Gets the first cell renderer in this container
public SwatHtmlHeadEntrySet getHtmlHeadEntrySet()
Gets the SwatHtmlHeadEntry objects needed by this cell renderer container
public SwatCellRenderer getRenderer(mixed renderer_id, string the)
Gets a cell renderer of this container by its unique identifier
the - unique identifier of the cell renderer to get.public SwatCellRenderer getRendererByPosition(mixed position, $position the)
Gets a cell renderer in this container based on its ordinal position
the - ordinal position of the cell renderer to get. The position is zero-based.public string getRendererInlineJavaScript()
Gets inline JavaScript used by all cell renderers within this cell renderer container
public array getRenderers()
Gets the cell renderers of this container
public void setDescendantStates(array states)
Sets descendant states
Sets states on all stateful UI-objects in the widget subtree below this cell renderer container.
states - an array of UI-object states with UI-object identifiers as array keys.
Abstract base class for objects which contain cell renderers.