com.ibm.di.config.interfaces
Interface FormConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

FormConfigImpl

public interface FormConfig
extends BaseConfiguration

A Form that can be displayed by the Configuration Editor

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 definition to this FormConfig
void	addSection(FormSection section) Add a FormSection definition to this FormConfig
String	getFormEventHandler() /** Get the script that handles events in this FormConfig.
FormItemConfig	getFormItem(String name) Get a FormItem defined by this FormConfig.
List<String>	getFormItemNames() Returns a list of the names of all the FormItems in this FormConfig.
String	getFormScript() Get the script that will be executed every time a button is pressed.
int	getHeight(int h) Get the preferred height of this Form.
Iterator<String>	getLocalFormItemNames() Returns an Iterator over names of FormItems defined in this FormConfig.
FormSection	getSection(String name) Get the FormSection with the given name.
List<String>	getSectionNames() Get a list of the names of all Sections used by this FormConfig, if defined.
List<String>	getTabNames() Get names of tabs.
String	getTabTitle(String name) Get Title for one tab.
String	getTabToolTip(String name) Get Tooltip for one tab.
String	getTitle() Get the title of this FormConfig.
String	getTranslationFile() Get the name of the translation file.
String	getTranslationLocale() Returns Locale identifier (ISO lang code) to use when translating resources.
String	getUIClass() Get the name of a UI class that will be used to display the form.
boolean	getUseHyperLabel() Return true if this FormConfig uses hyperlabels
boolean	getUseTabs() Return true if this form uses tabs.
int	getWidth(int w) Get the preferred width of this Form.
FormItemConfig	newFormItem(String name) Create a new FormItem with the given name
void	removeFormItem(String name) Remove the FormItem with the given name
void	renameFormItem(String oldName, String newName) Rename a FormItem.
void	setTranslationFile(String name) Set the name of the translation file.
void	setTranslationLocale(String locale) Sets the preferred Locale to use when translating strings.
String	translate(String str) Translate a String.

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, 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, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

getFormItemNames

List<String> getFormItemNames()

Returns a list of the names of all the FormItems in this FormConfig. Some names may refer to global FormItems.

getLocalFormItemNames

Iterator<String> getLocalFormItemNames()

Returns an Iterator over names of FormItems defined in this FormConfig.

getFormItem

FormItemConfig getFormItem(String name)

Get a FormItem defined by this FormConfig. May return null if the name is not defined in this FormConfig.

Parameters:

name - The name of the FormItem

newFormItem

FormItemConfig newFormItem(String name)

Create a new FormItem with the given name

Parameters:

name - The name of the FormItem

removeFormItem

void removeFormItem(String name)

Remove the FormItem with the given name

Parameters:

name - The name of the FormItem

renameFormItem

void renameFormItem(String oldName,
                    String newName)

Rename a FormItem.

Parameters:

oldName - The old name of the FormItem

newName - The new name of the FormItem

addFormItem

void addFormItem(FormItemConfig item)

Add a FormItem definition to this FormConfig

getSectionNames

List<String> getSectionNames()

Get a list of the names of all Sections used by this FormConfig, if defined. The names would typically be FormSection names. A FormSection also contains names, which could either be FormSection names of FormItem names. FormSection names would refer to FormSections in this FormConfig, but FormItem names may refer to global FormItems.

getSection

FormSection getSection(String name)

Get the FormSection with the given name.

Parameters:

name - The name of the FormSection

addSection

void addSection(FormSection section)

Add a FormSection definition to this FormConfig

getFormEventHandler

String getFormEventHandler()

/** Get the script that handles events in this FormConfig. This script is executed at once when the Form is displayed. Could be null.

getFormScript

String getFormScript()

Get the script that will be executed every time a button is pressed. Much like getFormEventHandler(), but this can be executed 0 or more times. Could be null.

getTitle

String getTitle()

Get the title of this FormConfig.

getUIClass

String getUIClass()

Get the name of a UI class that will be used to display the form. Most of the other parameters will be ignored. This could be null, indicating no UI class is defined.

getWidth

int getWidth(int w)

Get the preferred width of this Form.

Parameters:

w - Use this width if no width defined

getHeight

int getHeight(int h)

Get the preferred height of this Form.

Parameters:

h - Use this height if no height defined.

getUseHyperLabel

boolean getUseHyperLabel()

Return true if this FormConfig uses hyperlabels

getUseTabs

boolean getUseTabs()

Return true if this form uses tabs.

getTabNames

List<String> getTabNames()

Get names of tabs. These names refer to other FormConfig objects.

getTabTitle

String getTabTitle(String name)

Get Title for one tab.

Parameters:

name - Name of the tab

getTabToolTip

String getTabToolTip(String name)

Get Tooltip for one tab.

Parameters:

name - Name of the tab

getTranslationFile

String getTranslationFile()

Get the name of the translation file. For internal use, to translate labels and so on.

setTranslationFile

void setTranslationFile(String name)

Set the name of the translation file. For internal use with ResourceBundle.

translate

String translate(String str)

Translate a String.

Parameters:

str - The string to be translated

Returns:

The translated String, or the original String if no translation was found.

setTranslationLocale

void setTranslationLocale(String locale)

Sets the preferred Locale to use when translating strings. Setting this to null resets the FormConfig back to using the default locale; otherwise it overrides the default locale.

getTranslationLocale

String getTranslationLocale()

Returns Locale identifier (ISO lang code) to use when translating resources.