com.whitestein.lsps.vaadin.ui

Interface UIComponentWithHints2

All Superinterfaces:

Serializable, UIComponent

All Known Implementing Classes:

UICartesianChart, UICheckBoxList, UIComboBox, UIDateTextBox, UIFileUpload, UIGaugeChart, UIGenericChart, UIGrid, UIGridColumn, UIGroupingTable, UIHorizontalLayout, UILazyTable, UIMultiSelectList, UINavigationLink, UIPagedTable, UIPanel, UIPieChart, UIPolarChart, UIPopup, UIRadioButtonList, UIRichTextArea, UISimpleTable, UISingleSelectList, UITabbedLayout, UITableBase, UITableColumn, UITextArea, UITextBox, UITreeTable2

public interface UIComponentWithHints2
extends UIComponent

Defines interface for components which support custom hints. Hints are applied after UIComponent.refresh().

Author:

mvy

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.

Methods inherited from interface com.whitestein.lsps.vaadin.ui.components.UIComponent

getComponentData, getWidget, refresh

Method Detail

applyHint

boolean applyHint(String hintName,
                  Variant<Object> newValue,
                  Variant<Object> oldValue)

Applies the given hint to this component.

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

boolean unapplyHint(String hintName,
                    Variant<Object> oldValue)

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.