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

Class NativeCheckboxItem

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.NativeCheckboxItem
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 NativeCheckboxItem extends FormItem
A checkbox for manipulating 2-valued fields based on the native checkbox element.

  • Constructor Details

    • NativeCheckboxItem

      public NativeCheckboxItem()

    • NativeCheckboxItem

      public NativeCheckboxItem(JavaScriptObject jsObj)

    • NativeCheckboxItem

      public NativeCheckboxItem(String name)

  • Method Details

    • getOrCreateRef

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

    • setShowLabel

      public NativeCheckboxItem setShowLabel(Boolean showLabel)
      Should we show the label text next to the checkbox item.
      Parameters:
      showLabel - New showLabel value. Default value is true
      Returns:
      NativeCheckboxItem instance, for chaining setter calls

    • getShowLabel

      public Boolean getShowLabel()
      Should we show the label text next to the checkbox item.
      Returns:
      Current showLabel value. Default value is true

    • setTextBoxStyle

      public NativeCheckboxItem setTextBoxStyle(String textBoxStyle)
      Base CSS class applied to this item's title text (rendered next to the checkbox element).
      Overrides:
      setTextBoxStyle in class FormItem
      Parameters:
      textBoxStyle - New textBoxStyle value. Default value is "labelAnchor"
      Returns:
      NativeCheckboxItem instance, for chaining setter calls
      See Also:

    • getTextBoxStyle

      public String getTextBoxStyle()
      Base CSS class applied to this item's title text (rendered next to the checkbox element).
      Overrides:
      getTextBoxStyle in class FormItem
      Returns:
      Current textBoxStyle value. Default value is "labelAnchor"
      See Also:

    • setDefaultProperties

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

    • getValueAsBoolean

      public Boolean getValueAsBoolean()
      Return the value tracked by this form item.
      Returns:
      value of this element