Style (XMLmind XML Editor Java[tm] API)

java.lang.Object
- com.xmlmind.xmledit.styled.Style

All Implemented Interfaces:

Cloneable
```
public final class Style
extends Object
implements Cloneable
```
Set of style properties used by styled gadgets.
All int values are in screen pixels, that is, the display scaling is already taken into account.
Note that Style objects are generally shared by many very different gadgets. Changing the value of a style property of a Style object may lead to unexpected results.

See Also:

CSS2, CSS Backgrounds and Borders Module Level 3

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Style.BorderStyle` Supported values for CSS2 property border-style.
`static class`	`Style.Direction` Supported values for CSS3 property direction.
`static class`	`Style.TextAlign` Supported values for CSS2 property text-align.
`static class`	`Style.TextDecoration` Supported values for CSS2 property text-decoration.
`static class`	`Style.VerticalAlign` Supported values for CSS2 property vertical-align.
`static class`	`Style.WhiteSpace` Supported values for CSS2 property white-space.

Field Summary

Fields
Modifier and Type	Field and Description
`Color`	`backgroundColor` Same as CSS2 property background-color.
`BackgroundPaint`	`backgroundPaint` Same as CSS properties background-image, background-repeat, background-position.
`Color`	`borderBottomColor` Same as CSS2 property border-bottom-color.
`Style.BorderStyle`	`borderBottomStyle` Same as CSS2 property borders-bottom-style.
`Color`	`borderLeftColor` Same as CSS2 property border-left-color.
`Style.BorderStyle`	`borderLeftStyle` Same as CSS2 property border-left-style.
`BorderRadius`	`borderRadius` Same as CSS3 property border-radius.
`Color`	`borderRightColor` Same as CSS2 property border-right-color.
`Style.BorderStyle`	`borderRightStyle` Same as CSS2 property border-right-style.
`Color`	`borderTopColor` Same as CSS2 property border-top-color.
`Style.BorderStyle`	`borderTopStyle` Same as CSS2 property border-top-style.
`int`	`borderWidth` Same as CSS2 property border-width.
`Color`	`color` Same as CSS2 property color.
`Style.Direction`	`direction` Same as CSS3 direction.
`FontSpec`	`fontSpec` Same as CSS2 property font.
`double`	`lineHeight` Same as CSS2 property line-height.
`ListStyle`	`listStyle` Same as CSS2 property list-style.
`int`	`marginBottom` Same as CSS2 property margin-bottom.
`int`	`marginLeft` Same as CSS2 property margins-left.
`int`	`marginRight` Same as CSS2 property margin-right.
`int`	`marginTop` Same as CSS2 property margin-top.
`static double`	`NORMAL_LINE_HEIGHT` Value of "`line-height:normal`".
`int`	`paddingBottom` Same as CSS2 property padding-bottom.
`int`	`paddingLeft` Same as CSS2 property padding-left.
`int`	`paddingRight` Same as CSS2 property padding-right.
`int`	`paddingTop` Same as CSS2 property padding-top.
`Style.TextAlign`	`textAlign` Same as CSS2 property text-align.
`Style.TextDecoration`	`textDecoration` Same as CSS2 property text-decoration.
`int`	`textIndent` Same as CSS2 property text-indent.
`Style.VerticalAlign`	`verticalAlign` Same as CSS2 property vertical-align.
`Style.WhiteSpace`	`whiteSpace` Same as CSS2 property white-space.

Constructor Summary

Constructors
Constructor and Description

Style()
Constructs a Style with default values for all style properties.

Constructors
Constructor and Description
`Style()` Constructs a Style with default values for all style properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Style`	`copy()` Returns a shallow copy of this Style object.
`void`	`copyBox(Style other)` Copies all style properties related to the CSS box (margin, padding, border, background) from specified style.
`boolean`	`equals(Object other)`
`Style.TextAlign`	`getTextAlign()` Returns the actual text align `Style.TextAlign.LEFT`, `Style.TextAlign.RIGHT` or `Style.TextAlign.CENTER` to be used depending on the specified values of `textAlign` AND `direction`.
`boolean`	`hasBox()` Returns `true` if this style specifies a CSS box (margin, padding, border, background).
`int`	`hashCode()`
`boolean`	`hasVerticalBorderOrPadding()` Returns `true` if this style specifies a border and/or a vertical padding (border*, padding-top, padding-bottom).
`void`	`horizontalFlipBox()` Modify this style in order to make all left-hand properties related to the CSS box (margin, padding, border) become right-hand properties and the other way round.
`void`	`mergeBox(Style other)` Copy to this style all the style properties related to the CSS box (margin, padding, border, background) found in `other` which have not already been specified in this style.
`void`	`resetBox()` Resets all style properties related to the CSS box to default values (margin, padding, border, background).
`void`	`resetNonInherited()` Resets all non-inherited style properties to default values (verticalAlign, textDecoration, margin, padding, border, background).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - marginTop
```
public int marginTop
```
    Same as CSS2 property margin-top. Default value: 0 (px). margin* < 0 means AUTO.
  - marginRight
```
public int marginRight
```
    Same as CSS2 property margin-right. Default value: 0 (px). margin* < 0 means AUTO.
  - marginBottom
```
public int marginBottom
```
    Same as CSS2 property margin-bottom. Default value: 0 (px). margin* < 0 means AUTO.
  - marginLeft
```
public int marginLeft
```
    Same as CSS2 property margins-left. Default value: 0 (px). margin* < 0 means AUTO.
  - paddingTop
```
public int paddingTop
```
    Same as CSS2 property padding-top. Default value: 0 (px).
  - paddingRight
```
public int paddingRight
```
    Same as CSS2 property padding-right. Default value: 0 (px).
  - paddingBottom
```
public int paddingBottom
```
    Same as CSS2 property padding-bottom. Default value: 0 (px).
  - paddingLeft
```
public int paddingLeft
```
    Same as CSS2 property padding-left. Default value: 0 (px).
  - borderRadius
```
public BorderRadius borderRadius
```
    Same as CSS3 property border-radius. Default value: no border radius.
  - borderTopStyle
```
public Style.BorderStyle borderTopStyle
```
    Same as CSS2 property border-top-style. Default value: none.
  - borderRightStyle
```
public Style.BorderStyle borderRightStyle
```
    Same as CSS2 property border-right-style. Default value: none.
  - borderBottomStyle
```
public Style.BorderStyle borderBottomStyle
```
    Same as CSS2 property borders-bottom-style. Default value: none.
  - borderLeftStyle
```
public Style.BorderStyle borderLeftStyle
```
    Same as CSS2 property border-left-style. Default value: none.
  - borderWidth
```
public int borderWidth
```
    Same as CSS2 property border-width. Default value: 0 (px).
  - borderTopColor
```
public Color borderTopColor
```
    Same as CSS2 property border-top-color. Default value: same as color.
  - borderRightColor
```
public Color borderRightColor
```
    Same as CSS2 property border-right-color. Default value: same as color.
  - borderBottomColor
```
public Color borderBottomColor
```
    Same as CSS2 property border-bottom-color. Default value: same as color.
  - borderLeftColor
```
public Color borderLeftColor
```
    Same as CSS2 property border-left-color. Default value: same as color.
  - NORMAL_LINE_HEIGHT
```
public static final double NORMAL_LINE_HEIGHT
```
    Value of "line-height:normal".
    
    See Also:
    
    Constant Field Values
  - lineHeight
```
public double lineHeight
```
    Same as CSS2 property line-height. Default value: normal.
    Here lineHeight is a specification: Effective distance in pixels between 2 consecutive baselines = lineHeight*Normal distance between 2 consecutive lines.
    The normal lineHeight is between 1.0 to 1.2. XXE uses NORMAL_LINE_HEIGHT.
  - verticalAlign
```
public Style.VerticalAlign verticalAlign
```
    Same as CSS2 property vertical-align. Default value: baseline.
  - color
```
public Color color
```
    Same as CSS2 property color. Default value: black.
  - backgroundColor
```
public Color backgroundColor
```
    Same as CSS2 property background-color. Default value: null.
    backgroundColor==null means transparent. Other colors cannot be transparent.
  - backgroundPaint
```
public BackgroundPaint backgroundPaint
```
    Same as CSS properties background-image, background-repeat, background-position. Default value: null.
  - fontSpec
```
public FontSpec fontSpec
```
    Same as CSS2 property font. Default value: sans-serif 12pt.
  - textIndent
```
public int textIndent
```
    Same as CSS2 property text-indent. Default value: 0 (px).
  - textAlign
```
public Style.TextAlign textAlign
```
    Same as CSS2 property text-align. Default value: left.
  - direction
```
public Style.Direction direction
```
    Same as CSS3 direction. Default value: ltr.
  - textDecoration
```
public Style.TextDecoration textDecoration
```
    Same as CSS2 property text-decoration. Default value: none.
  - whiteSpace
```
public Style.WhiteSpace whiteSpace
```
    Same as CSS2 property white-space. Default value: normal.
  - listStyle
```
public ListStyle listStyle
```
    Same as CSS2 property list-style. Default value: null (if needed, implies: disc outside).
- Constructor Detail
  - Style
```
public Style()
```
    Constructs a Style with default values for all style properties.
- Method Detail
  - resetNonInherited
```
public void resetNonInherited()
```
    Resets all non-inherited style properties to default values (verticalAlign, textDecoration, margin*, padding*, border*, background*).
  - resetBox
```
public void resetBox()
```
    Resets all style properties related to the CSS box to default values (margin*, padding*, border*, background*).
  - getTextAlign
```
public Style.TextAlign getTextAlign()
```
    Returns the actual text align Style.TextAlign.LEFT, Style.TextAlign.RIGHT or Style.TextAlign.CENTER to be used depending on the specified values of textAlign AND direction.
    This is needed because start and end are not supported values for CSS property text-align.
  - horizontalFlipBox
```
public void horizontalFlipBox()
```
    Modify this style in order to make all left-hand properties related to the CSS box (margin, padding, border) become right-hand properties and the other way round.
    This is needed to correctly support direction==Direction.RTL because CSS Logical Properties like margin-inline-start, padding-inline-start, border-inline-end-style, etc, are not supported.
  - hasBox
```
public boolean hasBox()
```
    Returns true if this style specifies a CSS box (margin*, padding*, border*, background*). Returns false otherwise.
  - copyBox
```
public void copyBox(Style other)
```
    Copies all style properties related to the CSS box (margin*, padding*, border*, background*) from specified style.
  - mergeBox
```
public void mergeBox(Style other)
```
    Copy to this style all the style properties related to the CSS box (margin*, padding*, border*, background*) found in other which have not already been specified in this style.
  - hasVerticalBorderOrPadding
```
public boolean hasVerticalBorderOrPadding()
```
    Returns true if this style specifies a border and/or a vertical padding (border*, padding-top, padding-bottom). Returns false otherwise.
  - copy
```
public Style copy()
```
    Returns a shallow copy of this Style object.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Style

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

marginTop

marginRight

marginBottom

marginLeft

paddingTop

paddingRight

paddingBottom

paddingLeft

borderRadius

borderTopStyle

borderRightStyle

borderBottomStyle

borderLeftStyle

borderWidth

borderTopColor

borderRightColor

borderBottomColor

borderLeftColor

NORMAL_LINE_HEIGHT

lineHeight

verticalAlign

color

backgroundColor

backgroundPaint

fontSpec

textIndent

textAlign

direction

textDecoration

whiteSpace

listStyle

Constructor Detail

Style

Method Detail

resetNonInherited

resetBox

getTextAlign

horizontalFlipBox

hasBox

copyBox

mergeBox

hasVerticalBorderOrPadding

copy

equals

hashCode