planetj.dataengine.display
Class DetailDisplayPropertyGroup

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--planetj.property.PropertyGroup
                    |
                    +--planetj.property.DefaultPropertyGroup
                          |
                          +--planetj.dataengine.display.DetailDisplayPropertyGroup

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

public class DetailDisplayPropertyGroup

extends DefaultPropertyGroup

Author:

PlanetJ Corp.

See Also:

Serialized Form

Nested Class Summary

class

DetailDisplayPropertyGroup.TargetWindow Object representing the target window.

Field Summary

static String	BUTTON_JUSTIFY Justification for detail buttons
static String	BUTTON_LOCATION_BOTTOM
static String	BUTTON_LOCATION_TOP
static String	BUTTON_LOCATIONS Where to include the buttons (note by default buttons are included both above and below details).
static String	COLUMN_COUNT Number of columns to display when showing Row details.
static String	COPY_TARGET_WINDOW Which HTML window should be used for displaying a copy screen
static String	COPY_URI Page to call for copy details.
static String	DEFAULT_BUTTON_JUSTIFY
static List	DEFAULT_BUTTON_LOCATIONS
static int	DEFAULT_COLUMN_COUNT Default number of columns to display.
static boolean	DEFAULT_DELETE
static boolean	DEFAULT_INSERT Default whether to allow inserts on details screen
static boolean	DEFAULT_INSERT_AND_COPY Default insert and copy
static boolean	DEFAULT_INSERT_AND_NEW Default insert and new
static String	DEFAULT_LABEL_JUSTIFY
static int	DEFAULT_MAX_INPUT_WIDTH Default max input width.
static int	DEFAULT_MAX_INPUT_WIDTH_SUM Default max sum of input widths on a given row.
static boolean	DEFAULT_NEXT_AND_PREVIOUS Default insert and new
static String	DELETE Allow delete on details screen
static String	DETAILS_DISPLAY Name of this property group
static String	DETAILS_TARGET_WINDOW Which HTML window should be used for displaying the detials
static String	EDIT_TARGET_WINDOW Which HTML window should be used for displaying an edit screen
static String	EDIT_URI Page to call for edit details.
static String	GRID Diplay grid
static String	INCLUDE_COLON_AFTER_LABEL Include colon ':' after labels
static String	INSERT Allow inserts on details screen
static String	INSERT_AND_COPY Display the insert and copy button
static String	INSERT_AND_NEW Display the insert and new
static String	INSERT_TARGET_WINDOW Which HTML window should be used for displaying an insert screen
static String	INSERT_URI Page to call for insert details.
static String	LABEL_JUSTIFY Label justification.
static String	LABEL_JUSTIFY_LEFT
static String	LABEL_JUSTIFY_TOP
static String	MAX_INPUT_WIDTH Maximum width of an input field on the screen.
static String	MAX_INPUT_WIDTH_SUM Maximum sum of the width of all input fields on a row.
static String	NEXT_AND_PREVIOUS Display the next & previouis buttons on updates & views
static String	PRINT_URI Page to call for printer-friendly view.
static short	TARGET_WINDOW_PROPERTY
static String	VIEW_TARGET_WINDOW Which HTML window should be used for displaying the detials
static String	VIEW_URI Page to call for view details.

Fields inherited from class planetj.property.DefaultPropertyGroup

NONE

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

DetailDisplayPropertyGroup()
DisplayPropertyGroup constructor comment.

DetailDisplayPropertyGroup(int initialCapacity)
DisplayPropertyGroup constructor comment.

DetailDisplayPropertyGroup(String pName)
DisplayPropertyGroup constructor comment.

Method Summary

List	getAllPropertyNames() Gets a List containing the names of all the supported properties.
String	getButtonJustify() Gets the justification of the buttons
List	getButtonLocations() Gets the justification of the Fields label.
int	getColumnCount() Gets the number of columns to show on Row details.
DetailDisplayPropertyGroup.TargetWindow	getCopyTargetWindow() Gets the TargetWindow object representing the target window to display the copy screen in.
static String	getDefaultLayoutPropertiesString() Gets a default String for this property group.
boolean	getDelete() Get whether or not to include the delete button when viewing details.
DetailDisplayPropertyGroup.TargetWindow	getEditTargetWindow() Gets the TargetWindow object representing the target window to display the edit screen in.
boolean	getInsert() Get whether or not to include the insert button when viewing details.
boolean	getInsertAndCopy() Gets the number of columns to show on Row details.
boolean	getInsertAndNew() Gets the number of columns to show on Row details.
DetailDisplayPropertyGroup.TargetWindow	getInsertTargetWindow() Gets the TargetWindow object representing the target window to display the edit screen in.
String	getLabelJustify() Gets the justification of the Fields label.
int	getMaxInputWidth() Gets the max sum of all input widths for a given Row on details.
int	getMaxInputWidthSum() Gets the max sum of all input widths for a given Row on details.
boolean	getNextAndPrevious() Gets wheter to show previous and next buttons on view and updates.
DetailDisplayPropertyGroup.TargetWindow	getViewTargetWindow() Gets the TargetWindow object representing the target window to display the edit screen in.
boolean	isDisplayGrid() Check to see if a grid should be included.
boolean	isIncludeColonAfterLabel() Check to see if colon should be included after the Field's label.
boolean	isLabelLeftJustify() Check to see if label should be to the left of the Field.
boolean	isLabelTopJustify() Check to see if label should be to the top of the Field.
boolean	isShowButtons(String location) Check to see if detail buttons should be shown for the given location.

Methods inherited from class planetj.property.DefaultPropertyGroup

getDefaultPropertiesString, getRequiredPropertyNames

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

COLUMN_COUNT

public static final String COLUMN_COUNT

Number of columns to display when showing Row details.

See Also:

Constant Field Values

DEFAULT_COLUMN_COUNT

public static final int DEFAULT_COLUMN_COUNT

Default number of columns to display.

See Also:

Constant Field Values

MAX_INPUT_WIDTH

public static final String MAX_INPUT_WIDTH

Maximum width of an input field on the screen.

See Also:

Constant Field Values

DEFAULT_MAX_INPUT_WIDTH

public static final int DEFAULT_MAX_INPUT_WIDTH

Default max input width.

See Also:

Constant Field Values

MAX_INPUT_WIDTH_SUM

public static final String MAX_INPUT_WIDTH_SUM

Maximum sum of the width of all input fields on a row.

See Also:

Constant Field Values

DEFAULT_MAX_INPUT_WIDTH_SUM

public static final int DEFAULT_MAX_INPUT_WIDTH_SUM

Default max sum of input widths on a given row.

See Also:

Constant Field Values

COPY_URI

public static final String COPY_URI

Page to call for copy details.

See Also:

Constant Field Values

EDIT_URI

public static final String EDIT_URI

Page to call for edit details.

See Also:

Constant Field Values

INSERT_URI

public static final String INSERT_URI

Page to call for insert details.

See Also:

Constant Field Values

VIEW_URI

public static final String VIEW_URI

Page to call for view details.

See Also:

Constant Field Values

PRINT_URI

public static final String PRINT_URI

Page to call for printer-friendly view.

See Also:

Constant Field Values

BUTTON_JUSTIFY

public static final String BUTTON_JUSTIFY

Justification for detail buttons

See Also:

Constant Field Values

DEFAULT_BUTTON_JUSTIFY

public static final String DEFAULT_BUTTON_JUSTIFY

See Also:

Constant Field Values

LABEL_JUSTIFY

public static final String LABEL_JUSTIFY

Label justification. Whether the Field's label is above (top) or to the left (left) of the Field's display.

See Also:

Constant Field Values

LABEL_JUSTIFY_LEFT

public static final String LABEL_JUSTIFY_LEFT

See Also:

Constant Field Values

LABEL_JUSTIFY_TOP

public static final String LABEL_JUSTIFY_TOP

See Also:

Constant Field Values

DEFAULT_LABEL_JUSTIFY

public static final String DEFAULT_LABEL_JUSTIFY

See Also:

Constant Field Values

DELETE

public static final String DELETE

Allow delete on details screen

See Also:

Constant Field Values

DEFAULT_DELETE

public static final boolean DEFAULT_DELETE

See Also:

Constant Field Values

INSERT

public static final String INSERT

Allow inserts on details screen

See Also:

Constant Field Values

DEFAULT_INSERT

public static final boolean DEFAULT_INSERT

Default whether to allow inserts on details screen

See Also:

Constant Field Values

INSERT_AND_COPY

public static final String INSERT_AND_COPY

Display the insert and copy button

See Also:

Constant Field Values

DEFAULT_INSERT_AND_COPY

public static final boolean DEFAULT_INSERT_AND_COPY

Default insert and copy

See Also:

Constant Field Values

INSERT_AND_NEW

public static final String INSERT_AND_NEW

Display the insert and new

See Also:

Constant Field Values

DEFAULT_INSERT_AND_NEW

public static final boolean DEFAULT_INSERT_AND_NEW

Default insert and new

See Also:

Constant Field Values

NEXT_AND_PREVIOUS

public static final String NEXT_AND_PREVIOUS

Display the next & previouis buttons on updates & views

See Also:

Constant Field Values

DEFAULT_NEXT_AND_PREVIOUS

public static final boolean DEFAULT_NEXT_AND_PREVIOUS

Default insert and new

See Also:

Constant Field Values

INCLUDE_COLON_AFTER_LABEL

public static final String INCLUDE_COLON_AFTER_LABEL

Include colon ':' after labels

See Also:

Constant Field Values

GRID

public static final String GRID

Diplay grid

See Also:

Constant Field Values

BUTTON_LOCATIONS

public static final String BUTTON_LOCATIONS

Where to include the buttons (note by default buttons are included both above and below details).

See Also:

Constant Field Values

BUTTON_LOCATION_TOP

public static final String BUTTON_LOCATION_TOP

See Also:

Constant Field Values

BUTTON_LOCATION_BOTTOM

public static final String BUTTON_LOCATION_BOTTOM

See Also:

Constant Field Values

DEFAULT_BUTTON_LOCATIONS

public static final List DEFAULT_BUTTON_LOCATIONS

DETAILS_DISPLAY

public static final String DETAILS_DISPLAY

Name of this property group

See Also:

Constant Field Values

EDIT_TARGET_WINDOW

public static final String EDIT_TARGET_WINDOW

Which HTML window should be used for displaying an edit screen

See Also:

Constant Field Values

INSERT_TARGET_WINDOW

public static final String INSERT_TARGET_WINDOW

Which HTML window should be used for displaying an insert screen

See Also:

Constant Field Values

COPY_TARGET_WINDOW

public static final String COPY_TARGET_WINDOW

Which HTML window should be used for displaying a copy screen

See Also:

Constant Field Values

VIEW_TARGET_WINDOW

public static final String VIEW_TARGET_WINDOW

Which HTML window should be used for displaying the detials

See Also:

Constant Field Values

DETAILS_TARGET_WINDOW

public static final String DETAILS_TARGET_WINDOW

Which HTML window should be used for displaying the detials

See Also:

Constant Field Values

TARGET_WINDOW_PROPERTY

public static final short TARGET_WINDOW_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DetailDisplayPropertyGroup

public DetailDisplayPropertyGroup()

DisplayPropertyGroup constructor comment.

DetailDisplayPropertyGroup

public DetailDisplayPropertyGroup(int initialCapacity)

DisplayPropertyGroup constructor comment.

Parameters:

initialCapacity - int

DetailDisplayPropertyGroup

public DetailDisplayPropertyGroup(String pName)

DisplayPropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public List getAllPropertyNames()

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

Overrides:

getAllPropertyNames in class DefaultPropertyGroup

getButtonJustify

public String getButtonJustify()

Gets the justification of the buttons

getButtonLocations

public List getButtonLocations()

Gets the justification of the Fields label. If no justification is specified, the label is generated left of the Field by default.

Returns:

justification of the Field's label (e.g. "left" or "top").

getColumnCount

public int getColumnCount()

Gets the number of columns to show on Row details.

getCopyTargetWindow

public DetailDisplayPropertyGroup.TargetWindow getCopyTargetWindow()

Gets the TargetWindow object representing the target window to display the copy screen in. Null indicates that the current screen should be used

getDefaultLayoutPropertiesString

public static String getDefaultLayoutPropertiesString()

Gets a default String for this property group. All properties are listed without any values.

getDelete

public boolean getDelete()

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

getEditTargetWindow

public DetailDisplayPropertyGroup.TargetWindow getEditTargetWindow()

Gets the TargetWindow object representing the target window to display the edit screen in. Null indicates that the current screen should be used

getInsert

public boolean getInsert()

Get whether or not to include the insert button when viewing details.

getInsertAndCopy

public boolean getInsertAndCopy()

Gets the number of columns to show on Row details.

getInsertAndNew

public boolean getInsertAndNew()

Gets the number of columns to show on Row details.

getNextAndPrevious

public boolean getNextAndPrevious()

Gets wheter to show previous and next buttons on view and updates.

getInsertTargetWindow

public DetailDisplayPropertyGroup.TargetWindow getInsertTargetWindow()

Gets the TargetWindow object representing the target window to display the edit screen in. Null indicates that the current screen should be used

getLabelJustify

public String getLabelJustify()

Gets the justification of the Fields label. If no justification is specified, the label is generated left of the Field by default.

Returns:

justification of the Field's label (e.g. "left" or "top").

isDisplayGrid

public boolean isDisplayGrid()

Check to see if a grid should be included.

getMaxInputWidth

public int getMaxInputWidth()

Gets the max sum of all input widths for a given Row on details.

getMaxInputWidthSum

public int getMaxInputWidthSum()

Gets the max sum of all input widths for a given Row on details.

getViewTargetWindow

public DetailDisplayPropertyGroup.TargetWindow getViewTargetWindow()

Gets the TargetWindow object representing the target window to display the edit screen in. Null indicates that the current screen should be used

isIncludeColonAfterLabel

public boolean isIncludeColonAfterLabel()

Check to see if colon should be included after the Field's label.

isLabelLeftJustify

public boolean isLabelLeftJustify()

Check to see if label should be to the left of the Field.

Returns:

true if label should be to the left of the Field; false otherwise.

isLabelTopJustify

public boolean isLabelTopJustify()

Check to see if label should be to the top of the Field.

Returns:

true if label should be to the top of the Field; false otherwise.

isShowButtons

public boolean isShowButtons(String location)

Check to see if detail buttons should be shown for the given location. Current supported locations are 'top' and 'bottom'.

Returns:

true if detail buttons should be shown for the given location.