org.wicketstuff.openlayers3.api.style

Class Stroke

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

org.wicketstuff.openlayers3.api.style.Stroke

All Implemented Interfaces:

Serializable, IJavascriptObject

public class Stroke
extends JavascriptObject
implements Serializable

Provides a class that models a stroke style.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stroke.LineCap Enumeration of valid line cap values.

Field Summary

Fields inherited from class org.wicketstuff.openlayers3.api.JavascriptObject

counter, JS_GLOBAL, objectIds

Constructor Summary

Constructors

Constructor and Description
Stroke(Color color) Creates a new instance.
Stroke(Color color, Stroke.LineCap lineCap, Stroke.LineCap lineJoin, Number[] lineDash, Number miterLimit, Number width) Creates a new instance.
Stroke(String color) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Stroke	color(Color color) Sets the stroke color.
Color	getColor() Returns the stroke color.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
Stroke.LineCap	getLineCap() Returns the line cap style.
Number[]	getLineDash() Returns the line dash style.
Stroke.LineCap	getLineJoin() Returns the line join style.
Number	getMiterLimit() Returns the miter limit.
Number	getWidth() Returns the stroke width.
Stroke	lineCap(Stroke.LineCap lineCap) Sets the line cap style.
Stroke	lineDash(Number... lineDash) Sets the line dash style.
Stroke	lineJoin(Stroke.LineCap lineJoin) Sets the line join style.
Stroke	miterLimit(Number miterLimit) Sets the miter limit.
String	renderAttributesJs()
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
void	setColor(Color color) Sets the stroke color.
void	setLineCap(Stroke.LineCap lineCap) Sets the line cap style.
void	setLineDash(Number... lineDash) Sets the line dash style.
void	setLineJoin(Stroke.LineCap lineJoin) Sets the line join style.
void	setMiterLimit(Number miterLimit) Sets the miter limit.
void	setWidth(Number width) Sets the stroke width.
Stroke	width(Number width) Sets the stroke width.

Methods inherited from class org.wicketstuff.openlayers3.api.JavascriptObject

escapeQuoteJs, getJsId, getJsIdWithSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

Stroke

public Stroke(String color)

Creates a new instance.

Parameters:

color - Color for this instance

Stroke

public Stroke(Color color)

Creates a new instance.

Parameters:

color - Color for this instance

Stroke

public Stroke(Color color,
      Stroke.LineCap lineCap,
      Stroke.LineCap lineJoin,
      Number[] lineDash,
      Number miterLimit,
      Number width)

Creates a new instance.

Parameters:

color - Color for this stroke

lineCap - Line cap style for this stroke

lineJoin - Line join style for this stroke

lineDash - Line dash pattern

miterLimit - Miter limit

width - Width of the stroke

Method Detail

getColor

public Color getColor()

Returns the stroke color.

Returns:

Current value

setColor

public void setColor(Color color)

Sets the stroke color.

Parameters:

color - New value

color

public Stroke color(Color color)

Sets the stroke color.

Parameters:

color - New value

Returns:

This instance

getLineCap

public Stroke.LineCap getLineCap()

Returns the line cap style.

Returns:

Current value

setLineCap

public void setLineCap(Stroke.LineCap lineCap)

Sets the line cap style.

Parameters:

lineCap - New value

lineCap

public Stroke lineCap(Stroke.LineCap lineCap)

Sets the line cap style.

Parameters:

lineCap - New value

Returns:

This instance

getLineJoin

public Stroke.LineCap getLineJoin()

Returns the line join style.

Returns:

Current value

setLineJoin

public void setLineJoin(Stroke.LineCap lineJoin)

Sets the line join style.

Parameters:

lineJoin - New value

lineJoin

public Stroke lineJoin(Stroke.LineCap lineJoin)

Sets the line join style.

Parameters:

lineJoin - New value

Returns:

This instance

getLineDash

public Number[] getLineDash()

Returns the line dash style.

Returns:

Current value

setLineDash

public void setLineDash(Number... lineDash)

Sets the line dash style.

Parameters:

lineDash - New value

lineDash

public Stroke lineDash(Number... lineDash)

Sets the line dash style.

Parameters:

lineDash - New value

Returns:

This instance

getMiterLimit

public Number getMiterLimit()

Returns the miter limit.

Returns:

Current value

setMiterLimit

public void setMiterLimit(Number miterLimit)

Sets the miter limit.

Parameters:

miterLimit - New value

miterLimit

public Stroke miterLimit(Number miterLimit)

Sets the miter limit.

Parameters:

miterLimit - New value

Returns:

This instance

getWidth

public Number getWidth()

Returns the stroke width.

Returns:

Current value

setWidth

public void setWidth(Number width)

Sets the stroke width.

Parameters:

width - New value

width

public Stroke width(Number width)

Sets the stroke width.

Parameters:

width - New value

Returns:

This instance

getJsType

public String getJsType()

Description copied from class: JavascriptObject

Returns a String with the type of Javascript object that this object represents. This will be used when creating new instances.

Specified by:

getJsType in interface IJavascriptObject

Specified by:

getJsType in class JavascriptObject

Returns:

String with the Javascript object type

renderAttributesJs

public String renderAttributesJs()

renderJs

public String renderJs()

Description copied from class: JavascriptObject

Returns a String with containing the rendered Javascript code for this object.

Specified by:

renderJs in interface IJavascriptObject

Specified by:

renderJs in class JavascriptObject

Returns:

String with rendered Javascript code