com.ibm.di.config.base
Class FormSectionImpl

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

public class FormSectionImpl
extends BaseConfigurationImpl
implements FormSection

Implementation of one section in a FormConfigImpl

Since:
7.0
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
FormSectionImpl()
           
FormSectionImpl(Object obj)
           
 
Method Summary
 void addFormItem(FormItemConfig item)
          Add a FormItem to this FormSection.
 Object getClone()
          Return self clone
 String getDescription()
          Get the description of this FormSection, or null if no description
 FormItemConfig getFormItem(String name)
          Get a FormItem defined by this FormSection, or the enclosing FormConfig.
 Collection<FormItemConfig> getFormItems()
          Returns a Collection of all locally defined FormItemConfigs.
 Vector<String> getNames()
          Return the names of all FormSections or FormItems in the FormSection.
 String getTitle()
          Get the title of this FormSection, or null if no title
 void init()
          Called after internal data structure is set.
 boolean initiallyExpanded()
          Return true if this section is initially expanded
 void setDescription(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(Vector<String> names)
          Set the names of all FormSections or FormItems in the FormSection
 void setTitle(String title)
          Set the title of this FormSection.
 
Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl
addListener, configurationChanged, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, 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, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, 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, setScript, 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, 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, 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, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
 

Constructor Detail

FormSectionImpl

public FormSectionImpl()

FormSectionImpl

public FormSectionImpl(Object obj)
Method Detail

init

public void init()
Description copied from class: BaseConfigurationImpl
Called after internal data structure is set.

Specified by:
init in interface BaseConfiguration
Overrides:
init in class BaseConfigurationImpl

getNames

public Vector<String> getNames()
Description copied from interface: FormSection
Return the names of all FormSections or FormItems in the FormSection. Note: Modifying the Vector will modify the list in this FormSection.

Specified by:
getNames in interface FormSection

setNames

public void setNames(Vector<String> names)
Description copied from interface: FormSection
Set the names of all FormSections or FormItems in the FormSection

Specified by:
setNames in interface FormSection
Parameters:
names - The new list of names

getTitle

public String getTitle()
Description copied from interface: FormSection
Get the title of this FormSection, or null if no title

Specified by:
getTitle in interface FormSection

setTitle

public void setTitle(String title)
Description copied from interface: FormSection
Set the title of this FormSection. The new title should be a key to be looked up in the translation file

Specified by:
setTitle in interface FormSection
Parameters:
title - The new title

getDescription

public String getDescription()
Description copied from interface: FormSection
Get the description of this FormSection, or null if no description

Specified by:
getDescription in interface FormSection

setDescription

public void setDescription(String description)
Description copied from interface: FormSection
Set the description of this FormSection The new description should be a key to be looked up in the translation file

Specified by:
setDescription in interface FormSection
Parameters:
description - The new description

initiallyExpanded

public boolean initiallyExpanded()
Description copied from interface: FormSection
Return true if this section is initially expanded

Specified by:
initiallyExpanded in interface FormSection

setInitiallyExpanded

public void setInitiallyExpanded(boolean value)
Description copied from interface: FormSection
Set whether this section is initially expanded

Specified by:
setInitiallyExpanded in interface FormSection
Parameters:
value - true if the section is initially expanded

getFormItem

public FormItemConfig getFormItem(String name)
Description copied from interface: FormSection
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.

Specified by:
getFormItem in interface FormSection
Parameters:
name - The name of the FormItem

addFormItem

public void addFormItem(FormItemConfig item)
Description copied from interface: FormSection
Add a FormItem to this FormSection. This may override or modify a FormItem defined in the FormConfig.

Specified by:
addFormItem in interface FormSection
Parameters:
item - The new FormItem

getFormItems

public Collection<FormItemConfig> getFormItems()
Description copied from interface: FormSection
Returns a Collection of all locally defined FormItemConfigs. For internal use.

Specified by:
getFormItems in interface FormSection

getClone

public Object getClone()
                throws Exception
Return self clone

Specified by:
getClone in interface BaseConfiguration
Overrides:
getClone in class BaseConfigurationImpl
Returns:
a cloned version of this object.
Throws:
Exception

setForm

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

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