ilog.views.sdm.graphic

Class IlvBasicStroke

java.lang.Object

java.awt.BasicStroke

ilog.views.sdm.graphic.IlvBasicStroke

All Implemented Interfaces:

Stroke

public class IlvBasicStroke
extends BasicStroke

A java.awt.BasicStroke subclass that is bean compliant. It represents a mutable implementation of a BasicStroke.

Here is an example of use in SDM:

 #stroke {
         class     : 'ilog.views.sdm.graphic.IlvBasicStroke' ;
     lineWidth : 3;
     dashArray : 1,5;
     endCap    : CAP_ROUND;
 }
 

Since:

JViews 5.0

Field Summary

Fields inherited from class java.awt.BasicStroke

CAP_BUTT, CAP_ROUND, CAP_SQUARE, JOIN_BEVEL, JOIN_MITER, JOIN_ROUND

Constructor Summary

Constructors

Constructor and Description
IlvBasicStroke() Bean constructor.

Method Summary

Modifier and Type	Method and Description
Shape	createStrokedShape(Shape s) Returns a Shape whose interior defines the stroked outline of a specified Shape.
float[]	getDashArray() Returns the array representing the lengths of the dash segments.
float	getDashPhase() Returns the current dash phase.
int	getEndCap() Returns the end cap style.
int	getLineJoin() Returns the line join style.
float	getLineWidth() Returns the line width.
float	getMiterLimit() Returns the limit of miter joins.
void	setDashArray(float[] array) Sets the array representing the lengths of the dash segments.
void	setDashPhase(float phase) Sets the dash phase.
void	setEndCap(int cap) Sets the end cap style.
void	setLineJoin(int join) Sets the line join style.
void	setLineWidth(float width) Sets the line width.
void	setMiterLimit(float limit) Sets the miter limit.

Methods inherited from class java.awt.BasicStroke

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBasicStroke

public IlvBasicStroke()

Bean constructor.

Method Detail

setLineWidth

public void setLineWidth(float width)

Sets the line width. Line width is represented in user space.

Parameters:

width - The new value.

getLineWidth

public float getLineWidth()

Returns the line width. Line width is represented in user space.

Overrides:

getLineWidth in class BasicStroke

Returns:

The line width of this BasicStroke.

setEndCap

public void setEndCap(int cap)

Sets the end cap style.

Parameters:

cap - The new value.

getEndCap

public int getEndCap()

Returns the end cap style.

Overrides:

getEndCap in class BasicStroke

Returns:

The end cap style of this BasicStroke as one of the static int values that define possible end cap styles.

setLineJoin

public void setLineJoin(int join)

Sets the line join style.

Parameters:

join - The new value.

getLineJoin

public int getLineJoin()

Returns the line join style.

Overrides:

getLineJoin in class BasicStroke

Returns:

The line join style of the BasicStroke as one of the static int values that define possible line join styles.

setMiterLimit

public void setMiterLimit(float limit)

Sets the miter limit.

Parameters:

limit - The new value.

getMiterLimit

public float getMiterLimit()

Returns the limit of miter joins.

Overrides:

getMiterLimit in class BasicStroke

Returns:

The limit of miter joins of the BasicStroke.

setDashArray

public void setDashArray(float[] array)

Sets the array representing the lengths of the dash segments. Alternate entries in the array represent the user space lengths of the opaque and transparent segments of the dashes. As the pen moves along the outline of the Shape to be stroked, the user space distance that the pen travels is accumulated. The distance value is used to index into the dash array. The pen is opaque when its current cumulative distance maps to an even element of the dash array, and transparent otherwise.

Parameters:

array - The new value.

getDashArray

public float[] getDashArray()

Returns the array representing the lengths of the dash segments.

Overrides:

getDashArray in class BasicStroke

Returns:

The dash array.

setDashPhase

public void setDashPhase(float phase)

Sets the dash phase. The dash phase is a distance specified in user coordinates that represents an offset into the dashing pattern. In other words, the dash phase defines the point in the dashing pattern that will correspond to the beginning of the stroke.

Parameters:

phase - The new value.

getDashPhase

public float getDashPhase()

Returns the current dash phase.

Overrides:

getDashPhase in class BasicStroke

Returns:

The dash phase as a float value.

createStrokedShape

public Shape createStrokedShape(Shape s)

Returns a Shape whose interior defines the stroked outline of a specified Shape.

Specified by:

createStrokedShape in interface Stroke

Overrides:

createStrokedShape in class BasicStroke

Parameters:

s - The Shape boundary to be stroked

Returns:

The Shape of the stroked outline.