org.orbisgis.legend.structure.literal

Class ColorLiteralLegend

java.lang.Object

org.orbisgis.legend.structure.literal.ColorLiteralLegend

All Implemented Interfaces:

LegendStructure, ParameterLegend

public class ColorLiteralLegend
extends Object
implements ParameterLegend

LegendStructure associated to a numeric constant, that is represented as a ColorLiteral in the SE model.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ColorLiteralLegend(ColorLiteral literal) Build a new RealLiteralLegend that is associated to the ColorLiteral r.

Method Summary

Methods

Modifier and Type	Method and Description
Color	getColor() Gets the Color contained in the inner ColorLiteral.
ColorLiteral	getLiteral() Get the ColorLiteral associated with this RealLiteralLegend.
SeParameter	getParameter() Gets the SeParameter that had been used to build this LegendStructure.
void	setColor(Color col) Sets the Color contained in the inner ColorLiteral.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorLiteralLegend

public ColorLiteralLegend(ColorLiteral literal)

Build a new RealLiteralLegend that is associated to the ColorLiteral r.

Parameters:

literal - the input ColorLiteral

Method Detail

getLiteral

public ColorLiteral getLiteral()

Get the ColorLiteral associated with this RealLiteralLegend.

Returns:

getColor

public Color getColor()

Gets the Color contained in the inner ColorLiteral.

Returns:

setColor

public void setColor(Color col)

Sets the Color contained in the inner ColorLiteral.

Parameters:

col -

getParameter

public SeParameter getParameter()

Description copied from interface: ParameterLegend

Gets the SeParameter that had been used to build this LegendStructure.

Specified by:

getParameter in interface ParameterLegend

Returns: