com.iplanet.jato.view
Class DisplayFieldDescriptor

java.lang.Object
  |
  +--com.iplanet.jato.view.DisplayFieldDescriptor
Direct Known Subclasses:
CommandFieldDescriptor

public class DisplayFieldDescriptor
extends java.lang.Object

Defines a descriptor class that can be used to contain multiple attributes that describe a display field.

The descriptor and its API can evolve independently of the DisplayField, and allows one to specify an arbitrarily large set of properties (or attributes) for a given display field. Furthermore, DisplayField sub-types can be programmed to expect and leverage more specialized sub-types of DisplayFieldDescriptor.

This base class implementation only stores name value pairs of Strings. These String name-value pairs are called "properties".

Please note: many DisplayField classes do not require, nor make use of any DisplayFieldDescriptor properties. In those cases there is no need nor benefit in providing the DisplayField with a DisplayFieldDescriptor.

Version:
JATO/1.2.2 $Id: DisplayFieldDescriptor.java,v 1.6 2002/03/16 03:26:40 todd Exp $
See Also:
DisplayField

Field Summary
static java.lang.String ACTION_TYPE_PROP
           
static java.lang.String ALIGN_PROP
           
static java.lang.String AUTO_FILL_BEFORE_FIRST_DISPLAY_PROP
           
static java.lang.String AUTO_FILL_DATA_OBJECT_NAME_PROP
           
static java.lang.String AUTO_FILL_DATA_SOURCE_NAME_PROP
           
static java.lang.String AUTO_FILL_TABLE_PROP
           
static java.lang.String AUTO_FILL_TYPE_PROP
           
static java.lang.String BOUND_DATAFIELD_NAME_PROP
           
static java.lang.String BOUND_DATAOBJECT_NAME_PROP
           
static java.lang.String BUILT_IN_ACTION_TYPE_PROP
           
static java.lang.String BUTTON_INPUT_TYPE_PROP
           
static java.lang.String CHECKED_VALUE_PROP
           
static java.lang.String CLASS_PROP
           
static java.lang.String CLEAR_DATA_OBJECTS_BEFORE_MAPPING_PROP
           
static java.lang.String CLEAR_PAGES_BEFORE_MAPPING_PROP
           
static java.lang.String DEFAULT_EXTERNAL_URL_PROP
           
static java.lang.String DEFAULT_FRAME_TYPE_PROP
           
static java.lang.String DEFAULT_ND_PAGE_PROP
           
static java.lang.String DEFAULT_VALUE_PROP
           
static java.lang.String EXTERNAL_URL_PROP
           
static java.lang.String EXTRA_HTML_TEXT_PROP
           
static java.lang.String FORMAT_1000_SEPARATOR_SYMBOL_PROP
           
static java.lang.String FORMAT_CURRENCY_SYMBOL_PROP
           
static java.lang.String FORMAT_DATETIME_STYLE_PROP
           
static java.lang.String FORMAT_DECIMAL_PLACES_PROP
           
static java.lang.String FORMAT_DECIMAL_SEPARATOR_SYMBOL_PROP
           
static java.lang.String FORMAT_ENABLED_PROP
           
static java.lang.String FORMAT_MASK_PROP
           
static java.lang.String FORMAT_NEGATIVE_NUMBER_STYLE_PROP
           
static java.lang.String FORMAT_RED_ON_NEGATIVE_PROP
           
static java.lang.String FORMAT_TYPE_PROP
           
static java.lang.String FORMAT_USE_1000_SEPARATOR_PROP
           
static java.lang.String FORMAT_USE_CURRENCY_SYMBOL_PROP
           
static java.lang.String HORIZONTAL_LAYOUT_PROP
           
static java.lang.String HREF_TYPE_PROP
           
static java.lang.String HTML_ESCAPING_PROP
           
static java.lang.String HTML_STUB_PROP
           
static java.lang.String INPUT_REQUIRED_PROP
           
static java.lang.String LABEL_FOR_NONE_SELECTED_PROP
           
static java.lang.String LABEL_PROP
           
static java.lang.String LINES_PROP
           
static java.lang.String MAX_LENGTH_PROP
           
static java.lang.String MULTIPLE_PROP
           
static java.lang.String NAME_PROP
           
static java.lang.String PICTURE_PROP
           
static java.lang.String QUERY_TYPE_PROP
           
static java.lang.String SELECT_QUERY
           
static java.lang.String SIZE_PROP
           
static java.lang.String SUPERCLASS_PROP
           
static java.lang.String TARGET_FRAME_PROP
           
static java.lang.String TARGET_FRAME_TYPE_PROP
           
static java.lang.String TARGET_ND_PAGE_PROP
           
static java.lang.String UNCHECKED_VALUE_PROP
           
static java.lang.String USER_DEFINED_HTML_PROP
           
static java.lang.String VALID_RANGE_FROM_PROP
           
static java.lang.String VALID_RANGE_TO_PROP
           
static java.lang.String VALIDATION_STRING_PROP
           
static java.lang.String VALIDATION_TYPE_PROP
           
static java.lang.String VALUE_PROP
           
 
Constructor Summary
DisplayFieldDescriptor()
          This method can be used to create a DisplayFieldDescriptor
DisplayFieldDescriptor(java.util.Map properties)
          This method can be used to create a DisplayFieldDescriptor
 
Method Summary
 java.lang.Object getAttribute(java.lang.String name)
          Returns the value of a given named property
 java.lang.String getStringAttribute(java.lang.String name)
          Returns the value of a given named property
 void setAttribute(java.lang.String name, java.lang.Object value)
          Sets the named property to the supplied value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_PROP

public static final java.lang.String CLASS_PROP

NAME_PROP

public static final java.lang.String NAME_PROP

SUPERCLASS_PROP

public static final java.lang.String SUPERCLASS_PROP

HTML_STUB_PROP

public static final java.lang.String HTML_STUB_PROP

DEFAULT_VALUE_PROP

public static final java.lang.String DEFAULT_VALUE_PROP

QUERY_TYPE_PROP

public static final java.lang.String QUERY_TYPE_PROP

EXTRA_HTML_TEXT_PROP

public static final java.lang.String EXTRA_HTML_TEXT_PROP

USER_DEFINED_HTML_PROP

public static final java.lang.String USER_DEFINED_HTML_PROP

HTML_ESCAPING_PROP

public static final java.lang.String HTML_ESCAPING_PROP

MAX_LENGTH_PROP

public static final java.lang.String MAX_LENGTH_PROP

LINES_PROP

public static final java.lang.String LINES_PROP

SIZE_PROP

public static final java.lang.String SIZE_PROP

ACTION_TYPE_PROP

public static final java.lang.String ACTION_TYPE_PROP

BUILT_IN_ACTION_TYPE_PROP

public static final java.lang.String BUILT_IN_ACTION_TYPE_PROP

CLEAR_PAGES_BEFORE_MAPPING_PROP

public static final java.lang.String CLEAR_PAGES_BEFORE_MAPPING_PROP

CLEAR_DATA_OBJECTS_BEFORE_MAPPING_PROP

public static final java.lang.String CLEAR_DATA_OBJECTS_BEFORE_MAPPING_PROP

EXTERNAL_URL_PROP

public static final java.lang.String EXTERNAL_URL_PROP

TARGET_FRAME_TYPE_PROP

public static final java.lang.String TARGET_FRAME_TYPE_PROP

TARGET_ND_PAGE_PROP

public static final java.lang.String TARGET_ND_PAGE_PROP

TARGET_FRAME_PROP

public static final java.lang.String TARGET_FRAME_PROP

PICTURE_PROP

public static final java.lang.String PICTURE_PROP

ALIGN_PROP

public static final java.lang.String ALIGN_PROP

VALUE_PROP

public static final java.lang.String VALUE_PROP

BUTTON_INPUT_TYPE_PROP

public static final java.lang.String BUTTON_INPUT_TYPE_PROP

HREF_TYPE_PROP

public static final java.lang.String HREF_TYPE_PROP

LABEL_FOR_NONE_SELECTED_PROP

public static final java.lang.String LABEL_FOR_NONE_SELECTED_PROP

MULTIPLE_PROP

public static final java.lang.String MULTIPLE_PROP

LABEL_PROP

public static final java.lang.String LABEL_PROP

HORIZONTAL_LAYOUT_PROP

public static final java.lang.String HORIZONTAL_LAYOUT_PROP

AUTO_FILL_TYPE_PROP

public static final java.lang.String AUTO_FILL_TYPE_PROP

AUTO_FILL_BEFORE_FIRST_DISPLAY_PROP

public static final java.lang.String AUTO_FILL_BEFORE_FIRST_DISPLAY_PROP

AUTO_FILL_DATA_OBJECT_NAME_PROP

public static final java.lang.String AUTO_FILL_DATA_OBJECT_NAME_PROP

AUTO_FILL_DATA_SOURCE_NAME_PROP

public static final java.lang.String AUTO_FILL_DATA_SOURCE_NAME_PROP

AUTO_FILL_TABLE_PROP

public static final java.lang.String AUTO_FILL_TABLE_PROP

SELECT_QUERY

public static final java.lang.String SELECT_QUERY

FORMAT_TYPE_PROP

public static final java.lang.String FORMAT_TYPE_PROP

FORMAT_ENABLED_PROP

public static final java.lang.String FORMAT_ENABLED_PROP

FORMAT_MASK_PROP

public static final java.lang.String FORMAT_MASK_PROP

FORMAT_DECIMAL_PLACES_PROP

public static final java.lang.String FORMAT_DECIMAL_PLACES_PROP

FORMAT_USE_1000_SEPARATOR_PROP

public static final java.lang.String FORMAT_USE_1000_SEPARATOR_PROP

FORMAT_1000_SEPARATOR_SYMBOL_PROP

public static final java.lang.String FORMAT_1000_SEPARATOR_SYMBOL_PROP

FORMAT_DECIMAL_SEPARATOR_SYMBOL_PROP

public static final java.lang.String FORMAT_DECIMAL_SEPARATOR_SYMBOL_PROP

FORMAT_USE_CURRENCY_SYMBOL_PROP

public static final java.lang.String FORMAT_USE_CURRENCY_SYMBOL_PROP

FORMAT_CURRENCY_SYMBOL_PROP

public static final java.lang.String FORMAT_CURRENCY_SYMBOL_PROP

FORMAT_NEGATIVE_NUMBER_STYLE_PROP

public static final java.lang.String FORMAT_NEGATIVE_NUMBER_STYLE_PROP

FORMAT_DATETIME_STYLE_PROP

public static final java.lang.String FORMAT_DATETIME_STYLE_PROP

FORMAT_RED_ON_NEGATIVE_PROP

public static final java.lang.String FORMAT_RED_ON_NEGATIVE_PROP

VALIDATION_TYPE_PROP

public static final java.lang.String VALIDATION_TYPE_PROP

INPUT_REQUIRED_PROP

public static final java.lang.String INPUT_REQUIRED_PROP

VALIDATION_STRING_PROP

public static final java.lang.String VALIDATION_STRING_PROP

VALID_RANGE_FROM_PROP

public static final java.lang.String VALID_RANGE_FROM_PROP

VALID_RANGE_TO_PROP

public static final java.lang.String VALID_RANGE_TO_PROP

CHECKED_VALUE_PROP

public static final java.lang.String CHECKED_VALUE_PROP

UNCHECKED_VALUE_PROP

public static final java.lang.String UNCHECKED_VALUE_PROP

BOUND_DATAOBJECT_NAME_PROP

public static final java.lang.String BOUND_DATAOBJECT_NAME_PROP

BOUND_DATAFIELD_NAME_PROP

public static final java.lang.String BOUND_DATAFIELD_NAME_PROP

DEFAULT_FRAME_TYPE_PROP

public static final java.lang.String DEFAULT_FRAME_TYPE_PROP

DEFAULT_EXTERNAL_URL_PROP

public static final java.lang.String DEFAULT_EXTERNAL_URL_PROP

DEFAULT_ND_PAGE_PROP

public static final java.lang.String DEFAULT_ND_PAGE_PROP
Constructor Detail

DisplayFieldDescriptor

public DisplayFieldDescriptor()
This method can be used to create a DisplayFieldDescriptor

DisplayFieldDescriptor

public DisplayFieldDescriptor(java.util.Map properties)
This method can be used to create a DisplayFieldDescriptor
Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Returns the value of a given named property
Parameters:
name - The name of the property

getStringAttribute

public java.lang.String getStringAttribute(java.lang.String name)
Returns the value of a given named property
Parameters:
name - The name of the property

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
Sets the named property to the supplied value
Parameters:
name - The name of the property
value - The value of the property