Package com.smartgwt.client.data

Class Hilite

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.data.Hilite
All Implemented Interfaces:
HasHandlers
public class Hilite extends RefDataClass
An object representing a user-created and user-modifiable hilite, which can be created and edited with a HiliteEditor either directly or via the ListGrid.canEditHilites behavior.

See Hiliting for an overview.

See Also:

  • Constructor Details

  • Method Details

    • getOrCreateRef

      public static Hilite getOrCreateRef(JavaScriptObject jsObj)

    • setBackgroundColor

      public Hilite setBackgroundColor(String backgroundColor)
      When edited via a HiliteEditor, the value for the background color of this hilite. If this is omitted, it will be automatically derived from the backgroundColor attribute of cssText. When a hilite is saved in a HiliteEditor, both attributes are set automatically.
      Parameters:
      backgroundColor - New backgroundColor value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getBackgroundColor

      public String getBackgroundColor()
      When edited via a HiliteEditor, the value for the background color of this hilite. If this is omitted, it will be automatically derived from the backgroundColor attribute of cssText. When a hilite is saved in a HiliteEditor, both attributes are set automatically.
      Returns:
      Current backgroundColor value. Default value is null
      See Also:

    • setCanEdit

      public Hilite setCanEdit(Boolean canEdit)
      Can highlight be edited from header context menu? Setting attribute to false prevents editing. A null or true value allows editing.
      Parameters:
      canEdit - New canEdit value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getCanEdit

      public Boolean getCanEdit()
      Can highlight be edited from header context menu? Setting attribute to false prevents editing. A null or true value allows editing.
      Returns:
      Current canEdit value. Default value is null
      See Also:

    • setCssText

      public Hilite setCssText(String cssText)
      CSS text to be applied to cells where this hilite is applied, for example, "background-color:#FF0000"
      Parameters:
      cssText - New cssText value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getCssText

      public String getCssText()
      CSS text to be applied to cells where this hilite is applied, for example, "background-color:#FF0000"
      Returns:
      Current cssText value. Default value is null
      See Also:

    • setDisabled

      public Hilite setDisabled(Boolean disabled)
      Whether this hilite is currently disabled.

      Hilites can be programmatically enabled and disabled via DataBoundComponent.enableHilite().

      Parameters:
      disabled - New disabled value. Default value is false
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getDisabled

      public Boolean getDisabled()
      Whether this hilite is currently disabled.

      Hilites can be programmatically enabled and disabled via DataBoundComponent.enableHilite().

      Returns:
      Current disabled value. Default value is false
      See Also:

    • setFieldName

      public Hilite setFieldName(String fieldName)
      Name of the field, or array of fieldNames, this hilite should be applied to.

      If unset, hilite is applied to every field of the record.

      Parameters:
      fieldName - New fieldName value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getFieldName

      public String getFieldName()
      Name of the field, or array of fieldNames, this hilite should be applied to.

      If unset, hilite is applied to every field of the record.

      Returns:
      Current fieldName value. Default value is null
      See Also:

    • setFieldName

      public Hilite setFieldName(String... fieldName)
      Name of the field, or array of fieldNames, this hilite should be applied to.

      If unset, hilite is applied to every field of the record.

      Parameters:
      fieldName - New fieldName value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getFieldNameAsStringArray

      public String[] getFieldNameAsStringArray()
      Name of the field, or array of fieldNames, this hilite should be applied to.

      If unset, hilite is applied to every field of the record.

      Returns:
      Current fieldName value. Default value is null
      See Also:

    • setHtmlAfter

      public Hilite setHtmlAfter(String htmlAfter)
      HTML to append to the end of cell values where this hilite is applied.
      Parameters:
      htmlAfter - New htmlAfter value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getHtmlAfter

      public String getHtmlAfter()
      HTML to append to the end of cell values where this hilite is applied.
      Returns:
      Current htmlAfter value. Default value is null
      See Also:

    • setHtmlBefore

      public Hilite setHtmlBefore(String htmlBefore)
      HTML to pre-pend to cell values where this hilite is applied.
      Parameters:
      htmlBefore - New htmlBefore value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getHtmlBefore

      public String getHtmlBefore()
      HTML to pre-pend to cell values where this hilite is applied.
      Returns:
      Current htmlBefore value. Default value is null
      See Also:

    • setHtmlValue

      public Hilite setHtmlValue(String htmlValue)
      Deprecated.
      htmlValue is deprecated in favor of replacementValue. Note that unlike replacementValue, this property does not respect disabled, and will be applied even if disabled is set to true
      Value to show in place of the actual value from the record, for a record that matches this hilite.

      This can be used to take ranges of numeric values and simplify them to "Low", "Medium", "High" or similar textual values, translate very small or very large values to "Outlier" or "Negligible", and similar use cases.

      Parameters:
      htmlValue - New htmlValue value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getHtmlValue

      public String getHtmlValue()
      Deprecated.
      htmlValue is deprecated in favor of replacementValue. Note that unlike replacementValue, this property does not respect disabled, and will be applied even if disabled is set to true
      Value to show in place of the actual value from the record, for a record that matches this hilite.

      This can be used to take ranges of numeric values and simplify them to "Low", "Medium", "High" or similar textual values, translate very small or very large values to "Outlier" or "Negligible", and similar use cases.

      Returns:
      Current htmlValue value. Default value is null
      See Also:

    • setIcon

      public Hilite setIcon(String icon)
      URL of an icon to show when this hilite is applied to a cell. Position of the icon is controlled by DataBoundComponent.hiliteIconPosition or ListGridField.hiliteIconPosition.
      Parameters:
      icon - New icon value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getIcon

      public String getIcon()
      URL of an icon to show when this hilite is applied to a cell. Position of the icon is controlled by DataBoundComponent.hiliteIconPosition or ListGridField.hiliteIconPosition.
      Returns:
      Current icon value. Default value is null
      See Also:

    • setId

      public Hilite setId(String id)
      Unique ID for this hilite definition.

      For hilites that include criteria this is not required.

      If you are explicitly marking records for hiliting, set DataBoundComponent.hiliteProperty on the record to this ID.

      Note that the ID must be a valid JavaScript identifier, and in particular, setting the ID to a number is not supported.

      Parameters:
      id - New id value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getId

      public String getId()
      Unique ID for this hilite definition.

      For hilites that include criteria this is not required.

      If you are explicitly marking records for hiliting, set DataBoundComponent.hiliteProperty on the record to this ID.

      Note that the ID must be a valid JavaScript identifier, and in particular, setting the ID to a number is not supported.

      Returns:
      Current id value. Default value is null
      See Also:

    • setReplacementValue

      public Hilite setReplacementValue(String replacementValue)
      HTML which replaces the cell's textual value where this hilite is applied.

      Note that sorting, filtering, etc behavior will still operate on the underlying value. For example, if there is a date field with the FilterEditor enabled, the default search interface will still offer date-range based filtering even if hilites have caused values to be displayed as text such as "current" or "past due".

      Parameters:
      replacementValue - New replacementValue value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getReplacementValue

      public String getReplacementValue()
      HTML which replaces the cell's textual value where this hilite is applied.

      Note that sorting, filtering, etc behavior will still operate on the underlying value. For example, if there is a date field with the FilterEditor enabled, the default search interface will still offer date-range based filtering even if hilites have caused values to be displayed as text such as "current" or "past due".

      Returns:
      Current replacementValue value. Default value is null
      See Also:

    • setTextColor

      public Hilite setTextColor(String textColor)
      When edited via a HiliteEditor, the value for the foreground color of this hilite. If this is omitted, it will be automatically derived from the textColor attribute of cssText. When a hilite is saved in a HiliteEditor, both attributes are set automatically.
      Parameters:
      textColor - New textColor value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getTextColor

      public String getTextColor()
      When edited via a HiliteEditor, the value for the foreground color of this hilite. If this is omitted, it will be automatically derived from the textColor attribute of cssText. When a hilite is saved in a HiliteEditor, both attributes are set automatically.
      Returns:
      Current textColor value. Default value is null
      See Also:

    • setTitle

      public Hilite setTitle(String title)
      User-visible title for this hilite. Used for interfaces such as menus that can enable or disable hilites.
      Parameters:
      title - New title value. Default value is null
      Returns:
      Hilite instance, for chaining setter calls
      See Also:

    • getTitle

      public String getTitle()
      User-visible title for this hilite. Used for interfaces such as menus that can enable or disable hilites.
      Returns:
      Current title value. Default value is null
      See Also:

    • setFieldNames

      public void setFieldNames(String... fieldNames)
      Name of the fields that hilite should be applied to.

      If unset, hilite is applied to every field of the record.

      Parameters:
      fieldNames - fieldNames Default value is null

    • setCriteria

      public void setCriteria(Criteria criteria)
      Criteria defining what records this hilite should apply to.
      Parameters:
      criteria - criteria Default value is null

    • getCriteria

      public Criteria getCriteria()
      Criteria defining what records this hilite should apply to.
      Returns:
      Criteria