com.ibm.di.config.interfaces
Interface FormItemConfig

All Superinterfaces:

BaseConfiguration, java.io.Serializable

All Known Implementing Classes:

FormItemConfigImpl

public interface FormItemConfig
extends BaseConfiguration

One item in a FormConfig

Field Summary

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

Method Summary

java.lang.Object	get(java.lang.String name) Generic get
java.lang.String	getComponentClass() Return the name of the Component class that should be used for this formitem.
java.lang.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.
java.lang.String	getLabel() Get the label for this FormItem
java.lang.String	getLeadText() Return the lead-in text, to be used in addition to the label
java.util.List<java.lang.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.
java.lang.String	getReflect() Return the name of the method to set/get this FormItem.
java.lang.String	getScript() Get script to be executed for a button in this FormItem
java.lang.String	getScript2() Get script to be executed for a 2nd button in this FormItem
java.lang.String	getScriptLabel() Get label for a button in this FormItem
java.lang.String	getScriptLabel2() Get label for a 2nd button in this FormItem
java.lang.String	getScriptToolTip() Get tooltip for a button in this FormItem
java.lang.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.
java.lang.String	getSyntax() Get the syntax of this FormItem
java.lang.String	getToolTip() Get the ToolTip for this FormItem
java.util.List<java.lang.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(java.lang.String mode) Returns whether this FormItem is valid for a particular mode.
void	setDefaultValue(java.lang.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(java.lang.String str) Set the label for this FormItem
void	setLeadText(java.lang.String text) Set the lead-in text, to be used in addition to the label
void	setLocalizedValues(java.util.Map map) Set the localized values for this FormItem.
void	setRequired(boolean value) Set whether this FormItem is a required parameter
void	setSyntax(java.lang.String str) Set the syntax of this FormItem
void	setToolTip(java.lang.String str) Set the ToolTip for this FormItem.
void	setValues(java.util.Vector values) Set the possible values for this FormItem.

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, isProtectedParameter, 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, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

getSyntax

java.lang.String getSyntax()

Get the syntax of this FormItem

setSyntax

void setSyntax(java.lang.String str)

Set the syntax of this FormItem

Parameters:

str - The new syntax

getLabel

java.lang.String getLabel()

Get the label for this FormItem

setLabel

void setLabel(java.lang.String str)

Set the label for this FormItem

Parameters:

str - The new label

getToolTip

java.lang.String getToolTip()

Get the ToolTip for this FormItem

setToolTip

void setToolTip(java.lang.String str)

Set the ToolTip for this FormItem.

Parameters:

str - The new ToolTip

getDefaultValue

java.lang.String getDefaultValue()

Get the default value for this FormItem. null means no default.

setDefaultValue

void setDefaultValue(java.lang.String str)

Set the default value for this FormItem.

Parameters:

str - The new default value

getValues

java.util.List<java.lang.String> getValues()

Get the possible values for this FormItem.

setValues

void setValues(java.util.Vector values)

Set the possible values for this FormItem.

Parameters:

values - The new values

getLocalizedValues

java.util.List<java.lang.String> getLocalizedValues()

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

Since:

7.0

setLocalizedValues

void setLocalizedValues(java.util.Map map)

Set the localized values for this FormItem.

Parameters:

map - maps from real values to localized Values.

Since:

7.0

isIndexBased

boolean isIndexBased()

Is this FormItem indexBased?

Since:

7.0

setIndexBased

void setIndexBased(boolean value)

Set whether this FormItem should be indexbased.

Parameters:

value - True if this FormItem should be indexbased.

getScript

java.lang.String getScript()

Get script to be executed for a button in this FormItem

Specified by:

getScript in interface BaseConfiguration

Returns:

The script value.

getScriptLabel

java.lang.String getScriptLabel()

Get label for a button in this FormItem

getScriptToolTip

java.lang.String getScriptToolTip()

Get tooltip for a button in this FormItem

getScript2

java.lang.String getScript2()

Get script to be executed for a 2nd button in this FormItem

Since:

7.0

getScriptLabel2

java.lang.String getScriptLabel2()

Get label for a 2nd button in this FormItem

Since:

7.0

getScriptToolTip2

java.lang.String getScriptToolTip2()

Get tooltip for a 2nd button in this FormItem

Since:

7.0

isReadOnly

boolean isReadOnly()

Is this FormItem readOnly?

Since:

7.0

getDontProtect

boolean getDontProtect()

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.

Since:

7.0

isExpression

boolean isExpression()

Return true if this FormItem is an expression

Since:

7.0

getComponentClass

java.lang.String getComponentClass()

Return the name of the Component class that should be used for this formitem. Used if syntax = "COMPONENT"

Since:

7.0

getReflect

java.lang.String getReflect()

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.

Since:

7.0

getMinValue

int getMinValue()

Return the minimun value for this FormItem. default is Integer.MIN_VALUE;

Since:

7.0

getMaxValue

int getMaxValue()

Return the maximun value for this FormItem. default is Integer.MAX_VALUE;

Since:

7.0

getSize

int getSize()

Return the size of this FormItem, as number of characters If nothing specified, return 0.

Since:

7.0

isHelp

boolean isHelp()

Return true if this is a help item

Since:

7.0

isRequired

boolean isRequired()

Return true if this FormItem is a required parameter

Since:

7.0

setRequired

void setRequired(boolean value)

Set whether this FormItem is a required parameter

Parameters:

value - True if this FormItem is a required parameter

getLeadText

java.lang.String getLeadText()

Return the lead-in text, to be used in addition to the label

Since:

7.0

setLeadText

void setLeadText(java.lang.String text)

Set the lead-in text, to be used in addition to the label

Parameters:

text - The new lead-in text

Since:

7.0

get

java.lang.Object get(java.lang.String name)

Generic get

Since:

7.0

setForm

void setForm(FormConfig form)

Set the FormConfig this FormItem is part of.

Parameters:

form - The FormConfig

getForm

FormConfig getForm()

Returns the FormConfig this FormItem is part of.

Since:

7.1.1

isValidForMode

boolean isValidForMode(java.lang.String mode)

Returns whether this FormItem is valid for a particular mode.

Parameters:

mode - The mode

Returns:

true if the FormItem is valid for the mode.

Since:

7.0