edu.ucdavis.cstars.client.symbol

Class CartographicLineSymbol

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.symbol.Symbol

edu.ucdavis.cstars.client.symbol.LineSymbol

edu.ucdavis.cstars.client.symbol.SimpleLineSymbol

edu.ucdavis.cstars.client.symbol.CartographicLineSymbol

public class CartographicLineSymbol
extends SimpleLineSymbol

Line symbols are used to draw linear features on the graphics layer. CartographicLineSymbol, like SimpleLineSymbol, is either a solid line or a predefined pattern of dashes and dots. Line joins and line caps can be added to further define the line symbol.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CartographicLineSymbol.CapType
static class	CartographicLineSymbol.JoinType

Nested classes/interfaces inherited from class edu.ucdavis.cstars.client.symbol.SimpleLineSymbol

SimpleLineSymbol.StyleType

Method Summary

Methods

Modifier and Type	Method and Description
static CartographicLineSymbol	create() Creates a new empty CartographicLineSymbol object.
static CartographicLineSymbol	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new CartographicLineSymbol object using a JSON object.
static CartographicLineSymbol	create(SimpleLineSymbol.StyleType style, Color color, int width, CartographicLineSymbol.CapType cap, CartographicLineSymbol.JoinType join, int miterLimit) Creates a new CartographicLineSymbol object with parameters.
CartographicLineSymbol.CapType	getCap() The cap style.
CartographicLineSymbol.JoinType	getJoin() The join style.
int	getMiterLimit() Size threshold for showing mitered line joins.
CartographicLineSymbol	setCap(CartographicLineSymbol.CapType cap) Sets the cap style.
CartographicLineSymbol	setJoin(CartographicLineSymbol.JoinType join) Sets the join style.
CartographicLineSymbol	setMiterLimit(int miterLimit) Sets the size threshold for showing mitered line joins.

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

create, getStyle, setStyle

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

getWidth, setWidth

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 CartographicLineSymbol create()

Creates a new empty CartographicLineSymbol object.

Returns:

CartographicLineSymbol

create

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

Creates a new CartographicLineSymbol object using a JSON object.

Parameters:

json - - JSON object representing the CartographicLineSymbol.

Returns:

CartographicLineSymbol

create

public static CartographicLineSymbol create(SimpleLineSymbol.StyleType style,
                            Color color,
                            int width,
                            CartographicLineSymbol.CapType cap,
                            CartographicLineSymbol.JoinType join,
                            int miterLimit)

Creates a new CartographicLineSymbol object with parameters.

Parameters:

style - - symbol style

color - - symbol color

width - - Width of line in pixels.

cap - - Line cap.

join - - Line join.

miterLimit - - Size threshold for showing mitered line joins.

Returns:

CartographicLineSymbol

getCap

public final CartographicLineSymbol.CapType getCap()

The cap style. The default value is CAP_BUTT.

Returns:

CapType

getJoin

public final CartographicLineSymbol.JoinType getJoin()

The join style. The default value is JOIN_MITER.

Returns:

JoinType

getMiterLimit

public final int getMiterLimit()

Size threshold for showing mitered line joins.

Returns:

int

setCap

public final CartographicLineSymbol setCap(CartographicLineSymbol.CapType cap)

Sets the cap style.

Parameters:

cap - - Cap style.

Returns:

CartographicLineSymbol

setJoin

public final CartographicLineSymbol setJoin(CartographicLineSymbol.JoinType join)

Sets the join style.

Parameters:

join - - Join style.

Returns:

CartographicLineSymbol

setMiterLimit

public final CartographicLineSymbol setMiterLimit(int miterLimit)

Sets the size threshold for showing mitered line joins.

Parameters:

miterLimit - - Miter limit.

Returns:

CartographicLineSymbol