org.apache.beehive.netui.tags.databinding.datagrid
Class DataGrid

Object
  extended by SimpleTagSupport
      extended by AbstractSimpleTag
          extended by DataGrid
All Implemented Interfaces:
JspTag, SimpleTag, IDataAccessProvider, IBehaviorConsumer, INetuiTag

public class DataGrid
extends AbstractSimpleTag
implements IDataAccessProvider, IBehaviorConsumer


Constructor Summary
DataGrid()
           
 
Method Summary
 void doTag()
           
 int getCurrentIndex()
          Get the current index in this iteration.
 Object getCurrentItem()
          Get the current data item in this IDataAccessProvider.
 Object getCurrentMetadata()
          Get a metadata object for the current item.
 String getDataSource()
          Get the expression that references the data item to which the IDataAccessProvider is bound.
 IDataAccessProvider getProviderParent()
          Get the parent IDataAccessProvider of a DataAccessProvider.
 String getTagName()
          Return the name of the tag.
 void setBehavior(String name, String value, String facet)
          Set a behavior value on the implementing class.
 void setDataGridConfig(DataGridConfig dataGridConfig)
           
 void setDataSource(String dataSource)
           
 void setName(String name)
           
 void setRenderRowGroups(boolean renderRowGroups)
           
 void setResourceBundlePath(String resourceBundlePath)
           
 void setStyleClassPolicy(String stylePolicy)
           
 void setStyleClassPrefix(String styleClassPrefix)
           
 
Methods inherited from class AbstractSimpleTag
getBufferBody, getHtmlTag, getIdForTagId, getInlineError, getPageContext, getScriptReporter, getUserLocale, hasErrors, registerTagError, registerTagError, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write
 
Methods inherited from class SimpleTagSupport
findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataGrid

public DataGrid()
Method Detail

getTagName

public String getTagName()
Description copied from class: AbstractSimpleTag
Return the name of the tag. Used by error reporting to get the name of the tag.

Specified by:
getTagName in interface INetuiTag
Specified by:
getTagName in class AbstractSimpleTag
Returns:
the name of the tag.

setDataGridConfig

public void setDataGridConfig(DataGridConfig dataGridConfig)

setName

public void setName(String name)

setDataSource

public void setDataSource(String dataSource)

setStyleClassPrefix

public void setStyleClassPrefix(String styleClassPrefix)

setResourceBundlePath

public void setResourceBundlePath(String resourceBundlePath)

setStyleClassPolicy

public void setStyleClassPolicy(String stylePolicy)

setRenderRowGroups

public void setRenderRowGroups(boolean renderRowGroups)

setBehavior

public void setBehavior(String name,
                        String value,
                        String facet)
                 throws JspException
Description copied from interface: IBehaviorConsumer
Set a behavior value on the implementing class. The name represents the name of the behavior. The value represents the value. The facet is optional and may be used by complex types to target the behavior.

Specified by:
setBehavior in interface IBehaviorConsumer
Parameters:
name -
value -
facet -
Throws:
JspException

doTag

public void doTag()
           throws JspException,
                  IOException
Specified by:
doTag in interface SimpleTag
Overrides:
doTag in class SimpleTagSupport
Throws:
JspException
IOException

getCurrentIndex

public int getCurrentIndex()
Description copied from interface: IDataAccessProvider
Get the current index in this iteration. This should be a zero based integer that increments after each iteration.

Specified by:
getCurrentIndex in interface IDataAccessProvider
Returns:
the current index of iteration or 0

getCurrentItem

public Object getCurrentItem()
Description copied from interface: IDataAccessProvider
Get the current data item in this IDataAccessProvider.

Specified by:
getCurrentItem in interface IDataAccessProvider
Returns:
the current data item or null

getCurrentMetadata

public Object getCurrentMetadata()
Description copied from interface: IDataAccessProvider
Get a metadata object for the current item. This interface is optional, and implementations of this interface are provided by the IDataAccessProvider interface. See these implementations for information about their support for current item metadata.

Specified by:
getCurrentMetadata in interface IDataAccessProvider
Returns:
the current metadata or null if no metadata can be found or metadata is not supported by a IDataAccessProvider implementation

getDataSource

public String getDataSource()
Description copied from interface: IDataAccessProvider
Get the expression that references the data item to which the IDataAccessProvider is bound.

Specified by:
getDataSource in interface IDataAccessProvider
Returns:
the expression referencing the data source or null if no dataSource is set

getProviderParent

public IDataAccessProvider getProviderParent()
Description copied from interface: IDataAccessProvider
Get the parent IDataAccessProvider of a DataAccessProvider. A DataAccessProvider implementation may be able to nest DataAccessProviders. In this case, it can be useful to be able to also nest access to data from parent providers. Implementations of this interface are left with having to discover and export parents. The return value from this call on an implementing Object can be null.

Specified by:
getProviderParent in interface IDataAccessProvider
Returns:
the parent DataAccessProvider or null if this method is not supported or the parent can not be found.