com.haulmont.cuba.gui.components

Interface HtmlAttributes

public interface HtmlAttributes

Sets DOM and CSS attributes to UI component widgets.

See Also:

HtmlAttributes.CSS, HtmlAttributes.DOM

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HtmlAttributes.CSS Common CSS property names.
static class	HtmlAttributes.DOM Common DOM attribute names.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCssProperty(Component component, java.lang.String propertyName) Gets CSS property value assigned using HtmlAttributes.
java.lang.String	getDomAttribute(Component component, java.lang.String attributeName) Gets DOM attribute value assigned using HtmlAttributes.
void	removeCssProperty(Component component, java.lang.String propertyName) Clears CSS property value from the top most element of UI component.
void	removeDomAttribute(Component component, java.lang.String attributeName) Removes DOM attribute from the top most element of UI component.
void	setCssProperty(Component component, java.lang.String propertyName, java.lang.String value) Sets CSS property value on the top most element of UI component.
void	setDomAttribute(Component component, java.lang.String attributeName, java.lang.String value) Sets DOM attribute on the top most element of UI component.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setDomAttribute

void setDomAttribute(Component component,
                     java.lang.String attributeName,
                     java.lang.String value)

Sets DOM attribute on the top most element of UI component.

Parameters:

component - UI component

attributeName - DOM attribute name, e.g. "title"

value - attribute value

See Also:

HtmlAttributes.DOM

getDomAttribute

java.lang.String getDomAttribute(Component component,
                                 java.lang.String attributeName)

Gets DOM attribute value assigned using HtmlAttributes. Does not reflect a real value from DOM.

Parameters:

component - UI component

attributeName - DOM attribute name

Returns:

previously assigned DOM attribute value

removeDomAttribute

void removeDomAttribute(Component component,
                        java.lang.String attributeName)

Removes DOM attribute from the top most element of UI component.

Parameters:

component - UI component

attributeName - DOM attribute name

setCssProperty

void setCssProperty(Component component,
                    java.lang.String propertyName,
                    java.lang.String value)

Sets CSS property value on the top most element of UI component.

Parameters:

component - UI component

propertyName - CSS property name, e.g. "border-color"

value - property value

See Also:

HtmlAttributes.CSS

getCssProperty

java.lang.String getCssProperty(Component component,
                                java.lang.String propertyName)

Gets CSS property value assigned using HtmlAttributes. Does not reflect a real value from DOM.

Parameters:

component - UI component

propertyName - CSS property name

Returns:

previously assigned CSS property value

removeCssProperty

void removeCssProperty(Component component,
                       java.lang.String propertyName)

Clears CSS property value from the top most element of UI component.

Parameters:

component - UI component

propertyName - CSS property name