planetj.dataengine.action.paging
Class PagingPropertyGroup

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.property.PropertyGroup
              planetj.property.DefaultPropertyGroup
                  planetj.dataengine.action.ActionDescriptor
                      planetj.dataengine.action.paging.PagingPropertyGroup

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.util.Map, java.io.Serializable

public class PagingPropertyGroup

extends ActionDescriptor

A PagingPropertyGroup contains properties that are used to determine the type of paging that is rendered on a results table.

See Also:

Serialized Form

Field Summary

static boolean	DEFAULT_ENABLED
static boolean	DEFAULT_FIRST_AND_LAST
static java.lang.String	DEFAULT_JUSTIFICATION
static boolean	DEFAULT_NEXT_AND_PREVIOUS
static boolean	DEFAULT_PAGE_NUMBERS
static java.lang.String	DEFAULT_PAGING_DISPLAY_TYPE
static java.lang.String	DEFAULT_PAGING_LOCATION
static java.util.List	DEFAULT_PAGING_LOCATION_LIST
static java.lang.String	DEFAULT_STRING Default Paging property group string
static java.lang.String	DEFAULT_TEXT The default text to display
static java.lang.String	ENABLED Whether or not to include paging.
static java.lang.String	JUSTIFICATION Allows users to set which side of the table the Next and Previous links appear on.
static java.lang.String	JUSTIFY_LEFT
static java.lang.String	JUSTIFY_RIGHT
static java.lang.String	PAGE_COUNT_TO_SHOW Holds the number or page numbers to show.
static java.lang.String	PAGING The name of the property group.
static java.lang.String	PLACEHOLDER_CURRENT_PAGE Placeholder for the current page being displayed
static java.lang.String	PLACEHOLDER_FIRST_ROW Placeholder for the number of the first row which is being displayed
static java.lang.String	PLACEHOLDER_LAST_ROW Placeholder for the number of the last row which is being displayed
static java.lang.String	PLACEHOLDER_TOTAL_PAGES Placeholder for the total number of pages available for display
static java.lang.String	PLACEHOLDER_TOTAL_ROWS Placeholder for the total number of rows available for display
static java.lang.String	SHOW_FIRST_AND_LAST Whether or not to show the next link, icon, or button.
static java.lang.String	SHOW_NEXT_AND_PREVIOUS Whether or not to show the next link, icon, or button.
static java.lang.String	SHOW_PAGE_NUMBERS Whether or not to page numbers.
static java.lang.String	TEXT What text to display.
static java.lang.String	USE_TEXT Whether or not to show what records are being looked at.

Fields inherited from class planetj.dataengine.action.ActionDescriptor

ACTION_DISPLAY_DESCRIPTOR, ACTION_NAME, ACTION_TYPE, ALL_ACTION_DESCRIPTOR_PROPERTIES, className, DESCRIPTION, DETAILS_LOCATION, DETAILS_MODE, DETAILS_MODE_COPY, DETAILS_MODE_DELETE, DETAILS_MODE_EDIT, DETAILS_MODE_INSERT, DETAILS_MODE_VIEW, DISPLAY_TYPE, DISPLAY_TYPE_BUTTON, DISPLAY_TYPE_CHECKBOX, DISPLAY_TYPE_LINK, IMAGE_SRC, LABEL, LOCATION, LOCATION_BOTTOM_LEFT, LOCATION_BOTTOM_RIGHT, LOCATION_BUTTONS_FAR_LEFT, LOCATION_BUTTONS_FAR_RIGHT, LOCATION_BUTTONS_LEFT, LOCATION_BUTTONS_RIGHT, LOCATION_HEADER, LOCATION_INLINE, LOCATION_NONE, LOCATION_PARAMETER_SEARCH_LEFT, LOCATION_PARAMETER_SEARCH_RIGHT, LOCATION_TOOLBAR, LOCATION_TOP_LEFT, LOCATION_TOP_RIGHT, LOCATION_UNKNOWN, NAVIGATION_GROUP_END, NAVIGATION_GROUP_START, NEW_WINDOW_PROPERTIES, NO_SELECTION_ERROR, TARGET

Fields inherited from class planetj.property.PropertyGroup

ALL, ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, FLOAT_PROPERTY, INTEGER_PROPERTY, JAVA_CLASS_PROPERTY, LIST_PROPERTY, MAP_PROPERTY, NONE, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

PagingPropertyGroup()
DisplayPropertyGroup constructor comment.

PagingPropertyGroup(int initialCapacity)
DisplayPropertyGroup constructor comment.

PagingPropertyGroup(java.lang.String pName)
DisplayPropertyGroup constructor comment.

Method Summary

java.util.List	getAllPropertyNames() Gets a List containing the names of all the supported properties.
java.lang.String	getDisplayType() Get the display type to generate for action.
java.lang.String	getJustification() Get the justification for paging.
java.lang.String	getLocation() Deprecated.
java.util.List	getLocations() Gets the location where the paging links are displayed
int	getPageCountToShow() Gets the number of page numbers to show.
java.util.List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
java.lang.String	getText() Gets the paging text to display (before the placeholders are replaced)
java.lang.String	getText(int firstRow, int lastRow, int totalRows, int currentPage, int totalPages) Gets the paging text to display (after the placeholders are replaced)
boolean	isEnabled() Check whether or not paging is turned on.
boolean	isFirstAndLastEnabled() Check whether or not first and last should be shown
boolean	isNextAndPreviousEnabled() Check whether or not next and previous should be shown
boolean	isPageNumbersEnabled() Check whether or not page numbers should be shown
boolean	isUseText() Checks if the text should be displayed.
protected short	propertyType(java.lang.String propName) Gets the type of property for a specified property name.
protected java.lang.String	replaceAll(java.lang.String val, java.lang.String placeholder, int num) Replaces all occurences of the the placeholder in the String with the int value

Methods inherited from class planetj.dataengine.action.ActionDescriptor

createDescriptor, createProperty, getActionName, getActionType, getDescription, getDetailsLocations, getDetailsModes, getImageSource, getLabel, getLayoutPropertyNames, getNewWindowProperties, getNoSelectionErrorMessage, getTarget, hasNavigationEnd, hasNavigationStart, isNavigationEnd, isNavigationStart, setActionName, setActionType, setDisplayType, setEndNavigationGroup, setImageSource, setLabel, setLocation, setStartNavigationGroup, setTarget, updateProperty, validate

Methods inherited from class planetj.property.DefaultPropertyGroup

getDefaultPropertiesString

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, copyUndefinedPropertiesFrom, createValue, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateFormat, getDateValue, getDoubleValue, getFloatValue, getIntValue, getJavaClassValue, getListValue, getMapValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, metapropertyType, put, put, put, setName, toString, validateMetadata, validateMetadataBoolean

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

PAGING

public static final java.lang.String PAGING

The name of the property group.

See Also:

Constant Field Values

ENABLED

public static final java.lang.String ENABLED

Whether or not to include paging. (if specified, overrides "paging" property of TableDisplayPropertyGroup)

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

JUSTIFICATION

public static final java.lang.String JUSTIFICATION

Allows users to set which side of the table the Next and Previous links appear on. Left or Right Justified Possible Values: left, right

See Also:

Constant Field Values

JUSTIFY_LEFT

public static final java.lang.String JUSTIFY_LEFT

See Also:

Constant Field Values

JUSTIFY_RIGHT

public static final java.lang.String JUSTIFY_RIGHT

See Also:

Constant Field Values

DEFAULT_JUSTIFICATION

public static final java.lang.String DEFAULT_JUSTIFICATION

See Also:

Constant Field Values

PAGE_COUNT_TO_SHOW

public static final java.lang.String PAGE_COUNT_TO_SHOW

Holds the number or page numbers to show.

See Also:

Constant Field Values

SHOW_FIRST_AND_LAST

public static final java.lang.String SHOW_FIRST_AND_LAST

Whether or not to show the next link, icon, or button.

See Also:

Constant Field Values

DEFAULT_FIRST_AND_LAST

public static final boolean DEFAULT_FIRST_AND_LAST

See Also:

Constant Field Values

SHOW_NEXT_AND_PREVIOUS

public static final java.lang.String SHOW_NEXT_AND_PREVIOUS

Whether or not to show the next link, icon, or button.

See Also:

Constant Field Values

DEFAULT_NEXT_AND_PREVIOUS

public static final boolean DEFAULT_NEXT_AND_PREVIOUS

See Also:

Constant Field Values

SHOW_PAGE_NUMBERS

public static final java.lang.String SHOW_PAGE_NUMBERS

Whether or not to page numbers.

See Also:

Constant Field Values

DEFAULT_PAGE_NUMBERS

public static final boolean DEFAULT_PAGE_NUMBERS

See Also:

Constant Field Values

USE_TEXT

public static final java.lang.String USE_TEXT

Whether or not to show what records are being looked at. 1 - 10 of 55.

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

What text to display. The text may contain one or more of the placeholders defined below, which will be replaced by actual values when the screen is displayed

See Also:

Constant Field Values

PLACEHOLDER_FIRST_ROW

public static final java.lang.String PLACEHOLDER_FIRST_ROW

Placeholder for the number of the first row which is being displayed

See Also:

Constant Field Values

PLACEHOLDER_LAST_ROW

public static final java.lang.String PLACEHOLDER_LAST_ROW

Placeholder for the number of the last row which is being displayed

See Also:

Constant Field Values

PLACEHOLDER_TOTAL_ROWS

public static final java.lang.String PLACEHOLDER_TOTAL_ROWS

Placeholder for the total number of rows available for display

See Also:

Constant Field Values

PLACEHOLDER_CURRENT_PAGE

public static final java.lang.String PLACEHOLDER_CURRENT_PAGE

Placeholder for the current page being displayed

See Also:

Constant Field Values

PLACEHOLDER_TOTAL_PAGES

public static final java.lang.String PLACEHOLDER_TOTAL_PAGES

Placeholder for the total number of pages available for display

See Also:

Constant Field Values

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

The default text to display

See Also:

Constant Field Values

DEFAULT_PAGING_LOCATION

public static final java.lang.String DEFAULT_PAGING_LOCATION

See Also:

Constant Field Values

DEFAULT_PAGING_LOCATION_LIST

public static final java.util.List DEFAULT_PAGING_LOCATION_LIST

DEFAULT_PAGING_DISPLAY_TYPE

public static final java.lang.String DEFAULT_PAGING_DISPLAY_TYPE

See Also:

Constant Field Values

DEFAULT_STRING

public static final java.lang.String DEFAULT_STRING

Default Paging property group string

See Also:

Constant Field Values

Constructor Detail

PagingPropertyGroup

public PagingPropertyGroup()

DisplayPropertyGroup constructor comment.

PagingPropertyGroup

public PagingPropertyGroup(int initialCapacity)

DisplayPropertyGroup constructor comment.

Parameters:

initialCapacity - int

PagingPropertyGroup

public PagingPropertyGroup(java.lang.String pName)

DisplayPropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public java.util.List getAllPropertyNames()

Gets a List containing the names of all the supported properties.

Overrides:

getAllPropertyNames in class ActionDescriptor

getDisplayType

public java.lang.String getDisplayType()

Description copied from class: ActionDescriptor

Get the display type to generate for action. (e.g. button, link, etc...)

Overrides:

getDisplayType in class ActionDescriptor

getJustification

public java.lang.String getJustification()

Get the justification for paging.

getLocation

public java.lang.String getLocation()

Deprecated.

Gets the location where the paging links are displayed

Overrides:

getLocation in class ActionDescriptor

getLocations

public java.util.List getLocations()

Gets the location where the paging links are displayed

Overrides:

getLocations in class ActionDescriptor

getPageCountToShow

public int getPageCountToShow()

Gets the number of page numbers to show. A negative number means all pages

getRequiredPropertyNames

public java.util.List getRequiredPropertyNames()

Gets a List containing the names of all the required properties.

Overrides:

getRequiredPropertyNames in class DefaultPropertyGroup

getText

public java.lang.String getText()

Gets the paging text to display (before the placeholders are replaced)

getText

public java.lang.String getText(int firstRow,
                                int lastRow,
                                int totalRows,
                                int currentPage,
                                int totalPages)

Gets the paging text to display (after the placeholders are replaced)

propertyType

protected short propertyType(java.lang.String propName)

Description copied from class: ActionDescriptor

Gets the type of property for a specified property name.

Overrides:

propertyType in class ActionDescriptor

replaceAll

protected java.lang.String replaceAll(java.lang.String val,
                                      java.lang.String placeholder,
                                      int num)

Replaces all occurences of the the placeholder in the String with the int value

isEnabled

public boolean isEnabled()

Check whether or not paging is turned on.

isFirstAndLastEnabled

public boolean isFirstAndLastEnabled()

Check whether or not first and last should be shown

isNextAndPreviousEnabled

public boolean isNextAndPreviousEnabled()

Check whether or not next and previous should be shown

isPageNumbersEnabled

public boolean isPageNumbersEnabled()

Check whether or not page numbers should be shown

isUseText

public boolean isUseText()

Checks if the text should be displayed. The default is false, unless the user has supplied a text string