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

Class StaticTextItem

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.StaticTextItem
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
Direct Known Subclasses:
LinkItem, MiniDateRangeItem, MultiPickerItem
public class StaticTextItem extends FormItem
A FormItem that displays an uneditable value.

  • Constructor Details

    • StaticTextItem

      public StaticTextItem()

    • StaticTextItem

      public StaticTextItem(JavaScriptObject jsObj)

    • StaticTextItem

      public StaticTextItem(String name)

    • StaticTextItem

      public StaticTextItem(String name, String title)

  • Method Details

    • getOrCreateRef

      public static StaticTextItem 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)

    • setApplyAlignToText

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

      Note : This is an advanced setting

      Overrides:
      setApplyAlignToText in class FormItem
      Parameters:
      applyAlignToText - New applyAlignToText value. Default value is true
      Returns:
      StaticTextItem 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 StaticTextItem's textAlign?
      Overrides:
      getApplyAlignToText in class FormItem
      Returns:
      Current applyAlignToText value. Default value is true
      See Also:

    • setApplyHeightToTextBox

      public StaticTextItem setApplyHeightToTextBox(Boolean applyHeightToTextBox)
      If FormItem.height is specified, should it be applied to the item's text box element?

      Overridden to be false for StaticTextItems by default.

      See shouldApplyHeightToTextBox() for more information.

      Note : This is an advanced setting

      Overrides:
      setApplyHeightToTextBox in class FormItem
      Parameters:
      applyHeightToTextBox - New applyHeightToTextBox value. Default value is false
      Returns:
      StaticTextItem instance, for chaining setter calls

    • getApplyHeightToTextBox

      public Boolean getApplyHeightToTextBox()
      If FormItem.height is specified, should it be applied to the item's text box element?

      Overridden to be false for StaticTextItems by default.

      See shouldApplyHeightToTextBox() for more information.

      Overrides:
      getApplyHeightToTextBox in class FormItem
      Returns:
      Current applyHeightToTextBox value. Default value is false

    • setCanSelectText

      public StaticTextItem 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:
      StaticTextItem 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

    • setClipValue

      public StaticTextItem setClipValue(Boolean clipValue)
      If true, text that exceeds the specified size of the form item will be clipped. Note that for horizontal clipping to occur, wrap should be set to false - otherwise the text will typically wrap at the specified width. For vertical clipping to occur, applyHeightToTextBox should be explicitly set to true as the Text Box element is responsible for clipping the content.
      Parameters:
      clipValue - New clipValue value. Default value is false
      Returns:
      StaticTextItem instance, for chaining setter calls
      See Also:

    • getClipValue

      public Boolean getClipValue()
      If true, text that exceeds the specified size of the form item will be clipped. Note that for horizontal clipping to occur, wrap should be set to false - otherwise the text will typically wrap at the specified width. For vertical clipping to occur, applyHeightToTextBox should be explicitly set to true as the Text Box element is responsible for clipping the content.
      Returns:
      Current clipValue value. Default value is false
      See Also:

    • setDateFormatter

      public StaticTextItem setDateFormatter(DateDisplayFormat dateFormatter)
      Display format to use for date type values within this formItem.

      Note that Fields of type "date", "datetime" or "time" will be edited using a DateItem or TimeItem by default, but this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a custom FormItem.editorType as well as data type.

      The FormItem.timeFormatter may also be used to format underlying Date values as times (ommitting the date part entirely). If both dateFormatter and timeFormatter are specified on an item, for fields specified as type "time" the timeFormatter will be used, otherwise the dateFormatter

      If item.dateFormatter and item.timeFormatter is unspecified, date display format may be defined at the component level via DynamicForm.dateFormatter, or for fields of type "datetime" DynamicForm.datetimeFormatter. Otherwise for fields of type "date", default is to use the system-wide default short date format, configured via DateUtil.setShortDisplayFormat(). For fields of type "datetime" or for Date values in fields whose type does not inherit from the logical "date" type, default is to use the system-wide normal date format configured via DateUtil.setNormalDisplayFormat() (using "toNormalDate()" on logical "date" type fields is not desirable as this would display the time component of the date object to the user).
      Specify any valid DateDisplayFormat to change the format used by this item.

      Note : This is an advanced setting

      Overrides:
      setDateFormatter in class FormItem
      Parameters:
      dateFormatter - New dateFormatter value. Default value is null
      Returns:
      StaticTextItem instance, for chaining setter calls
      See Also:

    • getDateFormatter

      public DateDisplayFormat getDateFormatter()
      Display format to use for date type values within this formItem.

      Note that Fields of type "date", "datetime" or "time" will be edited using a DateItem or TimeItem by default, but this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a custom FormItem.editorType as well as data type.

      The FormItem.timeFormatter may also be used to format underlying Date values as times (ommitting the date part entirely). If both dateFormatter and timeFormatter are specified on an item, for fields specified as type "time" the timeFormatter will be used, otherwise the dateFormatter

      If item.dateFormatter and item.timeFormatter is unspecified, date display format may be defined at the component level via DynamicForm.dateFormatter, or for fields of type "datetime" DynamicForm.datetimeFormatter. Otherwise for fields of type "date", default is to use the system-wide default short date format, configured via DateUtil.setShortDisplayFormat(). For fields of type "datetime" or for Date values in fields whose type does not inherit from the logical "date" type, default is to use the system-wide normal date format configured via DateUtil.setNormalDisplayFormat() (using "toNormalDate()" on logical "date" type fields is not desirable as this would display the time component of the date object to the user).
      Specify any valid DateDisplayFormat to change the format used by this item.

      Overrides:
      getDateFormatter in class FormItem
      Returns:
      Current dateFormatter value. Default value is null
      See Also:

    • getDefaultValue

      public String getDefaultValue()
      Overridden to assign class-appropriate type.
      Overrides:
      getDefaultValue in class FormItem
      Returns:
      Current defaultValue value. Default value is null
      See Also:

    • setEditProxyConstructor

      public StaticTextItem 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:
      StaticTextItem 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:

    • setEscapeHTML

      public StaticTextItem setEscapeHTML(Boolean escapeHTML)
      By default HTML values in a staticTextItem will be interpreted by the browser. Setting this flag to true causes HTML characters to be escaped, meaning the raw value of the field (for example "<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example "AAA")
      Overrides:
      setEscapeHTML in class FormItem
      Parameters:
      escapeHTML - New escapeHTML value. Default value is false
      Returns:
      StaticTextItem instance, for chaining setter calls
      See Also:

    • getEscapeHTML

      public Boolean getEscapeHTML()
      By default HTML values in a staticTextItem will be interpreted by the browser. Setting this flag to true causes HTML characters to be escaped, meaning the raw value of the field (for example "<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example "AAA")
      Overrides:
      getEscapeHTML in class FormItem
      Returns:
      Current escapeHTML value. Default value is false
      See Also:

    • setTextBoxStyle

      public StaticTextItem setTextBoxStyle(String textBoxStyle)
      Base CSS class for this item
      Overrides:
      setTextBoxStyle in class FormItem
      Parameters:
      textBoxStyle - New textBoxStyle value. Default value is "staticTextItem"
      Returns:
      StaticTextItem 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 "staticTextItem"
      See Also:

    • setWrap

      public StaticTextItem setWrap(Boolean wrap)
      If true, item contents can wrap. If false, all the contents should appear on a single line.
      Parameters:
      wrap - New wrap value. Default value is true
      Returns:
      StaticTextItem instance, for chaining setter calls
      See Also:

    • getWrap

      public Boolean getWrap()
      If true, item contents can wrap. If false, all the contents should appear on a single line.
      Returns:
      Current wrap value. Default value is true
      See Also:

    • setDefaultProperties

      public static void setDefaultProperties(StaticTextItem staticTextItemProperties)
      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:
      staticTextItemProperties - properties that should be used as new defaults when instances of this class are created
      See Also: