org.apache.beehive.netui.databinding.datagrid.runtime.config
Class DefaultDataGridConfig

Object
  extended by DataGridConfig
      extended by DefaultDataGridConfig
All Implemented Interfaces:
Serializable

public class DefaultDataGridConfig
extends DataGridConfig

Default implementation of the DataGridConfig base class. This class is used to provide concrete implementations of state containers and service providers for the data grid.

See Also:
Serialized Form

Constructor Summary
DefaultDataGridConfig()
           
 
Method Summary
 DataGridState createDataGridState()
          Create a DataGridState object.
 Filter createFilter()
          Create a Filter object.
 FilterModel createFilterModel(List filters)
          Create a FilterModel object.
 PagerModel createPagerModel()
          Create a PagerModel object.
 Sort createSort()
          Create a Sort object.
 SortModel createSortModel(List sorts)
          Create a SortModel object.
 DataGridStateCodec createStateCodec(ServletRequest request, String gridName)
          Create a DataGridStateCodec for a grid with the given name for the given ServletRequest.
 PagerRenderer getDefaultPagerRenderer()
          Get the default PagerRenderer.
 DataGridResourceProvider getDefaultResourceProvider()
          Get a DataGridResourceProvider.
 DataGridResourceProvider getResourceProvider(String resourceBundle)
          Get a DataGridResourceProvider for the given resource bundle path.
 StyleModel getStyleModel(String name, String classPrefix)
          Get a StyleModel given a model name and a style class prefix.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultDataGridConfig

public DefaultDataGridConfig()
Method Detail

createDataGridState

public DataGridState createDataGridState()
Create a DataGridState object. The default implementation returned is DataGridState.

Specified by:
createDataGridState in class DataGridConfig
Returns:
a data grid state implementation

createSort

public Sort createSort()
Create a Sort object. The default implementation returned is Sort.

Specified by:
createSort in class DataGridConfig
Returns:
a sort

createFilter

public Filter createFilter()
Create a Filter object. The default implementation returned is Filter.

Specified by:
createFilter in class DataGridConfig
Returns:
a filter

createSortModel

public SortModel createSortModel(List sorts)
Create a SortModel object. The default implementation returned is SortModel with a SortStrategy of DefaultSortStrategy.

Specified by:
createSortModel in class DataGridConfig
Parameters:
sorts - the list of sorts for a data grid
Returns:
a sort model

createFilterModel

public FilterModel createFilterModel(List filters)
Create a FilterModel object. The default implementation returned is FilterModel.

Specified by:
createFilterModel in class DataGridConfig
Parameters:
filters - the list of filters for a data grid
Returns:
a filter model

createPagerModel

public PagerModel createPagerModel()
Create a PagerModel object. The default implementation returned is PagerModel.

Specified by:
createPagerModel in class DataGridConfig
Returns:
a pager model

createStateCodec

public DataGridStateCodec createStateCodec(ServletRequest request,
                                           String gridName)
Create a DataGridStateCodec for a grid with the given name for the given ServletRequest.

Specified by:
createStateCodec in class DataGridConfig
Parameters:
request - the current request
gridName - a data grid's name
Returns:
the state encoder / decoder for a data grid's request state

getDefaultPagerRenderer

public PagerRenderer getDefaultPagerRenderer()
Get the default PagerRenderer. The default pager renderer will display a pager with previous / next page links via the implementation class PreviousNextPagerRenderer.

Specified by:
getDefaultPagerRenderer in class DataGridConfig
Returns:
the pager renderer

getDefaultResourceProvider

public DataGridResourceProvider getDefaultResourceProvider()
Get a DataGridResourceProvider. The default implementation class is DefaultDataGridResourceProvider and provides a basic implementation that reads messages from the default .properties file.

Specified by:
getDefaultResourceProvider in class DataGridConfig
Returns:
the resource provider

getResourceProvider

public DataGridResourceProvider getResourceProvider(String resourceBundle)
Get a DataGridResourceProvider for the given resource bundle path. The default implementation will set this resource bundle but does not enable message chaining.

Specified by:
getResourceProvider in class DataGridConfig
Parameters:
resourceBundle - a resource bundle specifically requested by a data grid
Returns:
the resource provider

getStyleModel

public StyleModel getStyleModel(String name,
                                String classPrefix)
Get a StyleModel given a model name and a style class prefix. This class exposes two available style names:
NameDescriptionImplementation Class
empty Renders CSS style classes that are non-prefixed and generally empty. EmptyStyleModel
default Renders CSS style classes with names using a default prefix of datagrid DefaultStyleModel
When using the empty style model, styles rendered on the <table> element will be empty; the same style rendered wtih the default style model will render as class="datagrid". If the style prefix "foo" is provided for the default style policy the style name will be rendered as class="foo".x

Specified by:
getStyleModel in class DataGridConfig
Parameters:
name - the name of a StyleModel implementation to use
classPrefix - the prefix for a style name
Returns:
the style model