|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FormConfig
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 |
java.lang.String |
getFormEventHandler()
/** Get the script that handles events in this FormConfig. |
FormItemConfig |
getFormItem(java.lang.String name)
Get a FormItem defined by this FormConfig. |
java.util.List<java.lang.String> |
getFormItemNames()
Returns a list of the names of all the FormItems in this FormConfig. |
java.lang.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. |
java.util.Iterator<java.lang.String> |
getLocalFormItemNames()
Returns an Iterator over names of FormItems defined in this FormConfig. |
FormSection |
getSection(java.lang.String name)
Get the FormSection with the given name. |
java.util.List<java.lang.String> |
getSectionNames()
Get a list of the names of all Sections used by this FormConfig, if defined. |
java.util.List<java.lang.String> |
getTabNames()
Get names of tabs. |
java.lang.String |
getTabTitle(java.lang.String name)
Get Title for one tab. |
java.lang.String |
getTabToolTip(java.lang.String name)
Get Tooltip for one tab. |
java.lang.String |
getTitle()
Get the title of this FormConfig. |
java.lang.ClassLoader |
getTranslationClassLoader()
|
java.lang.String |
getTranslationFile()
Get the name of the translation file. |
java.lang.String |
getTranslationLocale()
Returns Locale identifier (ISO lang code) to use when translating resources. |
java.lang.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. |
java.util.List<ValidatorConfig> |
getValidators()
Return list of all available validators in the configuration. |
int |
getWidth(int w)
Get the preferred width of this Form. |
FormItemConfig |
newFormItem(java.lang.String name)
Create a new FormItem with the given name |
void |
removeFormItem(java.lang.String name)
Remove the FormItem with the given name |
void |
renameFormItem(java.lang.String oldName,
java.lang.String newName)
Rename a FormItem. |
void |
setTranslationClassLoader(java.lang.ClassLoader ldr)
Sets the preferred ClassLoader able to resolve the translation
file as a resource. |
void |
setTranslationFile(java.lang.String name)
Set the name of the translation file. |
void |
setTranslationLocale(java.lang.String locale)
Sets the preferred Locale to use when translating strings. |
java.lang.String |
translate(java.lang.String str)
Translate a String. |
Method Detail |
---|
java.util.List<java.lang.String> getFormItemNames()
java.util.Iterator<java.lang.String> getLocalFormItemNames()
FormItemConfig getFormItem(java.lang.String name)
name
- The name of the FormItemFormItemConfig newFormItem(java.lang.String name)
name
- The name of the FormItemvoid removeFormItem(java.lang.String name)
name
- The name of the FormItemvoid renameFormItem(java.lang.String oldName, java.lang.String newName)
oldName
- The old name of the FormItemnewName
- The new name of the FormItemvoid addFormItem(FormItemConfig item)
java.util.List<java.lang.String> getSectionNames()
FormSection getSection(java.lang.String name)
name
- The name of the FormSectionvoid addSection(FormSection section)
java.lang.String getFormEventHandler()
java.lang.String getFormScript()
java.lang.String getTitle()
java.lang.String getUIClass()
int getWidth(int w)
w
- Use this width if no width definedint getHeight(int h)
h
- Use this height if no height defined.boolean getUseHyperLabel()
boolean getUseTabs()
java.util.List<java.lang.String> getTabNames()
java.lang.String getTabTitle(java.lang.String name)
name
- Name of the tabjava.lang.String getTabToolTip(java.lang.String name)
name
- Name of the tabjava.lang.String getTranslationFile()
void setTranslationFile(java.lang.String name)
java.lang.String translate(java.lang.String str)
str
- The string to be translated
void setTranslationLocale(java.lang.String locale)
java.lang.String getTranslationLocale()
void setTranslationClassLoader(java.lang.ClassLoader ldr)
ClassLoader
able to resolve the translation
file as a resource.
java.lang.ClassLoader getTranslationClassLoader()
ClassLoader
used to resolve the translation file as a
resource. If not specified null
is returned.java.util.List<ValidatorConfig> getValidators()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |