com.smartgwt.client.docs

Interface Hiliting

public interface Hiliting

Hiliting

Hiliting means special visual styling which is applied to specific data values that meet certain criteria.

A Hilite definition contains styling information such as Hilite.cssText and Hilite.htmlBefore that define what the hilite looks like, as well as properties defining where the hilite is applied. If you create hilites manually, they should ideally specify textColor and/or backgroundColor in order to be editable in a HiliteEditor. If these are not provided, however, note that they will be manufactured automatically from the cssText attribute if it is present.

A hilite can be applied to data either by defining criteria or by explicitly including markers on the data itself.

Hiliting rules such as hiliting different ranges of values with different colors can be accomplished entirely client-side by defining AdvancedCriteria in hilite definitions that pick out values to be highlighted.

Hiliting rules that require server-side calculations can be achieved by assigning a Hilite.id to a hilite definition, and setting the DataBoundComponent.hiliteProperty on the records that should show that highlight. This can be used, for example, to hilite the record with the maximum value for a dataset that the application will load incrementally.

See Also:

HiliteIconPosition, CubeGrid.hiliteCell(int, int, java.lang.String), com.smartgwt.client.widgets.cube.CubeGrid#hiliteCellList, CubeGrid.hiliteFacetValue(java.lang.String, java.lang.String, java.lang.String), HilitesChangedEvent, Hilite, CubeGrid.getHilites(), Hilite.getId(), Hilite.getCssText(), Hilite.getFieldName(), Hilite.getCriteria(), Hilite.getHtmlBefore(), Hilite.getHtmlAfter(), Hilite.getHtmlValue(), Hilite.getDisabled(), Hilite.getCanEdit(), Hilite.getTitle(), Hilite.getTextColor(), Hilite.getBackgroundColor(), Hilite.getIcon(), Hilite.getReplacementValue(), DetailViewer.getHiliteIcons(), DetailViewer.getHiliteIconPosition(), DetailViewer.getHiliteIconSize(), DetailViewer.getHiliteIconWidth(), DetailViewer.getHiliteIconHeight(), DetailViewer.getHiliteIconLeftPadding(), DetailViewer.getHiliteIconRightPadding(), DetailViewerField.getCanHilite(), DetailViewerField.getHiliteIconPosition(), DetailViewerField.getHiliteIconSize(), DetailViewerField.getHiliteIconWidth(), DetailViewerField.getHiliteIconHeight(), DetailViewerField.getHiliteIconLeftPadding(), DetailViewerField.getHiliteIconRightPadding(), ListGrid.getHiliteIcons(), ListGrid.getHiliteIconPosition(), ListGrid.getHiliteIconSize(), ListGrid.getHiliteIconWidth(), ListGrid.getHiliteIconHeight(), ListGrid.getHiliteIconLeftPadding(), ListGrid.getHiliteIconRightPadding(), ListGridField.getHiliteIconPosition(), ListGridField.getHiliteIconSize(), ListGridField.getHiliteIconWidth(), ListGridField.getHiliteIconHeight(), ListGridField.getHiliteIconLeftPadding(), ListGridField.getHiliteIconRightPadding(), ListGrid.getHiliteCanReplaceValue(), ListGrid.getCanEditHilites()