com.iplanet.jato.view
Interface CommandField

All Superinterfaces:
DisplayField, View
All Known Implementing Classes:
CommandFieldBase

public interface CommandField
extends DisplayField

Specialization of a display field that represents a user-invokable application action. A command field is said to be activated when a user invokes it, thereby sending a request back to the server. Typically, but not exclusively, implementations of this interface represent the controls which clients activate in order to invoke request (for example, buttons and HREF's).

Version:
JATO/1.2.2 $Id: CommandField.java,v 1.10 2002/03/16 03:26:39 todd Exp $

Fields inherited from interface com.iplanet.jato.view.View
QUALIFIED_VIEW_NAME_SEPARATOR
 
Method Summary
 void beforeCommand(CommandEvent event)
          Invoked before the request handling command is invoked as notification that this field was activated.
 CommandFieldDescriptor getCommandFieldDescriptor()
          Returns this field's CommandFieldDescriptor object
 java.util.Map getExtraValuesMap()
          Returns a map of the extra name-value pairs associated with this field
 
Methods inherited from interface com.iplanet.jato.view.DisplayField
getDescriptor, getValue, getValues, setValue, setValues, stringValue
 
Methods inherited from interface com.iplanet.jato.view.View
getName, getParent, getQualifiedName, setParent
 

Method Detail

getExtraValuesMap

public java.util.Map getExtraValuesMap()
Returns a map of the extra name-value pairs associated with this field
Returns:
A valid Map instance. This method should not return null.

beforeCommand

public void beforeCommand(CommandEvent event)
Invoked before the request handling command is invoked as notification that this field was activated. Developers creating their own subclasses of the existing CommandField implementations and who override this method should always call the superclass version of this event to ensure consistent behavior.

getCommandFieldDescriptor

public CommandFieldDescriptor getCommandFieldDescriptor()
Returns this field's CommandFieldDescriptor object