com.iplanet.jato.view
Class CommandFieldDescriptor

java.lang.Object
  |
  +--com.iplanet.jato.view.DisplayFieldDescriptor
        |
        +--com.iplanet.jato.view.CommandFieldDescriptor

public class CommandFieldDescriptor
extends DisplayFieldDescriptor

Provides a means to specify non-trivial CommandField configuration details. The CommandField supports some advanced features related to the use of CommandSourceTargetPairs and Command objects. The CommandFieldDescriptor is used to provide the CommandField with the information required to take advantage of those advanced features.

Instances of CommandField which do not intend to take advantage of the features enabled by the use of CommandFieldDescriptor do not need to be supplied with a CommandFieldDescriptor.

Version:
JATO/1.2.2 $Id: CommandFieldDescriptor.java,v 1.6 2002/03/16 03:26:40 todd Exp $

Fields inherited from class com.iplanet.jato.view.DisplayFieldDescriptor
ACTION_TYPE_PROP, ALIGN_PROP, AUTO_FILL_BEFORE_FIRST_DISPLAY_PROP, AUTO_FILL_DATA_OBJECT_NAME_PROP, AUTO_FILL_DATA_SOURCE_NAME_PROP, AUTO_FILL_TABLE_PROP, AUTO_FILL_TYPE_PROP, BOUND_DATAFIELD_NAME_PROP, BOUND_DATAOBJECT_NAME_PROP, BUILT_IN_ACTION_TYPE_PROP, BUTTON_INPUT_TYPE_PROP, CHECKED_VALUE_PROP, CLASS_PROP, CLEAR_DATA_OBJECTS_BEFORE_MAPPING_PROP, CLEAR_PAGES_BEFORE_MAPPING_PROP, DEFAULT_EXTERNAL_URL_PROP, DEFAULT_FRAME_TYPE_PROP, DEFAULT_ND_PAGE_PROP, DEFAULT_VALUE_PROP, EXTERNAL_URL_PROP, EXTRA_HTML_TEXT_PROP, FORMAT_1000_SEPARATOR_SYMBOL_PROP, FORMAT_CURRENCY_SYMBOL_PROP, FORMAT_DATETIME_STYLE_PROP, FORMAT_DECIMAL_PLACES_PROP, FORMAT_DECIMAL_SEPARATOR_SYMBOL_PROP, FORMAT_ENABLED_PROP, FORMAT_MASK_PROP, FORMAT_NEGATIVE_NUMBER_STYLE_PROP, FORMAT_RED_ON_NEGATIVE_PROP, FORMAT_TYPE_PROP, FORMAT_USE_1000_SEPARATOR_PROP, FORMAT_USE_CURRENCY_SYMBOL_PROP, HORIZONTAL_LAYOUT_PROP, HREF_TYPE_PROP, HTML_ESCAPING_PROP, HTML_STUB_PROP, INPUT_REQUIRED_PROP, LABEL_FOR_NONE_SELECTED_PROP, LABEL_PROP, LINES_PROP, MAX_LENGTH_PROP, MULTIPLE_PROP, NAME_PROP, PICTURE_PROP, QUERY_TYPE_PROP, SELECT_QUERY, SIZE_PROP, SUPERCLASS_PROP, TARGET_FRAME_PROP, TARGET_FRAME_TYPE_PROP, TARGET_ND_PAGE_PROP, UNCHECKED_VALUE_PROP, USER_DEFINED_HTML_PROP, VALID_RANGE_FROM_PROP, VALID_RANGE_TO_PROP, VALIDATION_STRING_PROP, VALIDATION_TYPE_PROP, VALUE_PROP
 
Constructor Summary
CommandFieldDescriptor()
          Default constructor
CommandFieldDescriptor(CommandDescriptor commandDescriptor)
          Creates a CommandFieldDescriptor object
 
Method Summary
 void addSourceTargetPair(CommandSourceTargetPair value)
          Adds a CommandSourceTargetPair to this object
 CommandDescriptor getCommandDescriptor()
          Returns the CommandDescriptor
 java.util.List getSourceTargetPairList()
          Returns a List of CommandSourceTargetPair objects
 CommandSourceTargetPair[] getSourceTargetPairs()
          Returns an array of CommandSourceTargetPair objects
 void setCommandDescriptor(CommandDescriptor value)
          Sets the CommandDescriptor
 
Methods inherited from class com.iplanet.jato.view.DisplayFieldDescriptor
getAttribute, getStringAttribute, setAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommandFieldDescriptor

public CommandFieldDescriptor()
Default constructor

CommandFieldDescriptor

public CommandFieldDescriptor(CommandDescriptor commandDescriptor)
Creates a CommandFieldDescriptor object
Parameters:
commandDescriptor - A CommandDescriptor. Establishes an automatic Command invocation relationship between the CommandField that will be initialized with this descriptor and an arbitrary Command. A value of null may be supplied for this parameter in cases where a relationship between CommandField and Command is not required.
Method Detail

getCommandDescriptor

public CommandDescriptor getCommandDescriptor()
Returns the CommandDescriptor
Returns:
The CommandDescriptor.

setCommandDescriptor

public void setCommandDescriptor(CommandDescriptor value)
Sets the CommandDescriptor
Parameters:
value - A CommandDescriptor. Establishes an automatic Command invocation relationship between the CommandField that will be configured with this descriptor and an arbitrary Command. A value of null may be supplied for this parameter in cases where a relationship between CommandField and Command is not required.

addSourceTargetPair

public void addSourceTargetPair(CommandSourceTargetPair value)
Adds a CommandSourceTargetPair to this object
Parameters:
value - The CommandSourceTargetPair

getSourceTargetPairs

public CommandSourceTargetPair[] getSourceTargetPairs()
Returns an array of CommandSourceTargetPair objects
Returns:
the array of CommandSourceTargetPair objects

getSourceTargetPairList

public java.util.List getSourceTargetPairList()
Returns a List of CommandSourceTargetPair objects
Returns:
the List of CommandSourceTargetPair objects