com.vaadin.flow.dom.
Interface Style
All Superinterfaces:
All Known Implementing Classes:
Provides inline styles for Element
s.
Since:
1.0
Author:
Vaadin Ltd
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
static enum
Css values for the clear property.
static enum
static enum
Css values for the float property.
static enum
static enum
Css values for the position property.
static enum
Css values for the text-align property.
static enum
Css values for the visibility property.
static enum
Css values for the white-space property.
-
Method Summary
Modifier and TypeMethodDescriptionclear()
Removes all set style properties.
Gets the value of the given style property.
getNames()
Gets the defined style property names.
boolean
Checks if the given style property has been set.
Removes the given style property if it has been set.
Sets the given style property to the given value.
default Style
setBackground
(String value) Sets the
background
property.default Style
Sets the
border
property.default Style
Sets the
bottom
property.default Style
setBoxShadow
(String value) Sets the
box-shadow
property.default Style
setBoxSizing
(Style.BoxSizing value) Sets the
box-sizing
property.default Style
setClear
(Style.Clear value) Sets the
clear
property.default Style
Sets the
color
property.default Style
Sets the
cursor
property.default Style
setDisplay
(Style.Display value) Sets the
display
property.default Style
setFloat
(Style.FloatCss value) Sets the
float
property.default Style
Sets the
font
property.default Style
Sets the
height
property.default Style
Sets the
left
property.default Style
Sets the
margin
property.default Style
setOpacity
(String value) Sets the
opacity
property.default Style
setOutline
(String value) Sets the
outline
property.default Style
setOverflow
(Style.Overflow value) Sets the
overflow
property.default Style
setPadding
(String value) Sets the
padding
property.default Style
setPosition
(Style.Position value) Sets the
position
property.default Style
Sets the
right
property.default Style
Sets the
scale
property.default Style
setTextAlign
(Style.TextAlign value) Sets the
text-align
property.default Style
setTextDecoration
(String value) Sets the
text-decoration
property.default Style
Sets the
top
property.default Style
setTransform
(String value) Sets the
transform
property.default Style
setTransition
(String value) Sets the
transition
property.default Style
setVisibility
(Style.Visibility value) Sets the
visibility
property.default Style
setWhiteSpace
(Style.WhiteSpace value) Sets the
white-space
property.default Style
Sets the
width
property.default Style
Sets the
z-index
property.
-
Method Details
-
get
Gets the value of the given style property.
Note that the name should be in camelCase and not dash-separated, i.e. use "fontFamily" and not "font-family"
Parameters:
name
- the style property name as camelCase, notnull
Returns:
the style property value, or
null
if the style property has not been set -
set
Sets the given style property to the given value.
Both camelCased (e.g.
fontFamily
) and dash-separated (e.g.font-family
versions are supported.Parameters:
name
- the style property name as camelCase, notnull
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
remove
Removes the given style property if it has been set.
Both camelCased (e.g.
fontFamily
) and dash-separated (e.g.font-family
versions are supported.Parameters:
name
- the style property name as camelCase, notnull
Returns:
this style instance
-
clear
Style clear()Removes all set style properties.
Returns:
this style instance
-
has
Checks if the given style property has been set.
Both camelCased (e.g.
fontFamily
) and dash-separated (e.g.font-family
versions are supported.Parameters:
name
- the style property name as camelCase, notnull
Returns:
true
if the style property has been set,false
otherwise -
getNames
Gets the defined style property names.
Note that this always returns the name as camelCased, e.g.
fontFamily
even if it has been set as dash-separated (font-family
).Returns:
a stream of defined style property names
-
setBackground
Sets the
background
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setBorder
Sets the
border
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setBoxSizing
Sets the
box-sizing
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setBoxShadow
Sets the
box-shadow
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setClear
Sets the
clear
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setCursor
Sets the
cursor
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setColor
Sets the
color
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setDisplay
Sets the
display
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setFloat
Sets the
float
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setFont
Sets the
font
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setHeight
Sets the
height
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setMargin
Sets the
margin
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setOutline
Sets the
outline
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setOpacity
Sets the
opacity
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setOverflow
Sets the
overflow
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setPadding
Sets the
padding
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setPosition
Sets the
position
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setScale
Sets the
scale
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setTextAlign
Sets the
text-align
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setTextDecoration
Sets the
text-decoration
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setTransform
Sets the
transform
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setTransition
Sets the
transition
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setVisibility
Sets the
visibility
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setWidth
Sets the
width
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setWhiteSpace
Sets the
white-space
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setLeft
Sets the
left
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setRight
Sets the
right
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setTop
Sets the
top
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setBottom
Sets the
bottom
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-
setZIndex
Sets the
z-index
property.Parameters:
value
- the style property value (ifnull
, the property will be removed)Returns:
this style instance
-