org.pepstock.charba.client.utils

Class Utilities

java.lang.Object

org.pepstock.charba.client.utils.Utilities

public final class Utilities
extends Object

Sets of methods used as common utilities.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static String	CSS_BACKGROUND_COLOR_PROPERTY Constant for CSS property for IsColor.
static String	CSS_BACKGROUND_IMAGE_PROPERTY Constant for CSS property for Gradient.
static String	CSS_BACKGROUND_PROPERTY Constant for CSS property for Pattern.
static String	CSS_BACKGROUND_SIZE_PROPERTY Constant for CSS property for Gradient.
static String	CSS_BORDER_COLOR_PROPERTY Constant for CSS property for IsColor, for border.
static String	CSS_BORDER_IMAGE_PROPERTY Constant for CSS property for Gradient, for border.
static String	CSS_BORDER_PROPERTY Constant for CSS property for Pattern for border.
static String	CSS_FONT_PROPERTY Constant for CSS property for font.

Method Summary

Modifier and Type	Method and Description
static Style.Cursor	getCursorOfChart(IsChart chart) Returns the cursor currently set into chart.
static String	toCSSBackgroundProperty(FillStrokeStyle style, int width, int height) Returns a URL CSS property for the current content of a fill or stroke canvas style instance.
static String	toCSSBackgroundProperty(Gradient gradient) Returns the CSS syntax to represent the gradient. The dimension of canvas pattern image will be the dimension of pattern.
static String	toCSSBackgroundProperty(Image image) Returns a URL CSS property for the current content of an image instance.
static String	toCSSBackgroundProperty(ImageElement image) Returns a URL CSS property for the current content of an image element instance.
static String	toCSSBackgroundProperty(ImageResource image) Returns a URL CSS property for the current content of an image resource instance.
static String	toCSSBackgroundProperty(Pattern pattern) Returns the CSS syntax to represent the pattern. The dimension of canvas pattern image will be the dimension of pattern.
static String	toCSSBackgroundProperty(Pattern pattern, int squareSize) Returns the CSS syntax to represent the pattern. The dimension of canvas pattern image is unique then the image of pattern is a square.
static String	toCSSBackgroundProperty(Pattern pattern, int width, int height) Returns the CSS syntax to represent the pattern.
static String	toCSSBackgroundProperty(String dataUrl) Returns a URL CSS property for the data URL for the current content of the canvas element.
static String	toCSSBackgroundProperty(String dataUrl, Context2d.Repetition repetition) Returns a URL CSS property for the data URL for the current content of the canvas element.
static String	toCSSFontProperty(FontStyle style, int size, String family) Builds the font string (shorthand property of CSS font) to use in the canvas object. The format is [font-style] [font-variant] [font-weight] [font-size] [font-family]. See here CSS specification.
static ImageElement	toImageElement(Image image) Creates a image element by image widget that displays the image at a given URL.
static ImageElement	toImageElement(Image image, int width, int height) Creates a image element by image widget that displays the image at a given URL, forcing the size.
static ImageElement	toImageElement(ImageResource image) Creates a image element by image resource which provides access to image data at runtime.
static ImageElement	toImageElement(ImageResource image, int width, int height) Creates a image element by image resource which provides access to image data at runtime, forcing the size.
static ImageElement	toImageElement(String url) Creates a image element by a data URL which is a URI scheme that provides a way to in-line data in a document, and it's commonly used to embed images in HTML and CSS.
static ImageElement	toImageElement(String url, int width, int height) Creates a image element by a data URL which is a URI scheme that provides a way to in-line data in a document, and it's commonly used to embed images in HTML and CSS, forcing the size.

Methods inherited from class java.lang.Object

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

Field Detail

CSS_FONT_PROPERTY

public static final String CSS_FONT_PROPERTY

Constant for CSS property for font.

See Also:

Constant Field Values

CSS_BACKGROUND_PROPERTY

public static final String CSS_BACKGROUND_PROPERTY

Constant for CSS property for Pattern.

See Also:

Constant Field Values

CSS_BORDER_PROPERTY

public static final String CSS_BORDER_PROPERTY

Constant for CSS property for Pattern for border.

See Also:

Constant Field Values

CSS_BACKGROUND_IMAGE_PROPERTY

public static final String CSS_BACKGROUND_IMAGE_PROPERTY

Constant for CSS property for Gradient.

See Also:

Constant Field Values

CSS_BACKGROUND_SIZE_PROPERTY

public static final String CSS_BACKGROUND_SIZE_PROPERTY

Constant for CSS property for Gradient.

See Also:

Constant Field Values

CSS_BORDER_IMAGE_PROPERTY

public static final String CSS_BORDER_IMAGE_PROPERTY

Constant for CSS property for Gradient, for border.

See Also:

Constant Field Values

CSS_BACKGROUND_COLOR_PROPERTY

public static final String CSS_BACKGROUND_COLOR_PROPERTY

Constant for CSS property for IsColor.

See Also:

Constant Field Values

CSS_BORDER_COLOR_PROPERTY

public static final String CSS_BORDER_COLOR_PROPERTY

Constant for CSS property for IsColor, for border.

See Also:

Constant Field Values

Method Detail

toCSSFontProperty

public static String toCSSFontProperty(FontStyle style,
                                       int size,
                                       String family)

Builds the font string (shorthand property of CSS font) to use in the canvas object.
The format is [font-style] [font-variant] [font-weight] [font-size] [font-family].
See here CSS specification.

Parameters:

style - font style to use

size - font size

family - font family

Returns:

the font string to use in the canvas object.

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(Pattern pattern)

Returns the CSS syntax to represent the pattern.
The dimension of canvas pattern image will be the dimension of pattern.

Parameters:

pattern - object to export into CSS

Returns:

the CSS syntax to represent the pattern

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(Pattern pattern,
                                             int squareSize)

Returns the CSS syntax to represent the pattern.
The dimension of canvas pattern image is unique then the image of pattern is a square.

Parameters:

pattern - object to export into CSS

squareSize - size of image applied to canvasPattern to be a square

Returns:

the CSS syntax to represent the pattern

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(Pattern pattern,
                                             int width,
                                             int height)

Returns the CSS syntax to represent the pattern.

Parameters:

pattern - object to export into CSS

width - width of image applied to canvasPattern

height - height of image applied to canvasPattern

Returns:

the CSS syntax to represent the pattern

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(String dataUrl)

Returns a URL CSS property for the data URL for the current content of the canvas element.

Parameters:

dataUrl - the data URL for the current content of the canvas element

Returns:

a URL CSS property for the current content of the canvas element

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(String dataUrl,
                                             Context2d.Repetition repetition)

Returns a URL CSS property for the data URL for the current content of the canvas element.

Parameters:

dataUrl - the data URL for the current content of the canvas element

repetition - repetition of image

Returns:

a URL CSS property for the current content of the canvas element

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(FillStrokeStyle style,
                                             int width,
                                             int height)

Returns a URL CSS property for the current content of a fill or stroke canvas style instance.

Parameters:

style - fill or stroke canvas style instance

width - width of image applied to canvasPattern

height - height of image applied to canvasPattern

Returns:

a URL CSS property for the current content of the canvas pattern

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(ImageResource image)

Returns a URL CSS property for the current content of an image resource instance.

Parameters:

image - image resource instance to get as CSS property

Returns:

a URL CSS property for the current content of the image

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(Image image)

Returns a URL CSS property for the current content of an image instance.

Parameters:

image - image instance to get as CSS property

Returns:

a URL CSS property for the current content of the image

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(ImageElement image)

Returns a URL CSS property for the current content of an image element instance.

Parameters:

image - image element instance to fet as CSS property

Returns:

a URL CSS property for the current content of the image

toCSSBackgroundProperty

public static String toCSSBackgroundProperty(Gradient gradient)

Returns the CSS syntax to represent the gradient.
The dimension of canvas pattern image will be the dimension of pattern.

Parameters:

gradient - object to export into CSS

Returns:

the CSS syntax to represent the gradient

toImageElement

public static ImageElement toImageElement(String url)

Creates a image element by a data URL which is a URI scheme that provides a way to in-line data in a document, and it's commonly used to embed images in HTML and CSS.

Parameters:

url - a URI scheme that provides a way to in-line data

Returns:

a image element or null if argument is not consistent

toImageElement

public static ImageElement toImageElement(String url,
                                          int width,
                                          int height)

Creates a image element by a data URL which is a URI scheme that provides a way to in-line data in a document, and it's commonly used to embed images in HTML and CSS, forcing the size.

Parameters:

url - a URI scheme that provides a way to in-line data

width - width of image

height - height of image

Returns:

a image element or null if argument is not consistent

toImageElement

public static ImageElement toImageElement(ImageResource image)

Creates a image element by image resource which provides access to image data at runtime.

Parameters:

image - image resource instance

Returns:

a image element instance or null if argument is not consistent

toImageElement

public static ImageElement toImageElement(ImageResource image,
                                          int width,
                                          int height)

Creates a image element by image resource which provides access to image data at runtime, forcing the size.

Parameters:

image - image resource instance

width - width of image

height - height of image

Returns:

a image element or null if argument is not consistent

toImageElement

public static ImageElement toImageElement(Image image)

Creates a image element by image widget that displays the image at a given URL.

Parameters:

image - image widget instance

Returns:

a image element or null if argument is not consistent

toImageElement

public static ImageElement toImageElement(Image image,
                                          int width,
                                          int height)

Creates a image element by image widget that displays the image at a given URL, forcing the size.

Parameters:

image - image widget instance

width - width of image

height - height of image

Returns:

a image element or null if argument is not consistent

getCursorOfChart

public static Style.Cursor getCursorOfChart(IsChart chart)

Returns the cursor currently set into chart.

Parameters:

chart - chart instance

Returns:

the cursor currently set into chart. Default is Style.Cursor.DEFAULT.