Class WPen
public class WPen extends WJavaScriptExposableObject
A pen defines the properties of how lines (that may surround shapes) are rendered.
A pen with width 0 is a cosmetic pen, and is always rendered as 1 pixel width,
regardless of transformations. Otherwized, the pen width is modified by the transformation
set on the painter.
JavaScript exposability
A WPen is JavaScript exposable. If a WPen is JavaScript bound
, it can be accessed in your
custom JavaScript code through its handle's jsRef()
. At
the moment, only the getColor()
property is exposed, e.g. a pen with the
color WColor(10,20,30,255) will be represented in JavaScript as:
{
color: [10,20,30,255]
}
Warning: A WPen that is JavaScript exposed should be modified only through its
handle
. Any attempt at modifying it will cause an exception to be
thrown.
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description protected void
assignFromJSON(com.google.gson.JsonElement value)
WPen
clone()
Clone method.boolean
equals(WPen other)
Indicates whether some other object is "equal to" this one.PenCapStyle
getCapStyle()
Returns the style for rendering line ends.WColor
getColor()
Returns the pen color.WGradient
getGradient()
Returns the pen color gradient.PenJoinStyle
getJoinStyle()
Returns the style for rendering line joins.java.lang.String
getJsValue()
Returns a JavaScript representation of the value of this object.PenStyle
getStyle()
Returns the pen style.WLength
getWidth()
Returns the pen width.void
setCapStyle(PenCapStyle style)
Sets the style for rendering line ends.void
setColor(WColor color)
Sets the pen color.void
setGradient(WGradient gradient)
Sets the pen color as a gradient.void
setJoinStyle(PenJoinStyle style)
Sets the style for rendering line joins.void
setStyle(PenStyle style)
Sets the pen style.void
setWidth(WLength width)
Sets the pen width.Methods inherited from class eu.webtoolkit.jwt.WJavaScriptExposableObject
assignBinding, assignBinding, checkModifiable, closeTo, getJsRef, isJavaScriptBound, sameBindingAs
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
WPen
public WPen()Creates a black cosmetic pen.Constructs a black solid pen of 0 width (i.e. cosmetic single pixel width), with
PenCapStyle.SquareCap
line ends andPenJoinStyle.BevelJoin
line join style. -
WPen
Creates a black pen with a particular style.Constructs a black pen of 0 width (i.e. cosmetic single pixel width), with
PenCapStyle.SquareCap
line ends andPenJoinStyle.BevelJoin
line join style.The line style is set to
style
. -
WPen
Creates a solid pen of a particular color.Constructs a solid pen of 0 width (i.e. cosmetic single pixel width), with
PenCapStyle.SquareCap
line ends andPenJoinStyle.BevelJoin
line join style.The pen color is set to
color
. -
WPen
Creates a solid pen with a gradient color.Constructs a solid pen of 0 width (i.e. cosmetic single pixel width), with
PenCapStyle.SquareCap
line ends andPenJoinStyle.BevelJoin
line join style.The pen's color is defined by the gradient
color
.
-
-
Method Details
-
clone
Clone method.Clones this pen.
- Specified by:
clone
in classWJavaScriptExposableObject
-
equals
Indicates whether some other object is "equal to" this one.Returns
true
if the pens are exactly the same. -
setStyle
Sets the pen style.The pen style determines the pattern with which the pen is rendered.
-
getStyle
Returns the pen style.- See Also:
setStyle(PenStyle style)
-
setCapStyle
Sets the style for rendering line ends.The cap style configures how line ends are rendered.
-
getCapStyle
Returns the style for rendering line ends.- See Also:
setCapStyle(PenCapStyle style)
-
setJoinStyle
Sets the style for rendering line joins.The join style configures how corners are rendered between different segments of a poly-line, rectange or painter path.
-
getJoinStyle
Returns the style for rendering line joins.- See Also:
setJoinStyle(PenJoinStyle style)
-
setWidth
Sets the pen width.A pen width
must
be specified usingUnit#Pixel
units. -
getWidth
Returns the pen width.- See Also:
setWidth(WLength width)
-
setColor
Sets the pen color. -
getColor
Returns the pen color.- See Also:
setColor(WColor color)
-
setGradient
Sets the pen color as a gradient.- See Also:
setColor(WColor color)
-
getGradient
Returns the pen color gradient.- See Also:
setGradient(WGradient gradient)
-
getJsValue
public java.lang.String getJsValue()Description copied from class:WJavaScriptExposableObject
Returns a JavaScript representation of the value of this object.Note: The value returned will reflect the current server side value of the object. If this object is JavaScript bound, this value may not reflect the actual client side value. If you need access to the client side value, use
getJsRef()
intead.- Specified by:
getJsValue
in classWJavaScriptExposableObject
-
assignFromJSON
protected void assignFromJSON(com.google.gson.JsonElement value)- Specified by:
assignFromJSON
in classWJavaScriptExposableObject
-