Package com.ebasetech.xi.api.controls

Interface FieldControl

All Superinterfaces:
BackgroundStyleProperties, BorderStyleProperties, Control, Element, EventOwner, FieldControlProperties, MarginStyleProperties, MessageContainer, MessageProperties, PaddingStyleProperties, java.io.Serializable, WebFormEventOwner
public interface FieldControl
extends FieldControlProperties, Control, MessageProperties, BackgroundStyleProperties, BorderStyleProperties, PaddingStyleProperties, MarginStyleProperties
Field Control

Further documentation.

  • Method Details

    • getFieldClass

      java.lang.String getFieldClass()
      Returns the list of CSS classes applied to the <div> tag that wraps all parts of the field.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setFieldClass(String)

    • setFieldClass

      void setFieldClass​(java.lang.String fieldClass)
      Sets one or more CSS classes to be applied to the <div> tag that wraps all parts of the field. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • getLabelClass

      java.lang.String getLabelClass()
      Returns the list of CSS classes applied to the <div> tag that wraps the label text.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelClass(String), getLabelElementClass()

    • setLabelClass

      void setLabelClass​(java.lang.String labelClass)
      Sets one or more CSS classes to be applied to the <div> tag that wraps the label text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelElementClass(String)

    • getLabelElementClass

      java.lang.String getLabelElementClass()
      Returns the list of CSS classes applied to the <label> tag that contains the label text. The <label> tag is written inside the <div> tag to which the Style property above is applied.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelClass(String), getLabelClass()

    • setLabelElementClass

      void setLabelElementClass​(java.lang.String labelElementClass)
      Sets one or more CSS classes to be applied to the <label> tag that contains the label text. The <label> tag is written inside the <div> tag to which the Style property above is applied. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelElementClass(String)

    • getEditorCellClass

      java.lang.String getEditorCellClass()
      Returns the list of CSS classes applied to the <div> tag that wraps the editor.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorCellClass(String), getEditorClass()

    • setEditorCellClass

      void setEditorCellClass​(java.lang.String editorCellClass)
      Sets one or more CSS classes to be applied to the <div> tag that wraps the editor. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorClass(String)

    • getEditorClass

      java.lang.String getEditorClass()
      Returns the list of CSS classes applied to the <input> tag when the control is not display only.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorClass(String), getEditorCellClass()

    • setEditorClass

      void setEditorClass​(java.lang.String editorClass)
      Sets one or more CSS classes to be applied to the <input> tag when the control is not display only. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorCellClass(String)

    • getFieldStyle

      java.lang.String getFieldStyle()
      Returns the inline CSS style applied to the <div> tag that wraps all parts of the field.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setFieldStyle(String)

    • setFieldStyle

      void setFieldStyle​(java.lang.String fieldStyle)
      Sets the inline CSS style to be applied to the <div> tag that wraps all parts of the field. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • getLabelStyle

      java.lang.String getLabelStyle()
      Returns the inline CSS style applied to the <div> tag that wraps the label text.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelStyle(String), getLabelElementStyle()

    • setLabelStyle

      void setLabelStyle​(java.lang.String labelStyle)
      Sets the inline CSS style to be applied to the <div> tag that wraps the label text. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelElementStyle(String)

    • getLabelElementStyle

      java.lang.String getLabelElementStyle()
      Returns the inline CSS style applied to the <label> tag that contains the label text. The <label> tag is written inside the <div> tag to which the Style property above is applied.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelElementStyle(String), getLabelStyle()

    • setLabelElementStyle

      void setLabelElementStyle​(java.lang.String labelElementStyle)
      Sets the inline CSS style to be applied to the <label> tag that contains the label text. The <label> tag is written inside the <div> tag to which the Style property above is applied. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setLabelStyle(String)

    • getEditorCellStyle

      java.lang.String getEditorCellStyle()
      Returns the inline CSS style applied to the <div> tag that wraps the editor.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorCellStyle(String), getEditorStyle()

    • setEditorCellStyle

      void setEditorCellStyle​(java.lang.String editorCellStyle)
      Sets the inline CSS style to be applied to the <div> tag that wraps the editor. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorStyle(String)

    • getEditorStyle

      java.lang.String getEditorStyle()
      Returns the inline CSS style applied to the <input> tag when the control is not display only.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorStyle(String), getEditorCellStyle()

    • setEditorStyle

      void setEditorStyle​(java.lang.String editorStyle)
      Sets the inline CSS style to be applied to the <input> tag when the control is not display only. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setEditorCellStyle(String)

    • getHelpClass

      java.lang.String getHelpClass()
      Returns the list of CSS classes applied to the help text.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setHelpClass(String)

    • setHelpClass

      void setHelpClass​(java.lang.String helpClass)
      Sets one or more CSS classes to be applied to help text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • getHelpStyle

      java.lang.String getHelpStyle()
      Returns the inline CSS style applied to the help text.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setHelpStyle(String)

    • setHelpStyle

      void setHelpStyle​(java.lang.String helpStyle)
      Sets the inline CSS style to be applied to the help text. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • getHelpPos

      int getHelpPos()
      Returns the position of the help text. See setHelpPos(int) for details of supported values when setting this property.
      Since:
      V4.4

    • setHelpPos

      void setHelpPos​(int helpPos)
      Sets the position of the help text. Supported values:
      ValueMeaning
      0No position set
      1To right of editor
      2Underneath editor
      3as popup window
      Since:
      V4.4

    • getHelpWindowProperties

      java.lang.String getHelpWindowProperties()
      Returns the properties passed to the Javascript window.open() statement used to create the popup window, overriding any properties configured using getInfoProperties().

      These properties are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • setHelpWindowProperties

      void setHelpWindowProperties​(java.lang.String helpWindowProperties)
      Sets the properties passed to the Javascript window.open() statement used to create the popup window, overriding any properties configured using getInfoProperties().
      Since:
      V4.4

    • getHelpButImage

      java.lang.String getHelpButImage()
      Returns the URL of the clickable image used to display the help text in a popup window. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setHelpButImage

      void setHelpButImage​(java.lang.String helpButImage)
      Sets the URL of the clickable image used to display the help text in a popup window. The URL can be either relative or absolute. When absolute, is should start with the protocol e.g. http://www.google.com.

      Further documentation.

      Since:
      V4.4

    • getPopupHelpStyle

      java.lang.String getPopupHelpStyle()
      Returns the inline CSS style applied to the popup help window.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setPopupHelpStyle(String)

    • setPopupHelpStyle

      void setPopupHelpStyle​(java.lang.String popupHelpStyle)
      Sets the inline CSS style applied to the popup help window. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • isDisplayLabelText

      boolean isDisplayLabelText()
      Returns true if the label part of the field should be displayed, otherwise returns false;

      Further documentation.

      Since:
      V4.4

    • setDisplayLabelText

      void setDisplayLabelText​(boolean displayLabelText)
      Sets whether or not the label part of the field should be displayed;

      Further documentation.

      Since:
      V4.4

    • isDisplayEditor

      boolean isDisplayEditor()
      Returns true if the editor part of the field should be displayed, otherwise returns false;

      Further documentation.

      Since:
      V4.4

    • setDisplayEditor

      void setDisplayEditor​(boolean displayEditor)
      Sets whether or not the editor part of the field should be displayed;

      Further documentation.

      Since:
      V4.4

    • isDisplayInfoText

      boolean isDisplayInfoText()
      Returns true if the help part of the field should be displayed, otherwise returns false;

      Further documentation.

      Since:
      V4.4

    • setDisplayInfoText

      void setDisplayInfoText​(boolean displayInfoText)
      Sets whether or not the help part of the field should be displayed;

      Further documentation.

      Since:
      V4.4

    • getVAlign

      java.lang.String getVAlign()
      Vertical alignment for the entire field including all its parts. See setVAlign(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setVAlign

      void setVAlign​(java.lang.String vAlign)
      Sets the vertical alignment for the entire field including all its parts.

      Supported values:

      ValueConstant
      CenterControlConstants.VERTICAL_ALIGNMENT_CENTER
      TopControlConstants.VERTICAL_ALIGNMENT_TOP
      BottomControlConstants.VERTICAL_ALIGNMENT_BOTTOM

      Setting a value of null removes any existing value for the property.

      Since:
      V4.4

    • getGapAfterLabel

      java.lang.String getGapAfterLabel()
      The gap after the field label. See setGapAfterLabel(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4

    • setGapAfterLabel

      void setGapAfterLabel​(java.lang.String gapAfterLabel)
      Sets the gap after the field label. Any value valid for the CSS margin-xxx parameters can be used.

      Further documentation.

      Since:
      V4.4

    • getGapAfterEditor

      java.lang.String getGapAfterEditor()
      The gap after the field editor. See setGapAfterEditor(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4

    • setGapAfterEditor

      void setGapAfterEditor​(java.lang.String gapAfterEditor)
      Sets the gap after the field editor. Any value valid for the CSS margin-xxx parameters can be used.

      Further documentation.

      Since:
      V4.4

    • getGapBeforeInfo

      java.lang.String getGapBeforeInfo()
      The gap before the field help. See setGapBeforeInfo(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4

    • setGapBeforeInfo

      void setGapBeforeInfo​(java.lang.String gapBeforeInfo)
      Sets the gap before the field help. Any value valid for the CSS margin-xxx parameters can be used.

      Further documentation.

      Since:
      V4.4

    • getPatternTextClass

      java.lang.String getPatternTextClass()
      Returns the list of CSS classes applied to the value pattern.

      Further documentation.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setPatternTextClass(String)

    • setPatternTextClass

      void setPatternTextClass​(java.lang.String patternTextClass)
      Sets one or more CSS classes to be applied to the value pattern. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • getPatternTextStyle

      java.lang.String getPatternTextStyle()
      Returns the inline CSS style applied to the value pattern.

      Further documentation.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4
      See Also:
      setPatternTextStyle(String)

    • setPatternTextStyle

      void setPatternTextStyle​(java.lang.String patternTextStyle)
      Sets the inline CSS style to be applied to the value pattern. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the designer using the Advanced Properties button within the Field Control Styling Assistant.

      Since:
      V4.4

    • getLabelProperties

      TextStyleProperties getLabelProperties()
      Text properties for the label text.

      Further documentation.

      Since:
      V4.4

    • getEditorInputProperties

      EditorInputProperties getEditorInputProperties()
      Properties applied to the editor part of the field.
      Since:
      V4.4

    • getValuePatternProperties

      TextStyleProperties getValuePatternProperties()
      Text properties for the value pattern text text.

      Further documentation.

      Since:
      V4.4

    • getCalendarProperties

      ImageStyleProperties getCalendarProperties()
      Properties for the date calendar image.

      Further documentation.

      Since:
      V4.4

    • getInfoProperties

      InfoProperties getInfoProperties()
      Text properties for the label text.
      Since:
      V4.4

    • getField

      WebFormField getField()
      Returns the field displayed by this Field Control.
      Since:
      V4.4

    • isEditableRadioOrCheckboxList

      boolean isEditableRadioOrCheckboxList()
      Returns true if the field represents a list that will be displayed as a list of radio buttons or checkboxes.
      Since:
      V4.5.1

    • getLabelHtmlElementProperties

      HtmlElementProperties getLabelHtmlElementProperties()
      Return the field label HTMLElementProperties for the Field Control
      Since:
      V5.9

    • getInfoHtmlElementProperties

      HtmlElementProperties getInfoHtmlElementProperties()
      Return the field info HTMLElementProperties for the Field Control
      Since:
      V5.9