ConfiguredWidget

java.lang.Object
- com.ibm.commerce.telesales.model.ModelObject
- - com.ibm.commerce.telesales.widgets.ConfiguredWidget

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ConfiguredControl, ConfiguredTableColumn
```
public abstract class ConfiguredWidget
extends ModelObject
```
This base class for configured UI elements. A configured UI element has configurable properties.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_FORMATTER_TYPE` Formatter type property.
`static java.lang.String`	`PROP_HAS_REQUIRED_INPUT` Has required input property.
`static java.lang.String`	`PROP_LABEL` Label property.
`static java.lang.String`	`PROP_MANAGER_TYPE` Manager type property.
`static java.lang.String`	`PROP_MODEL_PATH` Model path property.
`static java.lang.String`	`PROP_REQUIRED` Required property.
`static java.lang.String`	`PROP_STATUS_MESSAGE` Status message property.
`static java.lang.String`	`PROP_VALIDATOR_TYPE` `Validator` type property.
`static java.lang.String`	`PROP_VERIFY_LISTENER_TYPE` Verify listener type property.

Constructor Summary

Constructors
Constructor and Description

ConfiguredWidget(java.lang.String id, java.util.Map properties)
Constructs a new instance of this class with the specified ID.

Constructors
Constructor and Description
`ConfiguredWidget(java.lang.String id, java.util.Map properties)` Constructs a new instance of this class with the specified ID.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getFormatterType()` Retrieve the formatter type property.
`boolean`	`getHasRequiredInput()` This method returns `true` if this configured widget has its required user input.
`java.lang.String`	`getId()` This method returns the ID for this control.
`java.lang.String`	`getLabel()` This method returns a label that can be used to identify this widget to the user.
`java.lang.String`	`getManagerType()` This method returns the manager type for this widget.
`java.lang.String`	`getModelPath()` This method returns the model path for this widget.
`java.lang.String`	`getPreresolveId()` The ID as it was before it was resolved.
`java.lang.Object`	`getProperty(java.lang.String name)` This method returns a configured property for this control.
`boolean`	`getRequired()` This method returns `true` if this a required field.
`org.eclipse.core.runtime.IStatus`	`getStatusMessage()` This method returns the status message associated with this widget.
`java.lang.String`	`getValidatorType()` This method returns the `validator` type.
`java.lang.String`	`getVerifyListenerType()` This method returns the verify listener type.
`boolean`	`isFormattingRequired()` This method checks if formatting is required while rendering this widget
`void`	`setHasRequiredInput(boolean hasRequiredInput)` This method sets the flag that indicates that this configured widget has its required input.
`void`	`setId(java.lang.String id)` This method sets the ID for this control.
`void`	`setLabel(java.lang.String label)` This method sets the label property.
`void`	`setManagerType(java.lang.String managerType)` This method sets the manager type for this widget.
`void`	`setModelPath(java.lang.String modelPath)` This method sets the model path for this widget.
`void`	`setPreresolveId(java.lang.String preresolveId)` This method sets the preresolve ID.
`void`	`setProperty(java.lang.String name, java.lang.Object value)` This method sets the specified property.
`void`	`setRequired(boolean required)` This method sets the required property.
`void`	`setStatusMessage(org.eclipse.core.runtime.IStatus statusMessage)` This method sets the status message for this widget.
`void`	`setValidatorType(java.lang.String validatorType)` This method sets the `validator` type.
`void`	`setVerifyListenerType(java.lang.String verifyListenerType)` This method sets the verify listener type.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_MODEL_PATH
```
public static final java.lang.String PROP_MODEL_PATH
```
    Model path property. Value is "modelPath".
    
    See Also:
    
    Constant Field Values
  - PROP_MANAGER_TYPE
```
public static final java.lang.String PROP_MANAGER_TYPE
```
    Manager type property. Value is "managerType".
    
    See Also:
    
    Constant Field Values
  - PROP_VERIFY_LISTENER_TYPE
```
public static final java.lang.String PROP_VERIFY_LISTENER_TYPE
```
    Verify listener type property. Value is "verifyListenerType".
    
    See Also:
    
    Constant Field Values
  - PROP_FORMATTER_TYPE
```
public static final java.lang.String PROP_FORMATTER_TYPE
```
    Formatter type property. Value is "formatterType".
    
    See Also:
    
    Constant Field Values
  - PROP_STATUS_MESSAGE
```
public static final java.lang.String PROP_STATUS_MESSAGE
```
    Status message property. Value is "statusMessage".
    
    See Also:
    
    Constant Field Values
  - PROP_REQUIRED
```
public static final java.lang.String PROP_REQUIRED
```
    Required property. Value is "required".
    
    See Also:
    
    Constant Field Values
  - PROP_LABEL
```
public static final java.lang.String PROP_LABEL
```
    Label property. Value is "label".
    
    See Also:
    
    Constant Field Values
  - PROP_VALIDATOR_TYPE
```
public static final java.lang.String PROP_VALIDATOR_TYPE
```
    Validator type property. Value is "validatorType".
    
    See Also:
    
    Constant Field Values
  - PROP_HAS_REQUIRED_INPUT
```
public static final java.lang.String PROP_HAS_REQUIRED_INPUT
```
    Has required input property. Value is "hasRequiredInput".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConfiguredWidget
```
public ConfiguredWidget(java.lang.String id,
                java.util.Map properties)
```
    Constructs a new instance of this class with the specified ID.
    
    Parameters:
    
    id - The ID of the UI element
    
    properties - properties associated with this control
- Method Detail
  - getId
```
public java.lang.String getId()
```
    This method returns the ID for this control.
    
    Returns:
    
    The control's ID.
  - setId
```
public void setId(java.lang.String id)
```
    This method sets the ID for this control.
    
    Parameters:
    
    id - the control's ID
  - getPreresolveId
```
public java.lang.String getPreresolveId()
```
    The ID as it was before it was resolved.
    
    Returns:
    
    the preresolve ID
  - setPreresolveId
```
public void setPreresolveId(java.lang.String preresolveId)
```
    This method sets the preresolve ID.
    
    Parameters:
    
    preresolveId - the ID before it is resolved.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    This method returns a configured property for this control. Normally properties are defined in the controls extension definition.
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the property with the specified name
  - setProperty
```
public void setProperty(java.lang.String name,
               java.lang.Object value)
```
    This method sets the specified property.
    
    Parameters:
    
    name - the name of the property
    
    value - the value for the property
  - getModelPath
```
public java.lang.String getModelPath()
```
    This method returns the model path for this widget.
    
    Returns:
    
    the model path for this widget
  - setModelPath
```
public void setModelPath(java.lang.String modelPath)
```
    This method sets the model path for this widget.
    
    Parameters:
    
    modelPath - the new model path
  - getManagerType
```
public java.lang.String getManagerType()
```
    This method returns the manager type for this widget.
    
    Returns:
    
    the manager type for this widget
  - setManagerType
```
public void setManagerType(java.lang.String managerType)
```
    This method sets the manager type for this widget.
    
    Parameters:
    
    managerType - manager type
  - getVerifyListenerType
```
public java.lang.String getVerifyListenerType()
```
    This method returns the verify listener type. This value is used by the widget manager to determine the verification listener that should be added to this control.
    
    Returns:
    
    verification listener type
  - setVerifyListenerType
```
public void setVerifyListenerType(java.lang.String verifyListenerType)
```
    This method sets the verify listener type.
    
    Parameters:
    
    verifyListenerType - the new verify listener type
  - isFormattingRequired
```
public boolean isFormattingRequired()
```
    This method checks if formatting is required while rendering this widget
    
    Returns:
    
    true if rendering is required false otherwise.
  - getFormatterType
```
public java.lang.String getFormatterType()
```
    Retrieve the formatter type property.
    
    Returns:
    
    name of the formatter type or null if there is none.
  - getStatusMessage
```
public org.eclipse.core.runtime.IStatus getStatusMessage()
```
    This method returns the status message associated with this widget.
    
    Returns:
    
    an IStatus containing the message and severity
  - setStatusMessage
```
public void setStatusMessage(org.eclipse.core.runtime.IStatus statusMessage)
```
    This method sets the status message for this widget.
    
    Parameters:
    
    statusMessage - an IStatus containing the message and severity
  - getRequired
```
public boolean getRequired()
```
    This method returns true if this a required field.
    
    Returns:
    
    true if this is a required field
  - setRequired
```
public void setRequired(boolean required)
```
    This method sets the required property.
    
    Parameters:
    
    required - the new required setting
  - getLabel
```
public java.lang.String getLabel()
```
    This method returns a label that can be used to identify this widget to the user.
    
    Returns:
    
    the widget label
  - setLabel
```
public void setLabel(java.lang.String label)
```
    This method sets the label property.
    
    Parameters:
    
    label - the new label
  - getValidatorType
```
public java.lang.String getValidatorType()
```
    This method returns the validator type. This value is used by the widget manager to determine the type of validation that should be performed for this widget.
    
    Returns:
    
    validator type
  - setValidatorType
```
public void setValidatorType(java.lang.String validatorType)
```
    This method sets the validator type.
    
    Parameters:
    
    validatorType - the new validator type
  - setHasRequiredInput
```
public void setHasRequiredInput(boolean hasRequiredInput)
```
    This method sets the flag that indicates that this configured widget has its required input.
    
    Parameters:
    
    hasRequiredInput - required input flag
  - getHasRequiredInput
```
public boolean getHasRequiredInput()
```
    This method returns true if this configured widget has its required user input.
    
    Returns:
    
    true if this widget has its required input

Class ConfiguredWidget

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.telesales.model.ModelObject

Methods inherited from class java.lang.Object

Field Detail

PROP_MODEL_PATH

PROP_MANAGER_TYPE

PROP_VERIFY_LISTENER_TYPE

PROP_FORMATTER_TYPE

PROP_STATUS_MESSAGE

PROP_REQUIRED

PROP_LABEL

PROP_VALIDATOR_TYPE

PROP_HAS_REQUIRED_INPUT

Constructor Detail

ConfiguredWidget

Method Detail

getId

setId

getPreresolveId

setPreresolveId

getProperty

setProperty

getModelPath

setModelPath

getManagerType

setManagerType

getVerifyListenerType

setVerifyListenerType

isFormattingRequired

getFormatterType

getStatusMessage

setStatusMessage

getRequired

setRequired

getLabel

setLabel

getValidatorType

setValidatorType

setHasRequiredInput

getHasRequiredInput