com.projetloki.genesis

Class Properties.Builder

java.lang.Object

com.projetloki.genesis.Properties.Builder

All Implemented Interfaces:

PropertiesOrBuilder

Enclosing class:

Properties

public static final class Properties.Builder
extends Object
implements PropertiesOrBuilder

A builder for creating sets of CSS properties. Contains methods that set a single properties from one or several Java values. For example, setLetterSpacingPx(int) sets the letter-spacing property to the given length expressed in pixels. Some methods are simply named set, because they expect a single parameter of type enum, and the name of the enum tells which property is being set. For example, set(TextAlignValue.CENTER) sets the value of the text-align property to 'center'. All these methods are called typesafe setters.

Typesafe setters will fail with an illegal argument exception if the given value is illegal according to the CSS specification. For example, passing -2 to the border-width setter will fail because it is specified that a border-width cannot be negative.

Some typesafe setters may set vendor-specific properties under the hood to fix browser compatibility issues. This behavior is undocumented and subject to change.

Typesafe setters won't allow you to set all existing CSS properties to all possible values. In some cases, you may have no other choice than calling set(String, String). This method does not perform any kind of verification (besides grammar check). It is recommended that you only call it if there is no typesafe setter that would do the job.

Note: as in CSS the order in which properties are set DOES matter sometimes. For example, setting the property margin after margin-top is different from setting the property margin-top after margin.

Author:

Clément Roux

Method Summary

Methods

Modifier and Type	Method and Description
Properties	build() Returns a newly-created property.
Properties.Builder	copyFrom(Properties properties) Copies all the properties from the given object to this builder.
Properties.Builder	copyFrom(String propertiesString) Copies all the properties from the given object to this builder.
Properties.Builder	set(BorderCollapseValue value)
Properties.Builder	set(BorderStyleValue value)
Properties.Builder	set(BorderStyleValue vValue, BorderStyleValue hValue)
Properties.Builder	set(BorderStyleValue topValue, BorderStyleValue rightValue, BorderStyleValue bottomValue, BorderStyleValue leftValue)
Properties.Builder	set(CaptionSideValue value)
Properties.Builder	set(ClearValue value)
Properties.Builder	set(CursorValue value)
Properties.Builder	set(DirectionValue value)
Properties.Builder	set(DisplayValue value)
Properties.Builder	set(EmptyCellsValue value)
Properties.Builder	set(FloatValue value)
Properties.Builder	set(FontStyleValue value)
Properties.Builder	set(FontVariantValue value)
Properties.Builder	set(FontWeightValue value)
Properties.Builder	set(ListStylePositionValue value)
Properties.Builder	set(ListStyleTypeValue value)
Properties.Builder	set(OutlineStyleValue value)
Properties.Builder	set(OverflowValue value)
Properties.Builder	set(PositionValue value)
Properties.Builder	set(String name, String value) Sets the property with the given name to the given value.
Properties.Builder	set(TableLayoutValue value)
Properties.Builder	set(TextAlignValue value)
Properties.Builder	set(TextDecorationValue value)
Properties.Builder	set(TextTransformValue value)
Properties.Builder	set(UnicodeBidiValue value)
Properties.Builder	set(VerticalAlignValue value)
Properties.Builder	set(VisibilityValue value)
Properties.Builder	set(WhiteSpaceValue value)
Properties.Builder	setAnimation(Animation... singles)
Properties.Builder	setAnimationPlayState(boolean running)
Properties.Builder	setAnimationTimingFunction(TimingFunction function)
Properties.Builder	setBackground(BackgroundLayer... layers)
Properties.Builder	setBackground(Color backgroundColor, BackgroundLayer... layers)
Properties.Builder	setBorder(int widthPx, Color color, BorderStyleValue style)
Properties.Builder	setBorderBottom(int widthPx, Color color, BorderStyleValue style)
Properties.Builder	setBorderBottomColor(Color color)
Properties.Builder	setBorderBottomLeftRadiusPx(int px)
Properties.Builder	setBorderBottomRightRadiusPx(int px)
Properties.Builder	setBorderBottomStyle(BorderStyleValue value)
Properties.Builder	setBorderBottomWidthPx(int px)
Properties.Builder	setBorderColor(Color color)
Properties.Builder	setBorderColor(Color vColor, Color hColor)
Properties.Builder	setBorderColor(Color topColor, Color rightColor, Color bottomColor, Color leftColor)
Properties.Builder	setBorderLeft(int widthPx, Color color, BorderStyleValue style)
Properties.Builder	setBorderLeftColor(Color color)
Properties.Builder	setBorderLeftStyle(BorderStyleValue value)
Properties.Builder	setBorderLeftWidthPx(int px)
Properties.Builder	setBorderRadiusPx(int px)
Properties.Builder	setBorderRight(int widthPx, Color color, BorderStyleValue style)
Properties.Builder	setBorderRightColor(Color color)
Properties.Builder	setBorderRightStyle(BorderStyleValue value)
Properties.Builder	setBorderRightWidthPx(int px)
Properties.Builder	setBorderSpacingPx(int px)
Properties.Builder	setBorderTop(int widthPx, Color color, BorderStyleValue style)
Properties.Builder	setBorderTopColor(Color color)
Properties.Builder	setBorderTopLeftRadiusPx(int px)
Properties.Builder	setBorderTopRightRadiusPx(int px)
Properties.Builder	setBorderTopStyle(BorderStyleValue value)
Properties.Builder	setBorderTopWidthPx(int px)
Properties.Builder	setBorderWidthPx(int px)
Properties.Builder	setBorderWidthPx(int vPx, int hPx)
Properties.Builder	setBorderWidthPx(int topPx, int rightPx, int bottomPx, int leftPx)
Properties.Builder	setBottomPct(double pct)
Properties.Builder	setBottomPx(int px)
Properties.Builder	setBoxShadow(Shadow... shadows)
Properties.Builder	setColor(Color color)
Properties.Builder	setColumnCount(int columnCount)
Properties.Builder	setColumnGapPx(int px)
Properties.Builder	setColumnRule(int widthPx, Color color, BorderStyleValue style)
Properties.Builder	setColumnRuleColor(Color color)
Properties.Builder	setColumnRuleStyle(BorderStyleValue style)
Properties.Builder	setColumnRuleWidthPx(int px)
Properties.Builder	setColumnWidthPx(int px)
Properties.Builder	setFontFamily(FontFamilyFallback fallback, String... names)
Properties.Builder	setFontFamily(String... names)
Properties.Builder	setFontSizeEm(double em)
Properties.Builder	setFontSizePx(int px)
Properties.Builder	setHeightPct(double heightPct)
Properties.Builder	setHeightPx(int px)
Properties.Builder	setLeftPct(double pct)
Properties.Builder	setLeftPx(int px)
Properties.Builder	setLetterSpacingEm(double em)
Properties.Builder	setLetterSpacingPx(int px)
Properties.Builder	setLineHeightEm(double em)
Properties.Builder	setLineHeightPct(double pct)
Properties.Builder	setLineHeightPx(int px)
Properties.Builder	setListStyleImage(Image image)
Properties.Builder	setMarginBottomPct(double pct)
Properties.Builder	setMarginBottomPx(int px)
Properties.Builder	setMarginLeftPct(double pct)
Properties.Builder	setMarginLeftPx(int px)
Properties.Builder	setMarginPx(int px)
Properties.Builder	setMarginPx(int vPx, int hPx)
Properties.Builder	setMarginPx(int topPx, int rightPx, int bottomPx, int leftPx)
Properties.Builder	setMarginRightPct(double pct)
Properties.Builder	setMarginRightPx(int px)
Properties.Builder	setMarginTopPct(double pct)
Properties.Builder	setMarginTopPx(int px)
Properties.Builder	setMaxHeightPct(double pct)
Properties.Builder	setMaxHeightPx(int px)
Properties.Builder	setMaxWidthPct(double pct)
Properties.Builder	setMaxWidthPx(int px)
Properties.Builder	setMinHeightPct(double pct)
Properties.Builder	setMinHeightPx(int px)
Properties.Builder	setMinWidthPct(double pct)
Properties.Builder	setMinWidthPx(int px)
Properties.Builder	setOpacity(double opacity)
Properties.Builder	setOutline(int widthPx, Color color, OutlineStyleValue style)
Properties.Builder	setOutlineColor(Color color)
Properties.Builder	setOutlineWidthPx(int px)
Properties.Builder	setPaddingBottomPct(double pct)
Properties.Builder	setPaddingBottomPx(int px)
Properties.Builder	setPaddingLeftPct(double pct)
Properties.Builder	setPaddingLeftPx(int px)
Properties.Builder	setPaddingPx(int px)
Properties.Builder	setPaddingPx(int vPx, int hPx)
Properties.Builder	setPaddingPx(int topPx, int rightPx, int bottomPx, int leftPx)
Properties.Builder	setPaddingRightPct(double pct)
Properties.Builder	setPaddingRightPx(int px)
Properties.Builder	setPaddingTopPct(double pct)
Properties.Builder	setPaddingTopPx(int px)
Properties.Builder	setRightPct(double pct)
Properties.Builder	setRightPx(int px)
Properties.Builder	setTextIndentEm(double em)
Properties.Builder	setTextIndentPx(int px)
Properties.Builder	setTextShadow(Shadow... shadows)
Properties.Builder	setTopPct(double pct)
Properties.Builder	setTopPx(int px)
Properties.Builder	setTransform(TransformFunction... functions)
Properties.Builder	setTransformOriginPct(double xPct, double yPct)
Properties.Builder	setTransformOriginPctPx(double xPct, int yPx)
Properties.Builder	setTransformOriginPx(int xPx, int yPx)
Properties.Builder	setTransformOriginPxPct(int xPx, double yPct)
Properties.Builder	setTransition(Transition... singles)
Properties.Builder	setWidthPct(double pct)
Properties.Builder	setWidthPx(int px)
Properties.Builder	setWordSpacingEm(double em)
Properties.Builder	setWordSpacingPx(int px)
Properties.Builder	setZIndex(int zIndex)

Methods inherited from class java.lang.Object

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

Method Detail

copyFrom

public Properties.Builder copyFrom(Properties properties)

Copies all the properties from the given object to this builder.

Returns:

this builder for chaining

copyFrom

public Properties.Builder copyFrom(String propertiesString)

Copies all the properties from the given object to this builder.

Returns:

this builder for chaining

Throws:

IllegalArgumentException - if the input string is not a grammatically-correct sequence of semicolon-separated name:value CSS properties

set

public Properties.Builder set(String name,
                     String value)

Sets the property with the given name to the given value. Does not perform any kind of verification (besides grammar check).

It is recommended that you only call this method if there is no typesafe setter that would do the job.

Returns:

this builder for chaining

Throws:

IllegalArgumentException - if the given name is not a valid CSS identifier; if the given value is a grammatically-valid CSS expression

setBackground

public Properties.Builder setBackground(Color backgroundColor,
                               BackgroundLayer... layers)

setBackground

public Properties.Builder setBackground(BackgroundLayer... layers)

setListStyleImage

public Properties.Builder setListStyleImage(Image image)

setHeightPx

public Properties.Builder setHeightPx(int px)

setHeightPct

public Properties.Builder setHeightPct(double heightPct)

setWidthPx

public Properties.Builder setWidthPx(int px)

setWidthPct

public Properties.Builder setWidthPct(double pct)

setMinHeightPx

public Properties.Builder setMinHeightPx(int px)

setMinHeightPct

public Properties.Builder setMinHeightPct(double pct)

setMinWidthPx

public Properties.Builder setMinWidthPx(int px)

setMinWidthPct

public Properties.Builder setMinWidthPct(double pct)

setMaxHeightPx

public Properties.Builder setMaxHeightPx(int px)

setMaxHeightPct

public Properties.Builder setMaxHeightPct(double pct)

setMaxWidthPx

public Properties.Builder setMaxWidthPx(int px)

setMaxWidthPct

public Properties.Builder setMaxWidthPct(double pct)

setTopPx

public Properties.Builder setTopPx(int px)

setTopPct

public Properties.Builder setTopPct(double pct)

setRightPx

public Properties.Builder setRightPx(int px)

setRightPct

public Properties.Builder setRightPct(double pct)

setBottomPx

public Properties.Builder setBottomPx(int px)

setBottomPct

public Properties.Builder setBottomPct(double pct)

setLeftPx

public Properties.Builder setLeftPx(int px)

setLeftPct

public Properties.Builder setLeftPct(double pct)

setOutline

public Properties.Builder setOutline(int widthPx,
                            Color color,
                            OutlineStyleValue style)

setOutlineWidthPx

public Properties.Builder setOutlineWidthPx(int px)

setOutlineColor

public Properties.Builder setOutlineColor(Color color)

setColor

public Properties.Builder setColor(Color color)

setMarginPx

public Properties.Builder setMarginPx(int px)

setMarginPx

public Properties.Builder setMarginPx(int vPx,
                             int hPx)

setMarginPx

public Properties.Builder setMarginPx(int topPx,
                             int rightPx,
                             int bottomPx,
                             int leftPx)

setMarginTopPct

public Properties.Builder setMarginTopPct(double pct)

setMarginTopPx

public Properties.Builder setMarginTopPx(int px)

setMarginRightPct

public Properties.Builder setMarginRightPct(double pct)

setMarginRightPx

public Properties.Builder setMarginRightPx(int px)

setMarginBottomPct

public Properties.Builder setMarginBottomPct(double pct)

setMarginBottomPx

public Properties.Builder setMarginBottomPx(int px)

setMarginLeftPct

public Properties.Builder setMarginLeftPct(double pct)

setMarginLeftPx

public Properties.Builder setMarginLeftPx(int px)

setPaddingPx

public Properties.Builder setPaddingPx(int px)

setPaddingPx

public Properties.Builder setPaddingPx(int vPx,
                              int hPx)

setPaddingPx

public Properties.Builder setPaddingPx(int topPx,
                              int rightPx,
                              int bottomPx,
                              int leftPx)

setPaddingTopPx

public Properties.Builder setPaddingTopPx(int px)

setPaddingTopPct

public Properties.Builder setPaddingTopPct(double pct)

setPaddingRightPx

public Properties.Builder setPaddingRightPx(int px)

setPaddingRightPct

public Properties.Builder setPaddingRightPct(double pct)

setPaddingBottomPx

public Properties.Builder setPaddingBottomPx(int px)

setPaddingBottomPct

public Properties.Builder setPaddingBottomPct(double pct)

setPaddingLeftPx

public Properties.Builder setPaddingLeftPx(int px)

setPaddingLeftPct

public Properties.Builder setPaddingLeftPct(double pct)

setBorderWidthPx

public Properties.Builder setBorderWidthPx(int px)

setBorderWidthPx

public Properties.Builder setBorderWidthPx(int vPx,
                                  int hPx)

setBorderWidthPx

public Properties.Builder setBorderWidthPx(int topPx,
                                  int rightPx,
                                  int bottomPx,
                                  int leftPx)

setBorderTopWidthPx

public Properties.Builder setBorderTopWidthPx(int px)

setBorderRightWidthPx

public Properties.Builder setBorderRightWidthPx(int px)

setBorderBottomWidthPx

public Properties.Builder setBorderBottomWidthPx(int px)

setBorderLeftWidthPx

public Properties.Builder setBorderLeftWidthPx(int px)

setBorderColor

public Properties.Builder setBorderColor(Color color)

setBorderColor

public Properties.Builder setBorderColor(Color vColor,
                                Color hColor)

setBorderColor

public Properties.Builder setBorderColor(Color topColor,
                                Color rightColor,
                                Color bottomColor,
                                Color leftColor)

setBorderTopColor

public Properties.Builder setBorderTopColor(Color color)

setBorderRightColor

public Properties.Builder setBorderRightColor(Color color)

setBorderBottomColor

public Properties.Builder setBorderBottomColor(Color color)

setBorderLeftColor

public Properties.Builder setBorderLeftColor(Color color)

set

public Properties.Builder set(BorderStyleValue value)

set

public Properties.Builder set(BorderStyleValue vValue,
                     BorderStyleValue hValue)

set

public Properties.Builder set(BorderStyleValue topValue,
                     BorderStyleValue rightValue,
                     BorderStyleValue bottomValue,
                     BorderStyleValue leftValue)

setBorderTopStyle

public Properties.Builder setBorderTopStyle(BorderStyleValue value)

setBorderRightStyle

public Properties.Builder setBorderRightStyle(BorderStyleValue value)

setBorderBottomStyle

public Properties.Builder setBorderBottomStyle(BorderStyleValue value)

setBorderLeftStyle

public Properties.Builder setBorderLeftStyle(BorderStyleValue value)

setBorderTop

public Properties.Builder setBorderTop(int widthPx,
                              Color color,
                              BorderStyleValue style)

setBorderRight

public Properties.Builder setBorderRight(int widthPx,
                                Color color,
                                BorderStyleValue style)

setBorderBottom

public Properties.Builder setBorderBottom(int widthPx,
                                 Color color,
                                 BorderStyleValue style)

setBorderLeft

public Properties.Builder setBorderLeft(int widthPx,
                               Color color,
                               BorderStyleValue style)

setBorder

public Properties.Builder setBorder(int widthPx,
                           Color color,
                           BorderStyleValue style)

setBorderRadiusPx

public Properties.Builder setBorderRadiusPx(int px)

setBorderTopRightRadiusPx

public Properties.Builder setBorderTopRightRadiusPx(int px)

setBorderBottomRightRadiusPx

public Properties.Builder setBorderBottomRightRadiusPx(int px)

setBorderBottomLeftRadiusPx

public Properties.Builder setBorderBottomLeftRadiusPx(int px)

setBorderTopLeftRadiusPx

public Properties.Builder setBorderTopLeftRadiusPx(int px)

setBorderSpacingPx

public Properties.Builder setBorderSpacingPx(int px)

setFontFamily

public Properties.Builder setFontFamily(FontFamilyFallback fallback,
                               String... names)

setFontFamily

public Properties.Builder setFontFamily(String... names)

setFontSizePx

public Properties.Builder setFontSizePx(int px)

setFontSizeEm

public Properties.Builder setFontSizeEm(double em)

setLetterSpacingPx

public Properties.Builder setLetterSpacingPx(int px)

setLetterSpacingEm

public Properties.Builder setLetterSpacingEm(double em)

setWordSpacingPx

public Properties.Builder setWordSpacingPx(int px)

setWordSpacingEm

public Properties.Builder setWordSpacingEm(double em)

setLineHeightPx

public Properties.Builder setLineHeightPx(int px)

setLineHeightEm

public Properties.Builder setLineHeightEm(double em)

setLineHeightPct

public Properties.Builder setLineHeightPct(double pct)

setTextIndentPx

public Properties.Builder setTextIndentPx(int px)

setTextIndentEm

public Properties.Builder setTextIndentEm(double em)

setTextShadow

public Properties.Builder setTextShadow(Shadow... shadows)

setBoxShadow

public Properties.Builder setBoxShadow(Shadow... shadows)

setOpacity

public Properties.Builder setOpacity(double opacity)

setTransform

public Properties.Builder setTransform(TransformFunction... functions)

setTransformOriginPx

public Properties.Builder setTransformOriginPx(int xPx,
                                      int yPx)

setTransformOriginPxPct

public Properties.Builder setTransformOriginPxPct(int xPx,
                                         double yPct)

setTransformOriginPctPx

public Properties.Builder setTransformOriginPctPx(double xPct,
                                         int yPx)

setTransformOriginPct

public Properties.Builder setTransformOriginPct(double xPct,
                                       double yPct)

setColumnCount

@PoorBrowserSupport
public Properties.Builder setColumnCount(int columnCount)

setColumnGapPx

@PoorBrowserSupport
public Properties.Builder setColumnGapPx(int px)

setColumnRule

@PoorBrowserSupport
public Properties.Builder setColumnRule(int widthPx,
                                                  Color color,
                                                  BorderStyleValue style)

setColumnRuleWidthPx

@PoorBrowserSupport
public Properties.Builder setColumnRuleWidthPx(int px)

setColumnRuleColor

@PoorBrowserSupport
public Properties.Builder setColumnRuleColor(Color color)

setColumnRuleStyle

@PoorBrowserSupport
public Properties.Builder setColumnRuleStyle(BorderStyleValue style)

setColumnWidthPx

@PoorBrowserSupport
public Properties.Builder setColumnWidthPx(int px)

setTransition

@PoorBrowserSupport
public Properties.Builder setTransition(Transition... singles)

setAnimation

@PoorBrowserSupport
public Properties.Builder setAnimation(Animation... singles)

setAnimationTimingFunction

@PoorBrowserSupport
public Properties.Builder setAnimationTimingFunction(TimingFunction function)

setAnimationPlayState

@PoorBrowserSupport
public Properties.Builder setAnimationPlayState(boolean running)

setZIndex

public Properties.Builder setZIndex(int zIndex)

set

public Properties.Builder set(BorderCollapseValue value)

set

public Properties.Builder set(CaptionSideValue value)

set

public Properties.Builder set(ClearValue value)

set

public Properties.Builder set(CursorValue value)

set

public Properties.Builder set(DirectionValue value)

set

public Properties.Builder set(DisplayValue value)

set

public Properties.Builder set(EmptyCellsValue value)

set

public Properties.Builder set(FloatValue value)

set

public Properties.Builder set(FontStyleValue value)

set

public Properties.Builder set(FontVariantValue value)

set

public Properties.Builder set(FontWeightValue value)

set

public Properties.Builder set(ListStylePositionValue value)

set

public Properties.Builder set(ListStyleTypeValue value)

set

public Properties.Builder set(OutlineStyleValue value)

set

public Properties.Builder set(OverflowValue value)

set

public Properties.Builder set(PositionValue value)

set

public Properties.Builder set(VerticalAlignValue value)

set

public Properties.Builder set(TableLayoutValue value)

set

public Properties.Builder set(TextAlignValue value)

set

public Properties.Builder set(TextDecorationValue value)

set

public Properties.Builder set(TextTransformValue value)

set

public Properties.Builder set(UnicodeBidiValue value)

set

public Properties.Builder set(VisibilityValue value)

set

public Properties.Builder set(WhiteSpaceValue value)

build

public Properties build()

Returns a newly-created property.

Specified by:

build in interface PropertiesOrBuilder