com.ibm.di.config.interfaces
Interface FormSection

All Superinterfaces:

BaseConfiguration, java.io.Serializable

All Known Implementing Classes:

FormSectionImpl

public interface FormSection
extends BaseConfiguration

This interface describes one section in a FormConfig

Since:

7.0

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

void	addFormItem(FormItemConfig item) Add a FormItem to this FormSection.
java.lang.String	getDescription() Get the description of this FormSection, or null if no description
FormItemConfig	getFormItem(java.lang.String name) Get a FormItem defined by this FormSection, or the enclosing FormConfig.
java.util.Collection<FormItemConfig>	getFormItems() Returns a Collection of all locally defined FormItemConfigs.
java.util.Vector<java.lang.String>	getNames() Return the names of all FormSections or FormItems in the FormSection.
java.lang.String	getTitle() Get the title of this FormSection, or null if no title
boolean	initiallyExpanded() Return true if this section is initially expanded
void	setDescription(java.lang.String description) Set the description of this FormSection The new description should be a key to be looked up in the translation file
void	setForm(FormConfig form) Set the FormConfig this FormSection is part of.
void	setInitiallyExpanded(boolean value) Set whether this section is initially expanded
void	setNames(java.util.Vector<java.lang.String> names) Set the names of all FormSections or FormItems in the FormSection
void	setTitle(java.lang.String title) Set the title of this FormSection.

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, getScript, 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

getNames

java.util.Vector<java.lang.String> getNames()

Return the names of all FormSections or FormItems in the FormSection. Note: Modifying the Vector will modify the list in this FormSection.

setNames

void setNames(java.util.Vector<java.lang.String> names)

Set the names of all FormSections or FormItems in the FormSection

Parameters:

names - The new list of names

getTitle

java.lang.String getTitle()

Get the title of this FormSection, or null if no title

setTitle

void setTitle(java.lang.String title)

Set the title of this FormSection. The new title should be a key to be looked up in the translation file

Parameters:

title - The new title

getDescription

java.lang.String getDescription()

Get the description of this FormSection, or null if no description

setDescription

void setDescription(java.lang.String description)

Set the description of this FormSection The new description should be a key to be looked up in the translation file

Parameters:

description - The new description

initiallyExpanded

boolean initiallyExpanded()

Return true if this section is initially expanded

setInitiallyExpanded

void setInitiallyExpanded(boolean value)

Set whether this section is initially expanded

Parameters:

value - true if the section is initially expanded

getFormItem

FormItemConfig getFormItem(java.lang.String name)

Get a FormItem defined by this FormSection, or the enclosing FormConfig. May return null if the name is not defined. This may override or modify a FormItem defined in the FormConfig.

Parameters:

name - The name of the FormItem

addFormItem

void addFormItem(FormItemConfig item)

Add a FormItem to this FormSection. This may override or modify a FormItem defined in the FormConfig.

Parameters:

item - The new FormItem

getFormItems

java.util.Collection<FormItemConfig> getFormItems()

Returns a Collection of all locally defined FormItemConfigs. For internal use.

setForm

void setForm(FormConfig form)

Set the FormConfig this FormSection is part of.

Parameters:

form - The FormConfig