Class InputComponentGroup

  • All Implemented Interfaces:
    Referenceable

    public final class InputComponentGroup
    extends ProjectObject
    Defines a group of component to be displayed in the GetUserInputPanel.
    • Constructor Detail

      • InputComponentGroup

        public InputComponentGroup()
    • Method Detail

      • getComponentType

        public InputComponentType getComponentType()
        Returns the component type.
      • setComponentType

        public void setComponentType​(InputComponentType type)
        Defines the component type.
      • getComponents

        public java.util.Vector<InputComponent> getComponents()
        The list of components this component group contains.
      • getLabel

        public java.lang.String getLabel()
        Returns the label of the component.
      • setLabel

        public void setLabel​(java.lang.String label)
        Defines the label of the component.
      • getAdditional

        public int getAdditional()
        Returns the additinal configuration of the component.
      • getMagicFolderId

        public int getMagicFolderId()
        Returns the magic folder id of the component.
      • setMagicFolderId

        public void setMagicFolderId​(int magicFolderId)
        This sets the magic folder id.
      • setAdditional

        public void setAdditional​(int additional)
        Defines the additional configuration of the component. If the component type is FILECHOOSER the additional configuration is the magic folder where the file chooser dialog should point to by default, otherwise the additional configuration is the component orientation. Possible component orientations are integer (0) for vertical or integer (1) for horizontal.
      • getCaptionsFont

        public java.awt.Font getCaptionsFont()
        The font of the caption.
      • setCaptionsFont

        public void setCaptionsFont​(java.awt.Font captionsFont)
        The font of the caption.
      • getCaptionsFontColor

        public java.awt.Color getCaptionsFontColor()
        The color of the font of the caption.
      • setCaptionsFontColor

        public void setCaptionsFontColor​(java.awt.Color captionsFontColor)
        The color of the font of the caption.
      • getControlsBackgroundColor

        public java.awt.Color getControlsBackgroundColor()
        The color of the background of the controls.
      • setControlsBackgroundColor

        public void setControlsBackgroundColor​(java.awt.Color controlsBackgroundColor)
        The color of the background of the controls.
      • getControlsFont

        public java.awt.Font getControlsFont()
        The font of the controls.
      • setControlsFont

        public void setControlsFont​(java.awt.Font controlsFont)
        The font of the controls.
      • getControlsFontColor

        public java.awt.Color getControlsFontColor()
        The color of the font of the controls.
      • setControlsFontColor

        public void setControlsFontColor​(java.awt.Color controlsFontColor)
        The color of the font of the controls.
      • getLabelsBeside

        public boolean getLabelsBeside()
        Whether the labels should appear beside the text fields (as opposite to above them).
      • setLabelsBeside

        public void setLabelsBeside​(boolean labelsBeside)
        Whether the labels should appear beside the text fields (as opposite to above them).
      • isControlAlignLeft

        public boolean isControlAlignLeft()
        Whether the controls should be aligned normally towards left.
      • setControlAlignLeft

        public void setControlAlignLeft​(boolean controlAlignLeft)
        Whether the controls should be aligned normally towards left.
      • isMandatory

        public boolean isMandatory()
        Whether the field is mandatory or not.
      • setMandatory

        public void setMandatory​(boolean mandatory)
        Whether the field is should set to mandatory or not.
      • isEditableTrue

        public boolean isEditableTrue()
        Whether the textfield should be editable.
      • setEditableTrue

        public void setEditableTrue​(boolean editableTrue)
        Whether the textfield should be editable.
      • getLabelsFont

        public java.awt.Font getLabelsFont()
        The font of the labels.
      • setLabelsFont

        public void setLabelsFont​(java.awt.Font labelsFont)
        The font of the labels.
      • getLabelsFontColor

        public java.awt.Color getLabelsFontColor()
        The color of the font of the labels.
      • setLabelsFontColor

        public void setLabelsFontColor​(java.awt.Color labelsFontColor)
        The color of the font of the labels.
      • isUseDefaultCaptionsFontColor

        public boolean isUseDefaultCaptionsFontColor()
        Whether to use the default font color of the caption.
      • setUseDefaultCaptionsFontColor

        public void setUseDefaultCaptionsFontColor​(boolean useDefaultCaptionsFontColor)
        Whether to use the default font color of the caption.
      • isUseDefaultCaptionsFontSettings

        public boolean isUseDefaultCaptionsFontSettings()
        Whether to use the default font and color of the caption.
      • setUseDefaultCaptionsFontSettings

        public void setUseDefaultCaptionsFontSettings​(boolean useDefaultCaptionsFontSettings)
        Whether to use the default font and color of the caption.
      • isUseDefaultControlsBackgroundColor

        public boolean isUseDefaultControlsBackgroundColor()
        Whether to use the default background color of the controls.
      • setUseDefaultControlsBackgroundColor

        public void setUseDefaultControlsBackgroundColor​(boolean useDefaultControlsBackgroundColor)
        Whether to use the default background color of the controls.
      • isUseDefaultControlsFontColor

        public boolean isUseDefaultControlsFontColor()
        Whether to use the default font color of the controls.
      • setUseDefaultControlsFontColor

        public void setUseDefaultControlsFontColor​(boolean useDefaultControlsFontColor)
        Whether to use the default font color of the controls.
      • isUseDefaultControlsFontSettings

        public boolean isUseDefaultControlsFontSettings()
        Whether to use the default font and font color of the controls.
      • setUseDefaultControlsFontSettings

        public void setUseDefaultControlsFontSettings​(boolean useDefaultControlsFontSettings)
        Whether to use the default font and font color of the controls.
      • isUseDefaultLabelsFontColor

        public boolean isUseDefaultLabelsFontColor()
        Whether to use the default font color of the labels.
      • setUseDefaultLabelsFontColor

        public void setUseDefaultLabelsFontColor​(boolean useDefaultLabelsFontColor)
        Whether to use the default font color of the labels.
      • isUseDefaultLabelsFontSettings

        public boolean isUseDefaultLabelsFontSettings()
        Whether to use the default font and color of the labels.
      • setUseDefaultLabelsFontSettings

        public void setUseDefaultLabelsFontSettings​(boolean useDefaultLabelsFontSettings)
        Whether to use the default font and color of the labels.
      • isSubComponentsShouldBeHidden

        public boolean isSubComponentsShouldBeHidden()
        Whether subcomponents should be hidden, instead of disabled, when the component is not selected.
      • setSubComponentsShouldBeHidden

        public void setSubComponentsShouldBeHidden​(boolean subComponentsShouldBeHidden)
        Whether subcomponents should be hidden, instead of disabled, when the component is not selected.
      • getBidiOption

        public BidiOption getBidiOption()
      • setBidiOption

        public void setBidiOption​(BidiOption BidiOption)