com.whitestein.lsps.vaadin.util

Class Hints

java.lang.Object

com.whitestein.lsps.vaadin.util.Hints

public class Hints
extends Object

Utility class for handling component presentation hints.

Author:

mhi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Hints.Size Queries/sets width/height of a Vaadin component.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDITIONAL_FORMATS Applies to UIDateTextBox - adds additional formats accepted by the date text box.
static String	ALIGN Constant for the 'align' hint.
static String	BREADCRUMBS Constant for the 'breadcrumbs' hint.
static String	CONFIG Constant for the 'config' hint used for advanced chart configuration.
static String	DISABLE_COLLAPSING Constant for the 'disable-collapsing' hint.
static String	EXPAND Constant for the 'expand' hint.
static String	FILE_UPLOAD_MIME Constant for the 'file-upload-mime' hint.
static String	HEADER_ALIGN Applies to UITableColumn and UIGridColumn - sets the column header alignment.
static String	HEIGHT Constant for the 'height' hint.
static String	HIDDEN Constant for the 'hidden' hint.
static String	HTML_CLASS Constant for the 'html-class' hint.
static String	ICON Constant for the 'icon' hint used for applying icons for various components.
static String	INITIAL_FOCUS Constant for the 'initial-focus' hint.
static String	INITIAL_PAGE_SIZE Constant for the 'initial-page-size' hint.
static String	LAYOUT Constant for the 'layout' hint.
static String	MARGIN Constant for the 'margin' hint used for applying margin to layout component.
static String	MAX_TEXT_SIZE Constant for the 'max-text-size' hint.
static String	NO_DATA_MESSAGE Constant for the 'no-data-message' hint.
static String	OPEN_IN_NEW_WINDOW Constant for the 'open-in-new-window' hint.
static String	PAGE_LENGTH Constant for the 'page-length' hint.
static String	RESIZABLE Constant for the 'resizable' hint.
static String	SIZE Constant for the 'size' hint.
static String	SPACING Constant for the 'spacing' hint used for applying spacing inside layout component.
static String	SUFFIX Constant for the 'suffix' hint.
static String	TAB_ORDER Constant for the 'tab-order' hint.
static String	WIDTH Constant for the 'width' hint.

Method Summary

Modifier and Type	Method and Description
static boolean	applyGenericHints(com.vaadin.ui.Component component, UIComponentData componentData, String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies generic hints to the component.
static void	applyHintsToChildrenWrapper(String hintName, Variant<Object> newValue, Variant<Object> oldValue, com.vaadin.ui.Component childrenWrapper) Applies hints to the children wrapper component.
static boolean	applyMarginSpacing(com.vaadin.ui.AbstractOrderedLayout component, String hintName, Variant<Object> newValue) Applies MARGIN and/or SPACING to the component.
static boolean	applySizeHints(com.vaadin.server.Sizeable component, String hintName, Variant<Object> newValue) Applies WIDTH or HEIGHT hint to the component.
static Variant.MapVariant<String,Object>	computeHints(UIComponent component) Runs the hint closure and returns its result.
static Variant.MapVariant<String,Object>	getCurrentHints(UIComponent component, Variant.MapVariant<String,Object> newHints)
static boolean	hasHints(UIComponent component) Checks whether the component has field.
static void	onUnsupportedHint(UIComponent component, String hintName) Handles 'unsupported hint' warnings.
static com.vaadin.ui.Alignment	parseAlignment(String alignment) Convert string alignment to vaadin alignment.
static boolean	unapplyGenericHint(com.vaadin.ui.Component component, UIComponentData componentData, String hintName, Variant<Object> oldValue) Inverse operation to applyGenericHints(com.vaadin.ui.Component, com.whitestein.lsps.vaadin.ui.UIComponentData, String, Variant, Variant) - unapplies (removes effect) of given hint.
static void	unapplyHintsToChildrenWrapper(String hintName, Variant<Object> oldValue, com.vaadin.ui.Component childrenWrapper) Unapplies hints to the children wrapper component.
static void	updateHints(UIComponent component) Runs the hint closure and updates all hints on the component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTML_CLASS

public static final String HTML_CLASS

Constant for the 'html-class' hint.

See Also:

Constant Field Values

WIDTH

public static final String WIDTH

Constant for the 'width' hint.

See Also:

Constant Field Values

RESIZABLE

public static final String RESIZABLE

Constant for the 'resizable' hint.

See Also:

Constant Field Values

HEIGHT

public static final String HEIGHT

Constant for the 'height' hint.

See Also:

Constant Field Values

EXPAND

public static final String EXPAND

Constant for the 'expand' hint.

See Also:

Constant Field Values

ALIGN

public static final String ALIGN

Constant for the 'align' hint.

See Also:

Constant Field Values

SIZE

public static final String SIZE

Constant for the 'size' hint.

See Also:

Constant Field Values

LAYOUT

public static final String LAYOUT

Constant for the 'layout' hint.

See Also:

Constant Field Values

MAX_TEXT_SIZE

public static final String MAX_TEXT_SIZE

Constant for the 'max-text-size' hint.

See Also:

Constant Field Values

INITIAL_PAGE_SIZE

public static final String INITIAL_PAGE_SIZE

Constant for the 'initial-page-size' hint.

See Also:

Constant Field Values

OPEN_IN_NEW_WINDOW

public static final String OPEN_IN_NEW_WINDOW

Constant for the 'open-in-new-window' hint.

See Also:

Constant Field Values

HIDDEN

public static final String HIDDEN

Constant for the 'hidden' hint.

See Also:

Constant Field Values

TAB_ORDER

public static final String TAB_ORDER

Constant for the 'tab-order' hint.

See Also:

Constant Field Values

INITIAL_FOCUS

public static final String INITIAL_FOCUS

Constant for the 'initial-focus' hint.

See Also:

Constant Field Values

FILE_UPLOAD_MIME

public static final String FILE_UPLOAD_MIME

Constant for the 'file-upload-mime' hint.

See Also:

Constant Field Values

CONFIG

public static final String CONFIG

Constant for the 'config' hint used for advanced chart configuration.

See Also:

Constant Field Values

MARGIN

public static final String MARGIN

Constant for the 'margin' hint used for applying margin to layout component.

See Also:

Constant Field Values

SPACING

public static final String SPACING

Constant for the 'spacing' hint used for applying spacing inside layout component.

See Also:

Constant Field Values

ICON

public static final String ICON

Constant for the 'icon' hint used for applying icons for various components.

See Also:

Constant Field Values

BREADCRUMBS

public static final String BREADCRUMBS

Constant for the 'breadcrumbs' hint. Applies to horizontal layout. Turns all UIActionLink components inside this layout into breadcrumbs.

See Also:

Constant Field Values

SUFFIX

public static final String SUFFIX

Constant for the 'suffix' hint. Applies themed suffix to UITextBox preserving layout.

See Also:

Constant Field Values

PAGE_LENGTH

public static final String PAGE_LENGTH

Constant for the 'page-length' hint. Applies to UIComboBox setting maximum number of items in dropdown list.

See Also:

Constant Field Values

DISABLE_COLLAPSING

public static final String DISABLE_COLLAPSING

Constant for the 'disable-collapsing' hint. Applies to UITableColumn, disables ability to collapse table column.

See Also:

Constant Field Values

ADDITIONAL_FORMATS

public static final String ADDITIONAL_FORMATS

Applies to UIDateTextBox - adds additional formats accepted by the date text box. Uses the Java SimpleDateFormat formatting.

See Also:

Constant Field Values

HEADER_ALIGN

public static final String HEADER_ALIGN

Applies to UITableColumn and UIGridColumn - sets the column header alignment.

See Also:

Constant Field Values

NO_DATA_MESSAGE

public static final String NO_DATA_MESSAGE

Constant for the 'no-data-message' hint.

See Also:

Constant Field Values

Method Detail

applySizeHints

public static boolean applySizeHints(com.vaadin.server.Sizeable component,
                                     String hintName,
                                     Variant<Object> newValue)

Applies WIDTH or HEIGHT hint to the component.

Parameters:

component - the component, not null

hintName - the hint name, not null.

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

Returns:

true if width or height hint was supplied, false if not.

applyGenericHints

public static boolean applyGenericHints(com.vaadin.ui.Component component,
                                        UIComponentData componentData,
                                        String hintName,
                                        Variant<Object> newValue,
                                        Variant<Object> oldValue)

Applies generic hints to the component. Supports "html-class", "width", "height", "tab-order" and "initial-focus".

Parameters:

component -

componentData -

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.

applyMarginSpacing

public static boolean applyMarginSpacing(com.vaadin.ui.AbstractOrderedLayout component,
                                         String hintName,
                                         Variant<Object> newValue)

Applies MARGIN and/or SPACING to the component.

Parameters:

component - the component, not null.

hintName - margin or spacing, not null.

newValue - the new value of the margin/spacing, not null.

Returns:

true if margin or spacing, false otherwise.

unapplyGenericHint

public static boolean unapplyGenericHint(com.vaadin.ui.Component component,
                                         UIComponentData componentData,
                                         String hintName,
                                         Variant<Object> oldValue)

Inverse operation to applyGenericHints(com.vaadin.ui.Component, com.whitestein.lsps.vaadin.ui.UIComponentData, String, Variant, Variant) - unapplies (removes effect) of given hint.

Parameters:

component - the component, not null.

componentData - the component data, not null.

hintName - the name of the hint (the key to the hint map), not null.

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:

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

parseAlignment

public static com.vaadin.ui.Alignment parseAlignment(String alignment)

Convert string alignment to vaadin alignment.

Parameters:

alignment -

Returns:

vaadin alignment

onUnsupportedHint

public static void onUnsupportedHint(UIComponent component,
                                     String hintName)

Handles 'unsupported hint' warnings.

Parameters:

component - the component with unsupported hint, not null.

hintName - the name of the hint (the key to the hint map), not null.

hasHints

public static boolean hasHints(UIComponent component)

Checks whether the component has field. Perhaps there may be some crazy weird custom component not extending ui::UIComponent?

Parameters:

component - the component, not null.

Returns:

true if the component has HINTS, false if not.

computeHints

public static Variant.MapVariant<String,Object> computeHints(UIComponent component)

Runs the hint closure and returns its result. Fails if the hints field is missing.

Parameters:

component - the component, not null.

Returns:

closure hits result

getCurrentHints

public static Variant.MapVariant<String,Object> getCurrentHints(UIComponent component,
                                                                Variant.MapVariant<String,Object> newHints)

Parameters:

component -

newHints -

Returns:

Hints applied to the component. If the component is not initialized, uses newHints definition type to create an empty hints map.

updateHints

public static void updateHints(UIComponent component)

Runs the hint closure and updates all hints on the component.

Parameters:

component - the component, not null.

applyHintsToChildrenWrapper

public static void applyHintsToChildrenWrapper(String hintName,
                                               Variant<Object> newValue,
                                               Variant<Object> oldValue,
                                               com.vaadin.ui.Component childrenWrapper)

Applies hints to the children wrapper component. Sometimes it is necessary to wrap children in a layout - this method can help in such case. Generally, this method catches changes to the following hints:

• HEIGHT: if specified, wrapper must match parent size and is therefore configured for 100% height. If not specified, wrapper must wrap contents and is therefore set to unspecified height

Parameters:

hintName - the name of the hint, not null.

newValue - new hint value

oldValue - old hint value

childrenWrapper - child of this component, contains model children of this component. Not null.

unapplyHintsToChildrenWrapper

public static void unapplyHintsToChildrenWrapper(String hintName,
                                                 Variant<Object> oldValue,
                                                 com.vaadin.ui.Component childrenWrapper)

Unapplies hints to the children wrapper component. See applyHintsToChildrenWrapper(String, Variant, Variant, Component) for details.

Parameters:

hintName - the name of the hint, not null.

oldValue - old hint value

childrenWrapper - child of this component, contains model children of this component. Not null.