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

Class BlurbItem

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.BlurbItem
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 BlurbItem extends FormItem
FormItem intended for inserting blurbs of instructional HTML into DynamicForms.

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

  • Constructor Details

    • BlurbItem

      public BlurbItem()

    • BlurbItem

      public BlurbItem(JavaScriptObject jsObj)

    • BlurbItem

      public BlurbItem(String name)

  • Method Details

    • getOrCreateRef

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

    • setCanSelectText

      public BlurbItem 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:
      BlurbItem 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 BlurbItem setClipValue(Boolean clipValue)
      If true, text that exceeds the specified size of the form item will be clipped.
      Parameters:
      clipValue - New clipValue value. Default value is false
      Returns:
      BlurbItem 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.
      Returns:
      Current clipValue value. Default value is false
      See Also:

    • setColSpan

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

    • getColSpan

      public int getColSpan()
      By default, texts 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 BlurbItem setColSpan(String colSpan)
      By default, texts span all remaining columns
      Overrides:
      setColSpan in class FormItem
      Parameters:
      colSpan - New colSpan value. Default value is "*"
      Returns:
      BlurbItem instance, for chaining setter calls
      See Also:

    • getColSpanAsString

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

    • setEditProxyConstructor

      public BlurbItem 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 "BlurbItemEditProxy"
      Returns:
      BlurbItem 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 "BlurbItemEditProxy"
      See Also:

    • setShowTitle

      public BlurbItem setShowTitle(Boolean showTitle)
      Blurb items show no title by default.
      Overrides:
      setShowTitle in class FormItem
      Parameters:
      showTitle - New showTitle value. Default value is false
      Returns:
      BlurbItem instance, for chaining setter calls
      See Also:

    • getShowTitle

      public Boolean getShowTitle()
      Blurb items show no title by default.
      Overrides:
      getShowTitle in class FormItem
      Returns:
      Current showTitle value. Default value is false
      See Also:

    • setTextBoxStyle

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

    • getTextBoxStyle

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

    • setWrap

      public BlurbItem 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 null
      Returns:
      BlurbItem 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 null
      See Also:

    • setDefaultProperties

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