com.ibm.di.config.base
Class FormItemConfigImpl

java.lang.Object
  extended by com.ibm.di.config.base.BaseConfigurationImpl
      extended by com.ibm.di.config.base.FormItemConfigImpl
All Implemented Interfaces:
BaseConfiguration, FormItemConfig, MetamergeConfigChangeListener, Serializable

public class FormItemConfigImpl
extends BaseConfigurationImpl
implements FormItemConfig

Implementation of one item in a FormConfigImpl

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl
NAME
 
Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE
 
Constructor Summary
FormItemConfigImpl()
           
FormItemConfigImpl(Object config)
           
 
Method Summary
 Object get(String name)
          Generic get
 String getComponentClass()
          Return the name of the Component class that should be used for this formitem.
 String getDefaultValue()
          Get the default value for this FormItem.
 boolean getDontProtect()
          Return true if this FormItem should not be protected.
 FormConfig getForm()
          Returns the FormConfig this FormItem is part of.
 String getLabel()
          Get the label for this FormItem
 String getLeadText()
          Return the lead-in text, to be used in addition to the label
 List<String> getLocalizedValues()
          Get the localized values for this FormItem.
 int getMaxValue()
          Return the maximun value for this FormItem.
 int getMinValue()
          Return the minimun value for this FormItem.
 String getReflect()
          Return the name of the method to set/get this FormItem.
 String getScript()
          Gets the script attribute of this object.
 String getScript2()
          Get script to be executed for a 2nd button in this FormItem
 String getScriptLabel()
          Get label for a button in this FormItem
 String getScriptLabel2()
          Get label for a 2nd button in this FormItem
 String getScriptToolTip()
          Get tooltip for a button in this FormItem
 String getScriptToolTip2()
          Get tooltip for a 2nd button in this FormItem
 int getSize()
          Return the size of this FormItem, as number of characters If nothing specified, return 0.
 String getSyntax()
          Get the syntax of this FormItem
 String getToolTip()
          Get the ToolTip for this FormItem
 List<String> getValues()
          Get the possible values for this FormItem.
 boolean isExpression()
          Return true if this FormItem is an expression
 boolean isHelp()
          Return true if this is a help item
 boolean isIndexBased()
          Is this FormItem indexBased?
 boolean isReadOnly()
          Is this FormItem readOnly?
 boolean isRequired()
          Return true if this FormItem is a required parameter
 boolean isValidForMode(String mode)
          Returns whether this FormItem is valid for a particular mode.
 void setDefaultValue(String str)
          Set the default value for this FormItem.
 void setForm(FormConfig form)
          Set the FormConfig this FormItem is part of.
 void setIndexBased(boolean value)
          Set whether this FormItem should be indexbased.
 void setLabel(String str)
          Set the label for this FormItem
 void setLeadText(String text)
          Set the lead-in text, to be used in addition to the label
 void setLocalizedValues(Map map)
          Set the localized values for this FormItem.
 void setRequired(boolean value)
          Set whether this FormItem is a required parameter
 void setScript(String str)
          Sets the script attribute of this object.
 void setScript2(String str)
           
 void setScriptLabel(String str)
           
 void setScriptLabel2(String str)
           
 void setScriptToolTip(String str)
           
 void setScriptToolTip2(String str)
           
 void setSyntax(String str)
          Set the syntax of this FormItem
 void setToolTip(String str)
          Set the ToolTip for this FormItem.
 void setValues(Vector values)
          Set the possible values for this FormItem.
 
Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl
addListener, configurationChanged, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseConfigListeners, setUseListeners, setUserComment, size, toEntry, toString, updateInheritsFrom, willExpandProps, willFlatten, willUseInherited
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
 

Constructor Detail

FormItemConfigImpl

public FormItemConfigImpl()

FormItemConfigImpl

public FormItemConfigImpl(Object config)
Method Detail

setForm

public void setForm(FormConfig form)
Description copied from interface: FormItemConfig
Set the FormConfig this FormItem is part of.

Specified by:
setForm in interface FormItemConfig
Parameters:
form - The FormConfig

getForm

public FormConfig getForm()
Description copied from interface: FormItemConfig
Returns the FormConfig this FormItem is part of.

Specified by:
getForm in interface FormItemConfig

getValues

public List<String> getValues()
Description copied from interface: FormItemConfig
Get the possible values for this FormItem.

Specified by:
getValues in interface FormItemConfig

getLocalizedValues

public List<String> getLocalizedValues()
Description copied from interface: FormItemConfig
Get the localized values for this FormItem. The values are the same length, and have the same order as getValues(). This is only useful for a droplist

Specified by:
getLocalizedValues in interface FormItemConfig

setLocalizedValues

public void setLocalizedValues(Map map)
Description copied from interface: FormItemConfig
Set the localized values for this FormItem.

Specified by:
setLocalizedValues in interface FormItemConfig
Parameters:
map - maps from real values to localized Values.

setValues

public void setValues(Vector values)
Description copied from interface: FormItemConfig
Set the possible values for this FormItem.

Specified by:
setValues in interface FormItemConfig
Parameters:
values - The new values

getSyntax

public String getSyntax()
Description copied from interface: FormItemConfig
Get the syntax of this FormItem

Specified by:
getSyntax in interface FormItemConfig

setSyntax

public void setSyntax(String str)
Description copied from interface: FormItemConfig
Set the syntax of this FormItem

Specified by:
setSyntax in interface FormItemConfig
Parameters:
str - The new syntax

getLabel

public String getLabel()
Description copied from interface: FormItemConfig
Get the label for this FormItem

Specified by:
getLabel in interface FormItemConfig

setLabel

public void setLabel(String str)
Description copied from interface: FormItemConfig
Set the label for this FormItem

Specified by:
setLabel in interface FormItemConfig
Parameters:
str - The new label

getToolTip

public String getToolTip()
Description copied from interface: FormItemConfig
Get the ToolTip for this FormItem

Specified by:
getToolTip in interface FormItemConfig

setToolTip

public void setToolTip(String str)
Description copied from interface: FormItemConfig
Set the ToolTip for this FormItem.

Specified by:
setToolTip in interface FormItemConfig
Parameters:
str - The new ToolTip

getDefaultValue

public String getDefaultValue()
Description copied from interface: FormItemConfig
Get the default value for this FormItem. null means no default.

Specified by:
getDefaultValue in interface FormItemConfig

setDefaultValue

public void setDefaultValue(String str)
Description copied from interface: FormItemConfig
Set the default value for this FormItem.

Specified by:
setDefaultValue in interface FormItemConfig
Parameters:
str - The new default value

getScript

public String getScript()
Description copied from class: BaseConfigurationImpl
Gets the script attribute of this object.

Specified by:
getScript in interface BaseConfiguration
Specified by:
getScript in interface FormItemConfig
Overrides:
getScript in class BaseConfigurationImpl
Returns:
The script value.

setScript

public void setScript(String str)
Description copied from class: BaseConfigurationImpl
Sets the script attribute of this object.

Specified by:
setScript in interface BaseConfiguration
Overrides:
setScript in class BaseConfigurationImpl
Parameters:
str - The new script value

getScriptLabel

public String getScriptLabel()
Description copied from interface: FormItemConfig
Get label for a button in this FormItem

Specified by:
getScriptLabel in interface FormItemConfig

setScriptLabel

public void setScriptLabel(String str)

getScriptToolTip

public String getScriptToolTip()
Description copied from interface: FormItemConfig
Get tooltip for a button in this FormItem

Specified by:
getScriptToolTip in interface FormItemConfig

setScriptToolTip

public void setScriptToolTip(String str)

getScript2

public String getScript2()
Description copied from interface: FormItemConfig
Get script to be executed for a 2nd button in this FormItem

Specified by:
getScript2 in interface FormItemConfig

setScript2

public void setScript2(String str)

getScriptLabel2

public String getScriptLabel2()
Description copied from interface: FormItemConfig
Get label for a 2nd button in this FormItem

Specified by:
getScriptLabel2 in interface FormItemConfig

setScriptLabel2

public void setScriptLabel2(String str)

getScriptToolTip2

public String getScriptToolTip2()
Description copied from interface: FormItemConfig
Get tooltip for a 2nd button in this FormItem

Specified by:
getScriptToolTip2 in interface FormItemConfig

setScriptToolTip2

public void setScriptToolTip2(String str)

isExpression

public boolean isExpression()
Description copied from interface: FormItemConfig
Return true if this FormItem is an expression

Specified by:
isExpression in interface FormItemConfig

isReadOnly

public boolean isReadOnly()
Description copied from interface: FormItemConfig
Is this FormItem readOnly?

Specified by:
isReadOnly in interface FormItemConfig

isIndexBased

public boolean isIndexBased()
Description copied from interface: FormItemConfig
Is this FormItem indexBased?

Specified by:
isIndexBased in interface FormItemConfig

setIndexBased

public void setIndexBased(boolean value)
Description copied from interface: FormItemConfig
Set whether this FormItem should be indexbased.

Specified by:
setIndexBased in interface FormItemConfig
Parameters:
value - True if this FormItem should be indexbased.

getDontProtect

public boolean getDontProtect()
Description copied from interface: FormItemConfig
Return true if this FormItem should not be protected. That means that the value should be stored in cleartext in the config file, even if the syntax is "Password". The default value is false, that is, protect the value of passwords.

Specified by:
getDontProtect in interface FormItemConfig

getComponentClass

public String getComponentClass()
Description copied from interface: FormItemConfig
Return the name of the Component class that should be used for this formitem. Used if syntax = "COMPONENT"

Specified by:
getComponentClass in interface FormItemConfig

getReflect

public String getReflect()
Description copied from interface: FormItemConfig
Return the name of the method to set/get this FormItem. set/get is supposed to be prefixed to the String to get the method.

Specified by:
getReflect in interface FormItemConfig

getMinValue

public int getMinValue()
Description copied from interface: FormItemConfig
Return the minimun value for this FormItem. default is Integer.MIN_VALUE;

Specified by:
getMinValue in interface FormItemConfig

getMaxValue

public int getMaxValue()
Description copied from interface: FormItemConfig
Return the maximun value for this FormItem. default is Integer.MAX_VALUE;

Specified by:
getMaxValue in interface FormItemConfig

get

public Object get(String name)
Description copied from interface: FormItemConfig
Generic get

Specified by:
get in interface FormItemConfig

getSize

public int getSize()
Description copied from interface: FormItemConfig
Return the size of this FormItem, as number of characters If nothing specified, return 0.

Specified by:
getSize in interface FormItemConfig

isHelp

public boolean isHelp()
Description copied from interface: FormItemConfig
Return true if this is a help item

Specified by:
isHelp in interface FormItemConfig

isRequired

public boolean isRequired()
Description copied from interface: FormItemConfig
Return true if this FormItem is a required parameter

Specified by:
isRequired in interface FormItemConfig

setRequired

public void setRequired(boolean value)
Description copied from interface: FormItemConfig
Set whether this FormItem is a required parameter

Specified by:
setRequired in interface FormItemConfig
Parameters:
value - True if this FormItem is a required parameter

getLeadText

public String getLeadText()
Description copied from interface: FormItemConfig
Return the lead-in text, to be used in addition to the label

Specified by:
getLeadText in interface FormItemConfig

setLeadText

public void setLeadText(String text)
Description copied from interface: FormItemConfig
Set the lead-in text, to be used in addition to the label

Specified by:
setLeadText in interface FormItemConfig
Parameters:
text - The new lead-in text

isValidForMode

public boolean isValidForMode(String mode)
Description copied from interface: FormItemConfig
Returns whether this FormItem is valid for a particular mode.

Specified by:
isValidForMode in interface FormItemConfig
Parameters:
mode - The mode
Returns:
true if the FormItem is valid for the mode.