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

Class ColorItem

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.TextItem
com.smartgwt.client.widgets.form.fields.ColorItem
All Implemented Interfaces:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPendingStatusChangedHandlers, HasPickerColorSelectedHandlers, HasPickerIconClickHandlers, HasShowContextMenuHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers, HasValueIconClickHandlers
Direct Known Subclasses:
ColorPickerItem
public class ColorItem extends TextItem implements HasPickerColorSelectedHandlers
Form item for selecting a color via a pop-up ColorPicker.

  • Constructor Details

    • ColorItem

      public ColorItem()

    • ColorItem

      public ColorItem(JavaScriptObject jsObj)

    • ColorItem

      public ColorItem(String name)

    • ColorItem

      public ColorItem(String name, String title)

  • Method Details

    • getOrCreateRef

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

    • setAllowComplexMode

      public ColorItem setAllowComplexMode(Boolean allowComplexMode)
      Should "complex" mode be allowed for the ColorPicker window associated with this ColorItem?

      If false, no "More" button is shown on the simple picker

      Parameters:
      allowComplexMode - New allowComplexMode value. Default value is true
      Returns:
      ColorItem instance, for chaining setter calls

    • getAllowComplexMode

      public Boolean getAllowComplexMode()
      Should "complex" mode be allowed for the ColorPicker window associated with this ColorItem?

      If false, no "More" button is shown on the simple picker

      Returns:
      Current allowComplexMode value. Default value is true

    • setDefaultPickerMode

      public ColorItem setDefaultPickerMode(ColorPickerMode defaultPickerMode)
      The defaultPickMode for the ColorPicker associated with this ColorItem.
      Parameters:
      defaultPickerMode - New defaultPickerMode value. Default value is "simple"
      Returns:
      ColorItem instance, for chaining setter calls
      See Also:

    • getDefaultPickerMode

      public ColorPickerMode getDefaultPickerMode()
      The defaultPickMode for the ColorPicker associated with this ColorItem.
      Returns:
      Current defaultPickerMode value. Default value is "simple"
      See Also:

    • setPickerIconHeight

      public ColorItem setPickerIconHeight(Integer pickerIconHeight)
      If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.

      Note that if spriting is being used, and the image to be displayed is specified using css properties such as background-image, background-size, changing this value may result in an unexpected appearance as the image will not scale.
      Scaleable spriting can be achieved using the SCSpriteConfig format. See the section on spriting in the skinning overview for further information.

      Overrides:
      setPickerIconHeight in class FormItem
      Parameters:
      pickerIconHeight - New pickerIconHeight value. Default value is 18
      Returns:
      ColorItem instance, for chaining setter calls

    • getPickerIconHeight

      public Integer getPickerIconHeight()
      If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.

      Note that if spriting is being used, and the image to be displayed is specified using css properties such as background-image, background-size, changing this value may result in an unexpected appearance as the image will not scale.
      Scaleable spriting can be achieved using the SCSpriteConfig format. See the section on spriting in the skinning overview for further information.

      Overrides:
      getPickerIconHeight in class FormItem
      Returns:
      Current pickerIconHeight value. Default value is 18

    • setPickerIconPrompt

      public ColorItem setPickerIconPrompt(String pickerIconPrompt)
      Prompt to show when the user hovers the mouse over the picker icon.
      Overrides:
      setPickerIconPrompt in class FormItem
      Parameters:
      pickerIconPrompt - New pickerIconPrompt value. Default value is "Click to select a new color"
      Returns:
      ColorItem instance, for chaining setter calls
      See Also:

    • getPickerIconPrompt

      public String getPickerIconPrompt()
      Prompt to show when the user hovers the mouse over the picker icon.
      Overrides:
      getPickerIconPrompt in class FormItem
      Returns:
      Current pickerIconPrompt value. Default value is "Click to select a new color"
      See Also:

    • setPickerIconSrc

      public ColorItem setPickerIconSrc(String pickerIconSrc)
      If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.

      Spriting can be used for this image, by setting this property to a SCSpriteConfig formatted string.

      Overrides:
      setPickerIconSrc in class FormItem
      Parameters:
      pickerIconSrc - New pickerIconSrc value. Default value is "[SKIN]/DynamicForm/ColorPicker_icon.png"
      Returns:
      ColorItem instance, for chaining setter calls
      See Also:

    • getPickerIconSrc

      public String getPickerIconSrc()
      If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.

      Spriting can be used for this image, by setting this property to a SCSpriteConfig formatted string.

      Overrides:
      getPickerIconSrc in class FormItem
      Returns:
      Current pickerIconSrc value. Default value is "[SKIN]/DynamicForm/ColorPicker_icon.png"
      See Also:

    • setPickerIconWidth

      public ColorItem setPickerIconWidth(Integer pickerIconWidth)
      If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.

      Note that if spriting is being used, and the image to be displayed is specified using css properties such as background-image, background-size, changing this value may result in an unexpected appearance as the image will not scale.
      Scaleable spriting can be achieved using the SCSpriteConfig format. See the section on spriting in the skinning overview for further information.

      Overrides:
      setPickerIconWidth in class FormItem
      Parameters:
      pickerIconWidth - New pickerIconWidth value. Default value is 18
      Returns:
      ColorItem instance, for chaining setter calls

    • getPickerIconWidth

      public Integer getPickerIconWidth()
      If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.

      Note that if spriting is being used, and the image to be displayed is specified using css properties such as background-image, background-size, changing this value may result in an unexpected appearance as the image will not scale.
      Scaleable spriting can be achieved using the SCSpriteConfig format. See the section on spriting in the skinning overview for further information.

      Overrides:
      getPickerIconWidth in class FormItem
      Returns:
      Current pickerIconWidth value. Default value is 18

    • setShowPickerIcon

      public ColorItem setShowPickerIcon(Boolean showPickerIcon)
      Should the pick button icon be shown for choosing colors from a ColorPicker
      Overrides:
      setShowPickerIcon in class FormItem
      Parameters:
      showPickerIcon - New showPickerIcon value. Default value is true
      Returns:
      ColorItem instance, for chaining setter calls

    • getShowPickerIcon

      public Boolean getShowPickerIcon()
      Should the pick button icon be shown for choosing colors from a ColorPicker
      Overrides:
      getShowPickerIcon in class FormItem
      Returns:
      Current showPickerIcon value. Default value is true

    • setSupportsTransparency

      public ColorItem setSupportsTransparency(Boolean supportsTransparency)
      Determines whether the ColorPicker associated with this ColorItem allows the user to set transparency/opacity information whilst selecting a color. If false, no opacity slider is shown and all colors are 100% opaque.

      When an opacity value is selected, the HTML color string produced is 8 characters long because the opacity setting is included. You can also capture the the separate color and opacity information by overriding ColorItem.pickerColorSelected().

      Parameters:
      supportsTransparency - New supportsTransparency value. Default value is true
      Returns:
      ColorItem instance, for chaining setter calls

    • getSupportsTransparency

      public Boolean getSupportsTransparency()
      Determines whether the ColorPicker associated with this ColorItem allows the user to set transparency/opacity information whilst selecting a color. If false, no opacity slider is shown and all colors are 100% opaque.

      When an opacity value is selected, the HTML color string produced is 8 characters long because the opacity setting is included. You can also capture the the separate color and opacity information by overriding ColorItem.pickerColorSelected().

      Returns:
      Current supportsTransparency value. Default value is true

    • addPickerColorSelectedHandler

      public HandlerRegistration addPickerColorSelectedHandler(PickerColorSelectedHandler handler)
      Add a pickerColorSelected handler.

      Store the color value selected by the user from the color picker. You will need to override this method if you wish to capture opacity information from the ColorPicker.

      Specified by:
      addPickerColorSelectedHandler in interface HasPickerColorSelectedHandlers
      Parameters:
      handler - the pickerColorSelected handler
      Returns:
      HandlerRegistration used to remove this handler

    • setDefaultProperties

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