A non-visible unique id for this cell renderer, or null

Sensitive

Whether this renderer is sensitive. If a renderer is sensitive it reacts to user input. Unsensitive renderers should display "grayed-out" to inform the user they are not sensitive. All renderers that react to user input should respect this property in their display() method.

Gets the base CSS class names for this cell renderer

This is the recommended place for cell-renderer subclasses to add extra hard-coded CSS classes.

Returns:

the array of base CSS class names for this cell renderer.

Gets the data specific CSS class names for this cell renderer

This is the recommended place for cell-renderer subclasses to add extra hard-coded CSS classes that depend on data-bound properties of this cell-renderer.

Returns:

the array of base CSS class names for this cell renderer.

Gets the SwatHtmlHeadEntry objects needed by this cell renderer

If this renderer has never been rendered, an empty set is returned to reduce the number of required HTTP requests.

Returns:

the SwatHtmlHeadEntry objects needed by this cell renderer.

Gets the CSS class names of this cell renderer based on the inheritance tree for this cell renderer

For example, a class with the following ancestry:

SwatCellRenderer -> SwatTextCellRenderer -> SwatNullTextCellRenderer

will return the following array of class names:

<?php
array(
   'swat-cell-renderer',
   'swat-text-cell-renderer',
   'swat-null-text-cell-renderer',
);
?>

Returns:

the array of CSS class names based on an inheritance tree for this cell renderer.

Gets ths inline JavaScript required by this cell renderer

Returns:

the inline JavaScript required by this cell renderer.

Gathers all messages from this cell renderer

By default, cell renderers do not have messages. Subclasses may override this method to return messages.

Returns:

an array of {@link SwatMessage} objects.

Get a property name to use for mapping

This method can be overridden by sub-classes that need to modify the name of a property mapping. This allows cell renderers which conatin multiple SwatUIObject object to mangle property names if necessary to avoid conflicts.

Parameters:

object - the object containing the property that is being mapped. Usually this is the cell renderer itself, but not necessarily. It could be a UIObject within the cell renderer.

name - the name of the property being mapped.

Returns:

the name of the property to actually map. This property should either exist as a public property of the cell renderer or be handled by a magic __set() method.

Gets whether or not this cell renderer has messages

By default, cell renderers do not have messages. Subclasses may override this method if they have messages.

Returns:

true if this cell renderer has one or more messages and false if it does not.

Called during the init phase

Sub-classes can redefine this method to perform any necessary processing.

Checks if a public property is static (can not be data-mapped)

This method takes a property name and returns a boolean representing weather or not the property has been made static.

Parameters:

property_name - the property name to check.

Returns:

true if the property is static and false if the property may be data-mapped.

See Also:

SwatCellRenderer::makePropertyStatic()

Make a public property static

This method takes a property name and marks it as static, meaning that a user can not data-map this property.

Parameters:

string - the property name

See Also:

SwatCellRenderer::isPropertyStatic()

Throws:

if the specified $property_name is not a non-static public property of this class.

Called during processing phase

Sub-classes can redefine this method to perform any necessary processing.

Renders this cell

Renders this cell using the values currently stored in class variables.

Cell renderer subclasses should extend this method to do all output neccessary to display the cell.