com.sas.servlet.tbeans.tableview.html
Class CellContentsLabelRenderer

com.sas.servlet.tbeans.tableview.html.CellContentsLabelRenderer

All Implemented Interfaces:

ActionProviderViewInterface, HttpActionProviderInterface, HttpActionProviderViewInterface, com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, RenderableInterface, StyleInterface, TableCellContentsRenderer, com.sas.servlet.tbeans.TitleInterface, TransformationInterface, URLInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

CellContentsNoRowsRenderer, TextAction

public class CellContentsLabelRenderer
implements TableCellContentsRenderer

The CellContentsLabelRenderer is a TransformationBean™ that generates the appropriate HTML 4.0 to represent the contents of a cell as an HTML label.

Note that the toString() method on this class calls the write method, which may have undesirable side effects. See BaseTransformation.toString() for more information. Debuggers often use toString() to show the value of a variable, and this may cause unexpected behavior while debugging

For More Information:

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on the sas:CellContentsLabelRenderer custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

See Also:

Serialized Form

Constructor Summary

CellContentsLabelRenderer()
Default constructor

Method Summary

ActionList	getActions() Gets the list of valid actions for this cell.
TransformationInterface	getCellContentsRendererComponent(AbstractBaseTableView viewer, java.lang.Object value, ActionList actions) Returns the tbean used for rendering the contents of the tableview's cell.
AbstractBaseTableView	getTableView() Gets the instance of the AbstractBaseTableView containing this cell.
void	setActions(ActionList actions) Sets the list of valid actions for this cell.
void	setLocale(java.util.Locale loc) Set the locale
void	setTableView(AbstractBaseTableView viewer) Sets the instance of the AbstractBaseTableView containing this cell.
void	write(java.io.PrintWriter out) If actions is null, then this method formats and writes the contents of the cell as an label.

Methods inherited from class com.sas.servlet.tbeans.BaseLabel

getActionProvider, getActionSupportType, getFor, getNullTextString, getStyleInfo, getTarget, getText, getTitle, getURL, isEncodedURL, isEncodeText, setEncodedURL, setEncodeText, setFor, setNullTextString, setStyleInfo, setTarget, setText, setTitle, setURL

Methods inherited from class com.sas.servlet.tbeans.BaseActionTransformation

dispose, getUniqueId, isActionVisible, listActionTypes, listAreaTypes, setActionProvider, setActionSupportType, setActionVisible, setUniqueId

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setId, setInputTransform, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.servlet.tbeans.TransformationInterface

getCustomAttributes, getDescription, getId, getLocale, getName, getRequest, getResponse, getTagEpilog, getTagProlog, isVisible, setCustomAttributes, setDescription, setId, setName, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, write, write, write

Methods inherited from interface com.sas.actionprovider.HttpActionProviderViewInterface

getRequest, setRequest

Constructor Detail

CellContentsLabelRenderer

public CellContentsLabelRenderer()

Default constructor

Method Detail

getCellContentsRendererComponent

public TransformationInterface getCellContentsRendererComponent(AbstractBaseTableView viewer,
                                                                java.lang.Object value,
                                                                ActionList actions)

Returns the tbean used for rendering the contents of the tableview's cell. This method is used to configure the contents renderer appropriately before writing out the component.

Specified by:

getCellContentsRendererComponent in interface TableCellContentsRenderer

Parameters:

viewer - the instance of the tableview being written.

value - the value to display as the cell's contents

actions - an actionlist of all the valid actions for this cell

Returns:

the contents renderer for this cell

setActions

public void setActions(ActionList actions)

Sets the list of valid actions for this cell.

Specified by:

setActions in interface TableCellContentsRenderer

Parameters:

actions - an actionlist of all the valid actions for this cell

getActions

public ActionList getActions()

Gets the list of valid actions for this cell.

Specified by:

getActions in interface TableCellContentsRenderer

Returns:

the actionlist of all the valid actions for this cell, or null if not set

setTableView

public void setTableView(AbstractBaseTableView viewer)

Sets the instance of the AbstractBaseTableView containing this cell.

Specified by:

setTableView in interface TableCellContentsRenderer

Parameters:

tableview - an instance of AbstractBaseTableView containing this cell

getTableView

public AbstractBaseTableView getTableView()

Gets the instance of the AbstractBaseTableView containing this cell.

Specified by:

getTableView in interface TableCellContentsRenderer

Returns:

the tableview containing this cell

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

If actions is null, then this method formats and writes the contents of the cell as an label. Otherwise, the actions are rendered. This method calls the cleanUpResources() method at the end to reset the request and response back to null.

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class Label

Parameters:

out - the output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

setLocale

public void setLocale(java.util.Locale loc)

Set the locale

Specified by:

setLocale in interface TransformationInterface

Overrides:

setLocale in class BaseTransformation

Parameters:

locale -