com.luciad.view.gxy

LuciadLightspeedClass TLcdStrokeLineStyle

java.lang.Object

com.luciad.view.gxy.TLcdStrokeLineStyle

All Implemented Interfaces:

ILcdCloneable, ILcdGXYPainterStyle, Serializable, Cloneable

public class TLcdStrokeLineStyle
extends Object
implements ILcdGXYPainterStyle, ILcdCloneable

ILcdGXYPainterStyle based on java.awt.Stroke. The color can be different in regular and selected mode. The Builder subclass offers convenience methods for building various common line strokes.

This implementation requires Graphics2D instances.

For a more advanced custom line style, see TLcdGXYComplexStroke.

Since:

11.0

See Also:

TLcdGXYPainterColorStyle, TLcdStrokeLineStyleBuilder, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdStrokeLineStyle() Creates a default line style.
TLcdStrokeLineStyle(TLcdStrokeLineStyle aLineStyle) Creates a new line style based on the given style.

Method Summary

Modifier and Type	Method and Description
Object	clone() Makes Object.clone() public.
Color	getColor() Returns the color used in default mode.
Color	getSelectionColor() Returns the color used in selection mode.
Stroke	getSelectionStroke() Returns the stroke used in selection mode.
Stroke	getStroke() Returns the stroke used in default mode.
boolean	isAntiAliasing() Returns whether to use anti-aliasing when painting.
static TLcdStrokeLineStyleBuilder	newBuilder() Creates a new builder with the default values.
void	setAntiAliasing(boolean aAntiAliasing) Sets whether to use anti-aliasing when painting.
void	setColor(Color aColor) Sets the color used in default mode.
void	setSelectionColor(Color aSelectionColor) Sets the color used in selection mode.
void	setSelectionStroke(Stroke aSelectionStroke) Sets the stroke used in selection mode.
void	setStroke(Stroke aStroke) Sets the stroke used in default mode.
void	setupGraphics(Graphics aGraphics, Object aObject, int aMode, ILcdGXYContext aGXYContext) Configures aGraphics for painting the given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdStrokeLineStyle

public TLcdStrokeLineStyle()

Creates a default line style.

TLcdStrokeLineStyle

public TLcdStrokeLineStyle(TLcdStrokeLineStyle aLineStyle)

Creates a new line style based on the given style.

Parameters:

aLineStyle - a style whose settings will be copied

Method Detail

newBuilder

public static TLcdStrokeLineStyleBuilder newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

getColor

public Color getColor()

Returns the color used in default mode.

Returns:

the color used in default mode

See Also:

setColor(java.awt.Color)

setColor

public void setColor(Color aColor)

Sets the color used in default mode.

Parameters:

aColor - the new color to be used in default mode.

See Also:

getColor()

getSelectionColor

public Color getSelectionColor()

Returns the color used in selection mode.

Returns:

the color used in selection mode

See Also:

setSelectionColor(java.awt.Color)

setSelectionColor

public void setSelectionColor(Color aSelectionColor)

Sets the color used in selection mode.

Parameters:

aSelectionColor - the new color to be used in selection mode.

See Also:

getSelectionColor()

isAntiAliasing

public boolean isAntiAliasing()

Returns whether to use anti-aliasing when painting.

Returns:

whether to use anti-aliasing when painting

See Also:

setAntiAliasing(boolean)

setAntiAliasing

public void setAntiAliasing(boolean aAntiAliasing)

Sets whether to use anti-aliasing when painting.

See also ILcdGXYView.isAntiAliased().

Parameters:

aAntiAliasing - if true, uses anti-aliasing when painting

See Also:

isAntiAliasing()

getStroke

public Stroke getStroke()

Returns the stroke used in default mode.

Returns:

the stroke used in default mode.

See Also:

setStroke(java.awt.Stroke)

setStroke

public void setStroke(Stroke aStroke)

Sets the stroke used in default mode.

Parameters:

aStroke - the new stroke to be used in default mode.

See Also:

getStroke()

getSelectionStroke

public Stroke getSelectionStroke()

Returns the stroke used in selection mode.

Returns:

the stroke used in selection mode.

See Also:

setSelectionStroke(java.awt.Stroke)

setSelectionStroke

public void setSelectionStroke(Stroke aSelectionStroke)

Sets the stroke used in selection mode.

Parameters:

aSelectionStroke - the new stroke to be used in selection mode.

See Also:

getSelectionStroke()

setupGraphics

public void setupGraphics(Graphics aGraphics,
                          Object aObject,
                          int aMode,
                          ILcdGXYContext aGXYContext)

Configures aGraphics for painting the given object. In particular, the stroke will be changed to have the configured stroke, color and aliasing, depending on the selection mode.

Specified by:

setupGraphics in interface ILcdGXYPainterStyle

Parameters:

aGraphics - the Graphics to set up. This implementation relies on a Graphics2D instance.

aObject - the Object to paint.

aMode - the painting mode to consider (defined in ILcdGXYPainter).

aGXYContext - the ILcdGXYContext to consider.

See Also:

ILcdGXYPainter

clone

public Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class Object

See Also:

Object.clone()