org.alphadisplaytag.properties
Class AlphaTableProperties

java.lang.Object
  org.alphadisplaytag.properties.AlphaTableProperties

public final class AlphaTableProperties

extends java.lang.Object

The properties such as css style and default values used by the AlphaTable tags navigation are defined in this class. The properties are first read from the AlphaTableTag.properties file for flexible configuration.

Version:

$Revision: 1.0 $ ($Author: pchauvet $)

Author:

Philip Jahmani Chauvet

Field Summary

static java.lang.String	DEFAULT_FILENAME Name of the default properties file name ("AlphaTableTag.properties").
static java.lang.String	LOCAL_PROPERTIES The name of the local properties file that is searched for on the classpath.
static java.lang.String	PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS Full navigation default style calss.
static java.lang.String	PROPERTY_ALPHANAVIGATE_DEFAULT_STYLE Full navigation default style.
static java.lang.String	PROPERTY_ALPHANAVIGATE_FORMAT Full navigation bar format.
static java.lang.String	PROPERTY_ALPHANAVIGATE_HREF_FULLNOTSELECTED Default value for Full Href not selected.
static java.lang.String	PROPERTY_ALPHANAVIGATE_HREF_FULLSELECTED Default value for Full Href selected.
static java.lang.String	PROPERTY_ALPHANAVIGATE_HREF_NOTSELECTED Default value for each alphabetic Href when not selected.
static java.lang.String	PROPERTY_ALPHANAVIGATE_HREF_SELECTED Default value for each alphabetic Href when selected.
static java.lang.String	PROPERTY_CLASS_REQUESTHELPERFACTORY Property factory.requestHelper.

Method Summary

java.lang.String	getAlphaNavigateClass() Getter for the PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS property.
java.lang.String	getAlphaNavigateFormat() Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.
java.lang.String	getAlphaNavigateHrefFullSelected() Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.
java.lang.String	getAlphaNavigateHrefNotFullSelected() Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.
java.lang.String	getAlphaNavigateHrefNotSelected() Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.
java.lang.String	getAlphaNavigateHrefSelected() Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.
java.lang.String	getAlphaNavigateStyle() Getter for the PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS property.
static AlphaTableProperties	getInstance() returns a new AlphaTableProperties instance.
java.lang.String	getProperty(java.lang.String key) Reads a String property.
RequestHelperFactory	getRequestHelperFactoryInstance() Returns an instance of configured requestHelperFactory.
static java.util.Properties	getUserProperties() Local and non-default properties these settings override the defaults from displaytag.properties and TableTag.properties.
void	setProperty(java.lang.String key, java.lang.String value) Sets a property.
static void	setUserProperties(java.util.Properties overrideProperties) Local and non-default properties these settings override the defaults from displaytag.properties and TableTag.properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FILENAME

public static final java.lang.String DEFAULT_FILENAME

Name of the default properties file name ("AlphaTableTag.properties").

See Also:

Constant Field Values

LOCAL_PROPERTIES

public static final java.lang.String LOCAL_PROPERTIES

The name of the local properties file that is searched for on the classpath. Settings in this file will override the defaults loaded from TableTag.properties.

See Also:

Constant Field Values

PROPERTY_CLASS_REQUESTHELPERFACTORY

public static final java.lang.String PROPERTY_CLASS_REQUESTHELPERFACTORY

Property factory.requestHelper.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_HREF_SELECTED

public static final java.lang.String PROPERTY_ALPHANAVIGATE_HREF_SELECTED

Default value for each alphabetic Href when selected.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_HREF_NOTSELECTED

public static final java.lang.String PROPERTY_ALPHANAVIGATE_HREF_NOTSELECTED

Default value for each alphabetic Href when not selected.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_HREF_FULLSELECTED

public static final java.lang.String PROPERTY_ALPHANAVIGATE_HREF_FULLSELECTED

Default value for Full Href selected.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_HREF_FULLNOTSELECTED

public static final java.lang.String PROPERTY_ALPHANAVIGATE_HREF_FULLNOTSELECTED

Default value for Full Href not selected.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS

public static final java.lang.String PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS

Full navigation default style calss.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_DEFAULT_STYLE

public static final java.lang.String PROPERTY_ALPHANAVIGATE_DEFAULT_STYLE

Full navigation default style.

See Also:

Constant Field Values

PROPERTY_ALPHANAVIGATE_FORMAT

public static final java.lang.String PROPERTY_ALPHANAVIGATE_FORMAT

Full navigation bar format.

See Also:

Constant Field Values

Method Detail

getInstance

public static AlphaTableProperties getInstance()

returns a new AlphaTableProperties instance.

Returns:

AlphaTableProperties instance

getUserProperties

public static java.util.Properties getUserProperties()

Local and non-default properties these settings override the defaults from displaytag.properties and TableTag.properties.

Returns:

the Properties that was set

setUserProperties

public static void setUserProperties(java.util.Properties overrideProperties)

Local and non-default properties these settings override the defaults from displaytag.properties and TableTag.properties. Please note that the values are copied in, so that multiple calls with non-overlapping properties will be merged, not overwritten.

Parameters:

overrideProperties - - The local, non-default properties

getRequestHelperFactoryInstance

public RequestHelperFactory getRequestHelperFactoryInstance()

Returns an instance of configured requestHelperFactory.

Returns:

RequestHelperFactory instance.

getProperty

public java.lang.String getProperty(java.lang.String key)

Reads a String property.

Parameters:

key - property name

Returns:

property value or null if property is not found

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Sets a property.

Parameters:

key - property name

value - property value

getAlphaNavigateFormat

public java.lang.String getAlphaNavigateFormat()

Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.

Returns:

String

getAlphaNavigateHrefSelected

public java.lang.String getAlphaNavigateHrefSelected()

Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.

Returns:

String

getAlphaNavigateHrefNotSelected

public java.lang.String getAlphaNavigateHrefNotSelected()

Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.

Returns:

String

getAlphaNavigateHrefFullSelected

public java.lang.String getAlphaNavigateHrefFullSelected()

Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.

Returns:

String

getAlphaNavigateHrefNotFullSelected

public java.lang.String getAlphaNavigateHrefNotFullSelected()

Getter for the PROPERTY_STRING_PAGING_BANNER_FIRST property.

Returns:

String

getAlphaNavigateClass

public java.lang.String getAlphaNavigateClass()

Getter for the PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS property.

Returns:

String

getAlphaNavigateStyle

public java.lang.String getAlphaNavigateStyle()

Getter for the PROPERTY_ALPHANAVIGATE_DEFAULT_CLASS property.

Returns:

String