Package com.smartgwt.client.widgets.form.fields

Class HeaderItem

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.data.Field
com.smartgwt.client.widgets.form.fields.FormItem
com.smartgwt.client.widgets.form.fields.HeaderItem
All Implemented Interfaces:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPendingStatusChangedHandlers, HasPickerIconClickHandlers, HasShowContextMenuHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers, HasValueIconClickHandlers
public class HeaderItem extends FormItem
FormItem for showing a header within a DynamicForm.

Set the defaultValue of this item to the HTML you want to embed in the form.

  • Constructor Details

    • HeaderItem

      public HeaderItem()

    • HeaderItem

      public HeaderItem(JavaScriptObject jsObj)

    • HeaderItem

      public HeaderItem(String name)

    • HeaderItem

      public HeaderItem(String name, String title)

  • Method Details

    • getOrCreateRef

      public static HeaderItem getOrCreateRef(JavaScriptObject jsObj)

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
      Changes the defaults for Canvas AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
      Changes the defaults for FormItem AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:

    • changePickerIconDefaults

      public static void changePickerIconDefaults(FormItemIcon defaults)

    • setAlign

      public HeaderItem setAlign(Alignment align)
      Alignment of this HeaderItem in its cell.

      Note: Because a HeaderItem fills its cell by default, if the applyAlignToText setting is changed to false, then the textAlign setting (rather than the align setting) of this HeaderItem should be used to control the alignment of the header text.

      Overrides:
      setAlign in class FormItem
      Parameters:
      align - New align value. Default value is null
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getAlign

      public Alignment getAlign()
      Alignment of this HeaderItem in its cell.

      Note: Because a HeaderItem fills its cell by default, if the applyAlignToText setting is changed to false, then the textAlign setting (rather than the align setting) of this HeaderItem should be used to control the alignment of the header text.

      Overrides:
      getAlign in class FormItem
      Returns:
      Current align value. Default value is null
      See Also:

    • setApplyAlignToText

      public HeaderItem setApplyAlignToText(boolean applyAlignToText)
      If the textAlign is unset, should the align setting, if set, be used for this HeaderItem's textAlign?

      Note : This is an advanced setting

      Overrides:
      setApplyAlignToText in class FormItem
      Parameters:
      applyAlignToText - New applyAlignToText value. Default value is true
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getApplyAlignToText

      public boolean getApplyAlignToText()
      If the textAlign is unset, should the align setting, if set, be used for this HeaderItem's textAlign?
      Overrides:
      getApplyAlignToText in class FormItem
      Returns:
      Current applyAlignToText value. Default value is true
      See Also:

    • setCanSelectText

      public HeaderItem setCanSelectText(boolean canSelectText)
      Should the user be able to select the text in this item?
      Overrides:
      setCanSelectText in class FormItem
      Parameters:
      canSelectText - New canSelectText value. Default value is true
      Returns:
      HeaderItem instance, for chaining setter calls

    • getCanSelectText

      public boolean getCanSelectText()
      Should the user be able to select the text in this item?
      Overrides:
      getCanSelectText in class FormItem
      Returns:
      Current canSelectText value. Default value is true

    • setColSpan

      public HeaderItem setColSpan(int colSpan)
      by default, headers span all remaining columns
      Overrides:
      setColSpan in class FormItem
      Parameters:
      colSpan - New colSpan value. Default value is "*"
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getColSpan

      public int getColSpan()
      by default, headers span all remaining columns

      Note : This method will return -1 if the underlying SmartClient JavaScript attribute value cannot be expressed as a(n) int. In that case, other getters, similarly-named but ending in AsString, AsCanvas, etc., may be provided.

      Returns:
      Current colSpan value. Default value is "*"
      See Also:

    • setColSpan

      public HeaderItem setColSpan(String colSpan)
      by default, headers span all remaining columns
      Overrides:
      setColSpan in class FormItem
      Parameters:
      colSpan - New colSpan value. Default value is "*"
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getColSpanAsString

      public String getColSpanAsString()
      by default, headers span all remaining columns
      Returns:
      Current colSpan value. Default value is "*"
      See Also:

    • setDefaultValue

      public HeaderItem setDefaultValue(String defaultValue)
      Header text
      Overrides:
      setDefaultValue in class FormItem
      Parameters:
      defaultValue - New defaultValue value. Default value is "Header"
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getDefaultValue

      public String getDefaultValue()
      Header text
      Overrides:
      getDefaultValue in class FormItem
      Returns:
      Current defaultValue value. Default value is "Header"
      See Also:

    • setEditProxyConstructor

      public HeaderItem setEditProxyConstructor(String editProxyConstructor)
      Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
      Overrides:
      setEditProxyConstructor in class FormItem
      Parameters:
      editProxyConstructor - New editProxyConstructor value. Default value is "TextItemEditProxy"
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getEditProxyConstructor

      public String getEditProxyConstructor()
      Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
      Overrides:
      getEditProxyConstructor in class FormItem
      Returns:
      Current editProxyConstructor value. Default value is "TextItemEditProxy"
      See Also:

    • setEndRow

      public HeaderItem setEndRow(Boolean endRow)
      these items are in a row by themselves by default
      Overrides:
      setEndRow in class FormItem
      Parameters:
      endRow - New endRow value. Default value is true
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getEndRow

      public Boolean getEndRow()
      these items are in a row by themselves by default
      Overrides:
      getEndRow in class FormItem
      Returns:
      Current endRow value. Default value is true
      See Also:

    • setShowTitle

      public HeaderItem setShowTitle(Boolean showTitle)
      Don't show a separate title cell for headers
      Overrides:
      setShowTitle in class FormItem
      Parameters:
      showTitle - New showTitle value. Default value is false
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getShowTitle

      public Boolean getShowTitle()
      Don't show a separate title cell for headers
      Overrides:
      getShowTitle in class FormItem
      Returns:
      Current showTitle value. Default value is false
      See Also:

    • setStartRow

      public HeaderItem setStartRow(Boolean startRow)
      these items are in a row by themselves by default
      Overrides:
      setStartRow in class FormItem
      Parameters:
      startRow - New startRow value. Default value is true
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getStartRow

      public Boolean getStartRow()
      these items are in a row by themselves by default
      Overrides:
      getStartRow in class FormItem
      Returns:
      Current startRow value. Default value is true
      See Also:

    • setTextBoxStyle

      public HeaderItem setTextBoxStyle(String textBoxStyle)
      Base CSS class for this item
      Overrides:
      setTextBoxStyle in class FormItem
      Parameters:
      textBoxStyle - New textBoxStyle value. Default value is "headerItem"
      Returns:
      HeaderItem instance, for chaining setter calls
      See Also:

    • getTextBoxStyle

      public String getTextBoxStyle()
      Base CSS class for this item
      Overrides:
      getTextBoxStyle in class FormItem
      Returns:
      Current textBoxStyle value. Default value is "headerItem"
      See Also:

    • setDefaultProperties

      public static void setDefaultProperties(HeaderItem headerItemProperties)
      Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties of the class instance passed to this function. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

      Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

      Parameters:
      headerItemProperties - properties that should be used as new defaults when instances of this class are created
      See Also: