|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectCellDecorator
public abstract class CellDecorator
Abstract basee class used to render the contents of a data grid cell. CellDecorators are used so that code used to render the contents of a data grid cell can be chained together in order to compose different rendering patterns. For example, an HTML anchor and image decorator could be composed together to create an image anchor renderer. In addition, cell decoration can be used to display UI exposing custom data grid features such as sort or filter UI on data grid header cells.
CellDecorators are intended to be stateless. State required for rendering should be passed to
a CellDecorator using an instance of a CellModel
class.
Constructor Summary | |
---|---|
CellDecorator()
Default constructor. |
|
CellDecorator(CellDecorator cellDecorator)
Constructor that takes a nested CellDecorator. |
Method Summary | |
---|---|
abstract void |
decorate(JspContext jspContext,
AbstractRenderAppender appender,
CellModel cellModel)
This method is implemented by subclasses to provide decoration behavior. |
CellDecorator |
getNestedDecorator()
Get the nested decorator. |
void |
setNestedDecorator(CellDecorator cellDecorator)
Set the nested cell decorator. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CellDecorator()
public CellDecorator(CellDecorator cellDecorator)
cellDecorator
- the nested decorator which can optionally be used by implementations
to render additional UI for the cell.Method Detail |
---|
public CellDecorator getNestedDecorator()
null
otherwise.public void setNestedDecorator(CellDecorator cellDecorator)
cellDecorator
- the cell decorator.public abstract void decorate(JspContext jspContext, AbstractRenderAppender appender, CellModel cellModel) throws CellDecoratorException
jspContext
- the JspContext
for the current pageappender
- the AbstractRenderAppender
to which markup should be renderedcellModel
- the CellModel
JavaBean that contains
CellDecoratorException
- an exception thrown when an error occurs running the decorator.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |