org.pepstock.charba.client.colors

Class Pattern

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.colors.CanvasObject

org.pepstock.charba.client.colors.Pattern

public final class Pattern
extends CanvasObject

Entity to apply a canvas pattern into a dataset as background.
See here some interesting pattern images.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pattern.PatternFactory Inner class to create pattern by a native object.

Constructor Summary

Constructors

Constructor and Description
Pattern(CanvasPatternItem canvasPattern) Creates the object using an already created canvas pattern. The dimension of canvas pattern image will be the default TilesFactoryDefaults.DEFAULT_SIZE.
Pattern(CanvasPatternItem canvasPattern, int squareSize) Creates the object using an already created canvas pattern. The dimension of canvas pattern image is unique then the image of pattern is a square.
Pattern(CanvasPatternItem canvasPattern, int width, int height) Creates the object using an already created canvas pattern. This is mainly used by tiles.
Pattern(Img image) Creates the object using an image to use in the pattern. The repetition used is repeat.
Pattern(Img image, Repetition repetition) Creates the object using an image to use in the pattern and repetition to apply to pattern.

Method Summary

Modifier and Type	Method and Description
CanvasPatternItem	getCanvasPattern() Returns the canvas pattern if exists.
int	getHeight() Returns the image height used into pattern.
Img	getImage() Returns the image used into pattern if exists.
Repetition	getRepetition() Returns the repetition to use into pattern.
int	getWidth() Returns the image width used into pattern.

Methods inherited from class org.pepstock.charba.client.colors.CanvasObject

getId

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Constructor Detail

Pattern

public Pattern(Img image)

Creates the object using an image to use in the pattern.
The repetition used is repeat.

Parameters:

image - image to use as pattern

Pattern

public Pattern(Img image,
               Repetition repetition)

Creates the object using an image to use in the pattern and repetition to apply to pattern.

Parameters:

image - image to use as pattern

repetition - repetition value to apply to pattern

Pattern

public Pattern(CanvasPatternItem canvasPattern)

Creates the object using an already created canvas pattern.
The dimension of canvas pattern image will be the default TilesFactoryDefaults.DEFAULT_SIZE. This is mainly used by tiles.

Parameters:

canvasPattern - canvas pattern instance

Pattern

public Pattern(CanvasPatternItem canvasPattern,
               int squareSize)

Creates the object using an already created canvas pattern.
The dimension of canvas pattern image is unique then the image of pattern is a square. This is mainly used by tiles.

Parameters:

canvasPattern - canvas pattern instance

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

Pattern

public Pattern(CanvasPatternItem canvasPattern,
               int width,
               int height)

Creates the object using an already created canvas pattern.
This is mainly used by tiles.

Parameters:

canvasPattern - canvas pattern instance

width - width of image applied to canvasPattern

height - height of image applied to canvasPattern

Method Detail

getImage

public Img getImage()

Returns the image used into pattern if exists.

Returns:

the image used into pattern if exists, otherwise null.

getWidth

public int getWidth()

Returns the image width used into pattern.

Returns:

the image width used into pattern.

getHeight

public int getHeight()

Returns the image height used into pattern.

Returns:

the image height used into pattern.

getRepetition

public Repetition getRepetition()

Returns the repetition to use into pattern.

Returns:

the repetition to use into pattern

getCanvasPattern

public CanvasPatternItem getCanvasPattern()

Returns the canvas pattern if exists.

Returns:

the canvas pattern if exists, otherwise null.