Package com.ibm.di.config.interfaces

Interface FormConfig

    • Method Detail

      • getFormItemNames

        java.util.List<java.lang.String> getFormItemNames()
        Returns a list of the names of all the FormItems in this FormConfig. Some names may refer to global FormItems.

      • getLocalFormItemNames

        java.util.Iterator<java.lang.String> getLocalFormItemNames()
        Returns an Iterator over names of FormItems defined in this FormConfig.

      • getFormItem

        FormItemConfig getFormItem​(java.lang.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​(java.lang.String name)
        Create a new FormItem with the given name
        Parameters:
        name - The name of the FormItem

      • removeFormItem

        void removeFormItem​(java.lang.String name)
        Remove the FormItem with the given name
        Parameters:
        name - The name of the FormItem

      • renameFormItem

        void renameFormItem​(java.lang.String oldName,
                    java.lang.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

        java.util.List<java.lang.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​(java.lang.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

        java.lang.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

        java.lang.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

        java.lang.String getTitle()
        Get the title of this FormConfig.

      • getUIClass

        java.lang.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

        java.util.List<java.lang.String> getTabNames()
        Get names of tabs. These names refer to other FormConfig objects.

      • getTabTitle

        java.lang.String getTabTitle​(java.lang.String name)
        Get Title for one tab.
        Parameters:
        name - Name of the tab

      • getTabToolTip

        java.lang.String getTabToolTip​(java.lang.String name)
        Get Tooltip for one tab.
        Parameters:
        name - Name of the tab

      • getTranslationFile

        java.lang.String getTranslationFile()
        Get the name of the translation file. For internal use, to translate labels and so on.

      • setTranslationFile

        void setTranslationFile​(java.lang.String name)
        Set the name of the translation file. For internal use with ResourceBundle.

      • translate

        java.lang.String translate​(java.lang.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​(java.lang.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

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

      • setTranslationClassLoader

        void setTranslationClassLoader​(java.lang.ClassLoader ldr)
        Sets the preferred ClassLoader able to resolve the translation file as a resource.

      • getTranslationClassLoader

        java.lang.ClassLoader getTranslationClassLoader()
        Returns:
        the ClassLoader used to resolve the translation file as a resource. If not specified null is returned.

      • getValidators

        java.util.List<ValidatorConfig> getValidators()
        Return list of all available validators in the configuration. In case of missing validators an empty list is returned.
        Returns:
        list of validators configuration.