edu.ucdavis.cstars.client.symbol

Class PictureFillSymbol

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.symbol.Symbol

edu.ucdavis.cstars.client.symbol.FillSymbol

edu.ucdavis.cstars.client.symbol.PictureFillSymbol

public class PictureFillSymbol
extends FillSymbol

Fill symbols are used to draw polygon features on the graphics layer. PictureFillSymbol uses an image in a repeating pattern. In addition, the symbol can have an optional outline, which is defined by a line symbol. Known limitation: PictureFillSymbol does not work correctly in FireFox 2.x. It does work correctly in Internet Explorer 6 and 7 and FireFox 3.x.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static PictureFillSymbol	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new PictureFillSymbol object using a JSON object.
static PictureFillSymbol	create(java.lang.String url, SimpleLineSymbol outline, int width, int height) Creates a new PictureFillSymbol object.
int	getHeight() Height of the image in pixels.
java.lang.String	getUrl() URL of the image.
int	getWidth() Width of the image in pixels.
int	getXOffset() The offset on the x-axis in pixels.
int	getXScale() Scale factor in x direction.
int	getYOffset() The offset on the y-axis in pixels.
int	getYScale() Scale factor in y direction.
PictureFillSymbol	setHeight(int height) Sets the height of the symbol.
PictureFillSymbol	setOffset(int x, int y) Sets the symbol offset.
PictureFillSymbol	setUrl(java.lang.String url) Sets the URL to the location of the symbol.
PictureFillSymbol	setWidth(int width) Sets the width of the symbol.
PictureFillSymbol	setXScale(int scale) Sets the scale factor in x direction.
PictureFillSymbol	setYScale(int scale) Sets the scale factor in y direction.

Methods inherited from class edu.ucdavis.cstars.client.symbol.FillSymbol

getOutline, setOutline

Methods inherited from class edu.ucdavis.cstars.client.symbol.Symbol

fromJson, getColor, getType, setColor, toJson

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static PictureFillSymbol create(com.google.gwt.core.client.JavaScriptObject json)

Creates a new PictureFillSymbol object using a JSON object.

Parameters:

json - - JSON object representing the PictureFillSymbol.

Returns:

PictureFillSymbol

create

public static PictureFillSymbol create(java.lang.String url,
                       SimpleLineSymbol outline,
                       int width,
                       int height)

Creates a new PictureFillSymbol object.

Parameters:

url - - URL of the image.

outline - - Outline of the symbol.

width - - Width of the image in pixels.

height - - Height of the image in pixels.

Returns:

PictureFillSymbol

getHeight

public final int getHeight()

Height of the image in pixels.

Returns:

int

getUrl

public final java.lang.String getUrl()

URL of the image.

Returns:

String

getWidth

public final int getWidth()

Width of the image in pixels.

Returns:

int

getXOffset

public final int getXOffset()

The offset on the x-axis in pixels. Default value: 0

Returns:

int

getXScale

public final int getXScale()

Scale factor in x direction. Default value: 1

Returns:

int

getYOffset

public final int getYOffset()

The offset on the y-axis in pixels. Default value: 0

Returns:

int

getYScale

public final int getYScale()

Scale factor in y direction. Default value: 1

Returns:

int

setHeight

public final PictureFillSymbol setHeight(int height)

Sets the height of the symbol.

Parameters:

height - - Height in pixels.

Returns:

int

setOffset

public final PictureFillSymbol setOffset(int x,
                          int y)

Sets the symbol offset.

Parameters:

x - - Offset in x direction in pixels.

y - - Offset in y direction in pixels.

Returns:

PictureFillSymbol

setUrl

public final PictureFillSymbol setUrl(java.lang.String url)

Sets the URL to the location of the symbol.

Parameters:

url - - URL string.

Returns:

PictureFillSymbol

setWidth

public final PictureFillSymbol setWidth(int width)

Sets the width of the symbol.

Parameters:

width - - Width in pixels.

Returns:

PictureFillSymbol

setXScale

public final PictureFillSymbol setXScale(int scale)

Sets the scale factor in x direction. of the symbol.

Parameters:

scale - - Scale factor in x direction.

Returns:

PictureFillSymbol

setYScale

public final PictureFillSymbol setYScale(int scale)

Sets the scale factor in y direction.

Parameters:

scale - - Scale factor in y direction.

Returns:

PictureFillSymbol