planetj.dataengine.display
Class TableDisplayPropertyGroup

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.property.PropertyGroup
              planetj.property.DefaultPropertyGroup
                  planetj.dataengine.display.TableDisplayPropertyGroup

All Implemented Interfaces:

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

public class TableDisplayPropertyGroup

extends DefaultPropertyGroup

Insert the type's description here. Creation date: (6/20/02 11:15:38 AM)

See Also:

Serialized Form

Field Summary

static java.lang.String	CELL_PADDING Padding between the border of a table cell and the contents of a table cell
static java.lang.String	CHART
static java.lang.String	COLUMN_COUNT Number of columns to generate for vertical generated row tables.
static int	DEFAULT_COLUMN_COUNT
static boolean	DEFAULT_DELETE
static boolean	DEFAULT_DISPLAY_VERTICAL
static boolean	DEFAULT_SHOW_ON_LEFT
static boolean	DEFAULT_SHOW_ON_RIGHT
static java.lang.String	DEFAULT_TABLE_WIDTH Default table width, where 0 indicates that the width attribute will be ommited from table definitions
static boolean	DEFAULT_VALUE_EDIT_FD
static java.lang.String	DELETE Whether or not the delete button is visible
static java.lang.String	DELETE_ALL Whether or not the delete all button is visible
static java.lang.String	DELETE_ALL_TEXT Text for the delete all button
static java.lang.String	DELETE_TEXT Text for the delete button
static java.lang.String	DETAILS Whether or not the details button is visible
static java.lang.String	DETAILS_TEXT Text for the details all button
static java.lang.String	DISPLAY_UPDATE_TABLE
static java.lang.String	DISPLAY_VERTICAL Whether or not the table should be displayed vertical.
static java.lang.String	DRAW_GRID Whether or not thin grid lines are drawn between the cells in a table
static java.lang.String	EDIT Whether or not the edit button is visible
static java.lang.String	EDIT_FIELD_DESCRIPTOR Whether or not the edit field descriptor quick link on column headers is visible
static java.lang.String	EDIT_TEXT Text for the edit button
static java.lang.String	EXCEL Whether or not the excel button is visible
static java.lang.String	EXCEL_XLS Whether or not the excel file button is visible
static java.lang.String	FIELD_DESCRIPTOR_MANAGER Deprecated. Use the EDIT_FIELD_DESCRIPTOR constant instead
static java.lang.String	HEADER Whether or not to display the column header
static java.lang.String	INSERT Whether or not the insert button is visible
static java.lang.String	INSERT_TEXT Text for the insert all button
static java.lang.String	INSERTABLE Whether or not the table should allow direct inserts without viewing the details of a single row
static java.lang.String	MS_ACCESS Whether or not the ms access quick link is visible
static java.lang.String	MS_WORD Whether or not the ms word quick link is visible
static java.lang.String	MULTIPLE_DELETES Whether or not deleting multiple rows is supported
static java.lang.String	NEXT_AND_PREVIOUS Deprecated. replaced by paging
static java.lang.String	NEXT_PREV_JUSTIFY Allows users to set which side of the table the Next and Previous links appear on.
static java.lang.String	PAGING Whether or not to include paging.
static java.lang.String	PDF Whether or not the pdf quick link is visible
static java.lang.String	PRINT Whether or not the print quick link is visible
static java.lang.String	REFRESH Whether or not the refresh quick link is visible
static java.lang.String	REMOVE_ALL Whether or not the remove all button is visible
static java.lang.String	ROW_COPY Whether or not the row copy button is visible
static java.lang.String	ROW_COPY_TEXT Text for the copy button
static java.lang.String	SELECTABLE_RECORDS Whether or not the records in the Table can be selected
static java.lang.String	SELECTION_TYPE The selection type
static java.lang.String	SELECTION_TYPE_MULTIPLE Allow users to make multiple selections
static java.lang.String	SELECTION_TYPE_NONE Do not allow users to make a selection
static java.lang.String	SELECTION_TYPE_SINGLE Allow users to make a single selection only
static java.lang.String	SHOW_FUNCTIONS_ON_LEFT Temporary functionality to control showing the RowCollection functions on the left and/or the right side.
static java.lang.String	SHOW_FUNCTIONS_ON_RIGHT
static java.lang.String	SHOW_SELECTION Whether or not to show the selection buttons
static java.lang.String	SORTING Whether or not the sorting quick links are displayed in column headers
static java.lang.String	TABLE_CLASS The name of the class used to generate the table - either HTMLTable or a subclass of HTMLTable
static java.lang.String	TABLE_DISPLAY The name of the property group
static java.lang.String	TABLE_WIDTH Table width to use.
static java.lang.String	UPDATE_TABLE_TEXT Text for the table's update button.
static java.lang.String	UPDATE_TABLE_TEXT_DEFAULT
static java.lang.String	UPDATEABLE Whether or not the table should allow direct edits without viewing the details of a single row
static java.lang.String	WRAP_HEADERS Wrap column headers.
static java.lang.String	XML Whether or not the xml quick link is visible

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

TableDisplayPropertyGroup()
DisplayPropertyGroup constructor comment.

TableDisplayPropertyGroup(int initialCapacity)
DisplayPropertyGroup constructor comment.

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

Method Summary

java.util.List	getAllPropertyNames() Gets a List containing the names of all the supported properties.
int	getColumnCount() Gets the number of records to show on each row when row's are displayed vertically.
boolean	getDelete() Get whether or not to include the delete button when viewing results.
java.lang.String	getPagingJustification() Get the justification for paging.
java.util.List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
java.lang.String	getSelectionType() Gets the selection type from the table properties.
java.lang.String	getTableWidth() Gets the number of columns to show on Row details.
boolean	isDisplayEditFDLinks() Check if edit FD links are to be included when generating inputs.
boolean	isDisplayVertical() Check to see if rows in results table should be vertical.
boolean	isPagingEnabled() Check whether or not paging is turned on.
boolean	isShowFunctionsOnLeft()
boolean	isShowFunctionsOnRight()
protected short	propertyType(java.lang.String pPropertyName) Gets the type of property for a specified property name.
void	setDefaults() Sets default values for some properties
protected void	validate() Validates this property group, throwing a validation exception if there is a problem.

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, createProperty, 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, updateProperty, 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

CELL_PADDING

public static final java.lang.String CELL_PADDING

Padding between the border of a table cell and the contents of a table cell

See Also:

Constant Field Values

CHART

public static final java.lang.String CHART

See Also:

Constant Field Values

COLUMN_COUNT

public static final java.lang.String COLUMN_COUNT

Number of columns to generate for vertical generated row tables. Property only applies when display vertical is true.

See Also:

Constant Field Values

DEFAULT_COLUMN_COUNT

public static final int DEFAULT_COLUMN_COUNT

See Also:

Constant Field Values

WRAP_HEADERS

public static final java.lang.String WRAP_HEADERS

Wrap column headers.

See Also:

Constant Field Values

DELETE

public static final java.lang.String DELETE

Whether or not the delete button is visible

See Also:

Constant Field Values

DEFAULT_DELETE

public static final boolean DEFAULT_DELETE

See Also:

Constant Field Values

DELETE_TEXT

public static final java.lang.String DELETE_TEXT

Text for the delete button

See Also:

Constant Field Values

DELETE_ALL

public static final java.lang.String DELETE_ALL

Whether or not the delete all button is visible

See Also:

Constant Field Values

DELETE_ALL_TEXT

public static final java.lang.String DELETE_ALL_TEXT

Text for the delete all button

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

Whether or not the details button is visible

See Also:

Constant Field Values

DETAILS_TEXT

public static final java.lang.String DETAILS_TEXT

Text for the details all button

See Also:

Constant Field Values

DISPLAY_VERTICAL

public static final java.lang.String DISPLAY_VERTICAL

Whether or not the table should be displayed vertical. If true, colCnt determines how many records are included per row.

See Also:

Constant Field Values

DEFAULT_DISPLAY_VERTICAL

public static final boolean DEFAULT_DISPLAY_VERTICAL

See Also:

Constant Field Values

DRAW_GRID

public static final java.lang.String DRAW_GRID

Whether or not thin grid lines are drawn between the cells in a table

See Also:

Constant Field Values

EDIT

public static final java.lang.String EDIT

Whether or not the edit button is visible

See Also:

Constant Field Values

EDIT_TEXT

public static final java.lang.String EDIT_TEXT

Text for the edit button

See Also:

Constant Field Values

EDIT_FIELD_DESCRIPTOR

public static final java.lang.String EDIT_FIELD_DESCRIPTOR

Whether or not the edit field descriptor quick link on column headers is visible

See Also:

Constant Field Values

DEFAULT_VALUE_EDIT_FD

public static final boolean DEFAULT_VALUE_EDIT_FD

See Also:

Constant Field Values

EXCEL

public static final java.lang.String EXCEL

Whether or not the excel button is visible

See Also:

Constant Field Values

EXCEL_XLS

public static final java.lang.String EXCEL_XLS

Whether or not the excel file button is visible

See Also:

Constant Field Values

FIELD_DESCRIPTOR_MANAGER

public static final java.lang.String FIELD_DESCRIPTOR_MANAGER

Deprecated. Use the EDIT_FIELD_DESCRIPTOR constant instead

Whether or not the fd manager quick link is visible

See Also:

Constant Field Values

HEADER

public static final java.lang.String HEADER

Whether or not to display the column header

See Also:

Constant Field Values

INSERT

public static final java.lang.String INSERT

Whether or not the insert button is visible

See Also:

Constant Field Values

INSERT_TEXT

public static final java.lang.String INSERT_TEXT

Text for the insert all button

See Also:

Constant Field Values

MS_ACCESS

public static final java.lang.String MS_ACCESS

Whether or not the ms access quick link is visible

See Also:

Constant Field Values

MS_WORD

public static final java.lang.String MS_WORD

Whether or not the ms word quick link is visible

See Also:

Constant Field Values

MULTIPLE_DELETES

public static final java.lang.String MULTIPLE_DELETES

Whether or not deleting multiple rows is supported

See Also:

Constant Field Values

NEXT_AND_PREVIOUS

public static final java.lang.String NEXT_AND_PREVIOUS

Deprecated. replaced by paging

Whether or not the next and previous link are visible

See Also:

Constant Field Values

PAGING

public static final java.lang.String PAGING

Whether or not to include paging. Replaces old implementation by way of nextPrevious.

See Also:

Constant Field Values

PDF

public static final java.lang.String PDF

Whether or not the pdf quick link is visible

See Also:

Constant Field Values

PRINT

public static final java.lang.String PRINT

Whether or not the print quick link is visible

See Also:

Constant Field Values

REFRESH

public static final java.lang.String REFRESH

Whether or not the refresh quick link is visible

See Also:

Constant Field Values

REMOVE_ALL

public static final java.lang.String REMOVE_ALL

Whether or not the remove all button is visible

See Also:

Constant Field Values

ROW_COPY

public static final java.lang.String ROW_COPY

Whether or not the row copy button is visible

See Also:

Constant Field Values

ROW_COPY_TEXT

public static final java.lang.String ROW_COPY_TEXT

Text for the copy button

See Also:

Constant Field Values

SHOW_SELECTION

public static final java.lang.String SHOW_SELECTION

Whether or not to show the selection buttons

See Also:

Constant Field Values

SELECTABLE_RECORDS

public static final java.lang.String SELECTABLE_RECORDS

Whether or not the records in the Table can be selected

See Also:

Constant Field Values

SELECTION_TYPE

public static final java.lang.String SELECTION_TYPE

The selection type

See Also:

Constant Field Values

SELECTION_TYPE_MULTIPLE

public static final java.lang.String SELECTION_TYPE_MULTIPLE

Allow users to make multiple selections

See Also:

Constant Field Values

SELECTION_TYPE_NONE

public static final java.lang.String SELECTION_TYPE_NONE

Do not allow users to make a selection

See Also:

Constant Field Values

SELECTION_TYPE_SINGLE

public static final java.lang.String SELECTION_TYPE_SINGLE

Allow users to make a single selection only

See Also:

Constant Field Values

SORTING

public static final java.lang.String SORTING

Whether or not the sorting quick links are displayed in column headers

See Also:

Constant Field Values

TABLE_CLASS

public static final java.lang.String TABLE_CLASS

The name of the class used to generate the table - either HTMLTable or a subclass of HTMLTable

See Also:

Constant Field Values

TABLE_DISPLAY

public static final java.lang.String TABLE_DISPLAY

The name of the property group

See Also:

Constant Field Values

UPDATEABLE

public static final java.lang.String UPDATEABLE

Whether or not the table should allow direct edits without viewing the details of a single row

See Also:

Constant Field Values

DISPLAY_UPDATE_TABLE

public static final java.lang.String DISPLAY_UPDATE_TABLE

See Also:

Constant Field Values

UPDATE_TABLE_TEXT

public static final java.lang.String UPDATE_TABLE_TEXT

Text for the table's update button.

See Also:

Constant Field Values

UPDATE_TABLE_TEXT_DEFAULT

public static final java.lang.String UPDATE_TABLE_TEXT_DEFAULT

See Also:

Constant Field Values

INSERTABLE

public static final java.lang.String INSERTABLE

Whether or not the table should allow direct inserts without viewing the details of a single row

See Also:

Constant Field Values

XML

public static final java.lang.String XML

Whether or not the xml quick link is visible

See Also:

Constant Field Values

NEXT_PREV_JUSTIFY

public static final java.lang.String NEXT_PREV_JUSTIFY

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

SHOW_FUNCTIONS_ON_LEFT

public static final java.lang.String SHOW_FUNCTIONS_ON_LEFT

Temporary functionality to control showing the RowCollection functions on the left and/or the right side. By default, showOnLeft is true and showOnRight is false

See Also:

Constant Field Values

SHOW_FUNCTIONS_ON_RIGHT

public static final java.lang.String SHOW_FUNCTIONS_ON_RIGHT

See Also:

Constant Field Values

DEFAULT_SHOW_ON_LEFT

public static final boolean DEFAULT_SHOW_ON_LEFT

See Also:

Constant Field Values

DEFAULT_SHOW_ON_RIGHT

public static final boolean DEFAULT_SHOW_ON_RIGHT

See Also:

Constant Field Values

TABLE_WIDTH

public static final java.lang.String TABLE_WIDTH

Table width to use.

See Also:

Constant Field Values

DEFAULT_TABLE_WIDTH

public static final java.lang.String DEFAULT_TABLE_WIDTH

Default table width, where 0 indicates that the width attribute will be ommited from table definitions

See Also:

Constant Field Values

Constructor Detail

TableDisplayPropertyGroup

public TableDisplayPropertyGroup()

DisplayPropertyGroup constructor comment.

TableDisplayPropertyGroup

public TableDisplayPropertyGroup(int initialCapacity)

DisplayPropertyGroup constructor comment.

Parameters:

initialCapacity - int

TableDisplayPropertyGroup

public TableDisplayPropertyGroup(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 DefaultPropertyGroup

getRequiredPropertyNames

public java.util.List getRequiredPropertyNames()

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

Overrides:

getRequiredPropertyNames in class DefaultPropertyGroup

getSelectionType

public java.lang.String getSelectionType()

Gets the selection type from the table properties. !!A KGetting (10/31/2005) - Add convenience method for retrieving selection type.

isDisplayEditFDLinks

public boolean isDisplayEditFDLinks()

Check if edit FD links are to be included when generating inputs.

isDisplayVertical

public boolean isDisplayVertical()

Check to see if rows in results table should be vertical.

propertyType

protected short propertyType(java.lang.String pPropertyName)

Gets the type of property for a specified property name.

Overrides:

propertyType in class DefaultPropertyGroup

setDefaults

public void setDefaults()

Sets default values for some properties

validate

protected void validate()
                 throws ValidationException

Description copied from class: PropertyGroup

Validates this property group, throwing a validation exception if there is a problem. Subclasses may override this method as long as they invoke the superclass method

Overrides:

validate in class PropertyGroup

Throws:

ValidationException

getColumnCount

public int getColumnCount()

Gets the number of records to show on each row when row's are displayed vertically.

getDelete

public boolean getDelete()

Get whether or not to include the delete button when viewing results.

getPagingJustification

public java.lang.String getPagingJustification()

Get the justification for paging.

isPagingEnabled

public boolean isPagingEnabled()

Check whether or not paging is turned on.

isShowFunctionsOnLeft

public boolean isShowFunctionsOnLeft()

isShowFunctionsOnRight

public boolean isShowFunctionsOnRight()

getTableWidth

public java.lang.String getTableWidth()

Gets the number of columns to show on Row details. !!KGetting (12/05/2005) - Added table width support