org.orbisgis.legend.structure.stroke

Class RecodedPenStroke

java.lang.Object

org.orbisgis.legend.structure.stroke.RecodedPenStroke

All Implemented Interfaces:

LegendStructure, RecodedLegendStructure

public class RecodedPenStroke
extends Object
implements RecodedLegendStructure

Represents PenStroke instances that just contain Recode instances. These Recode must be linked to the same field and must be simple analysis.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
RecodedPenStroke(PenStroke stroke) Builds a RecodedPenStroke from the given stroke.

Method Summary

Methods

Modifier and Type	Method and Description
org.orbisgis.legend.structure.recode.RecodedString	getDashLegend() Gets the LegendStructure that is used to describe the dash patterns in this PenStroke.
RecodedSolidFillLegend	getFillLegend() Gets the inner RecodedSolidFillLegend.
List<org.orbisgis.legend.structure.recode.RecodedLegend>	getRecodedLegends() Get all the instances of RecodedLegend that are needed to configure this legend.
org.orbisgis.legend.structure.recode.RecodedReal	getWidthLegend() Gets the legend that describe the width of the inner PenStroke.
void	replaceDash(SeParameter sp) Replace the StringParameter embedded in the inner PenStroke with sp.
void	replaceWidth(SeParameter sp) Replace the RealParameter embedded in the inner PenStroke with sp.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecodedPenStroke

public RecodedPenStroke(PenStroke stroke)

Builds a RecodedPenStroke from the given stroke. You must be sure that the given parameter is valid. You'll receive ClassCastException and UnsupportedOperationException if it's not...

Parameters:

stroke - The original PenStroke we want to manage through this legend.

Method Detail

replaceDash

public void replaceDash(SeParameter sp)

Replace the StringParameter embedded in the inner PenStroke with sp. This method is called when a type change occurs in the associated RecodedString happens.

Parameters:

sp - The new StringParameter

Throws:

ClassCastException - if sp is not a StringParameter

replaceWidth

public void replaceWidth(SeParameter sp)

Replace the RealParameter embedded in the inner PenStroke with sp. This method is called when a type change occurs in the associated RecodedString happens.

Parameters:

sp - The new RealParameter

Throws:

ClassCastException - if sp is not a RealParameter

getFillLegend

public final RecodedSolidFillLegend getFillLegend()

Gets the inner RecodedSolidFillLegend.

Returns:

the inner RecodedSolidFillLegend.

getWidthLegend

public final org.orbisgis.legend.structure.recode.RecodedReal getWidthLegend()

Gets the legend that describe the width of the inner PenStroke.

Returns:

The legend that describe the width of the inner PenStroke.

getDashLegend

public final org.orbisgis.legend.structure.recode.RecodedString getDashLegend()

Gets the LegendStructure that is used to describe the dash patterns in this PenStroke.

Returns:

The RecodedString representing the associated dash pattern.

getRecodedLegends

public List<org.orbisgis.legend.structure.recode.RecodedLegend> getRecodedLegends()

Description copied from interface: RecodedLegendStructure

Get all the instances of RecodedLegend that are needed to configure this legend.

Specified by:

getRecodedLegends in interface RecodedLegendStructure

Returns:

A list gathering the recoded parameters.