public class ColorScaleLegendBuilder extends java.lang.Object implements LegendBuilder, java.io.Serializable
ColorScale.
This builder will only create a legend if the plot uses a renderer
that implements the ColorScaleRenderer interface.
Chart3D class.
| Constructor and Description |
|---|
ColorScaleLegendBuilder()
Creates a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
TableElement |
createLegend(Plot3D plot,
Anchor2D anchor,
Orientation orientation,
ChartStyle style)
Creates a new color scale legend with the specified orientation.
|
boolean |
equals(java.lang.Object obj)
Tests this builder for equality with an arbitrary object.
|
double |
getBarLength()
Returns the length of the bar displaying the color scale.
|
double |
getBarWidth()
Returns the width of the bar displaying the color scale.
|
boolean |
getIgnoreFixedColorScale()
Returns the flag that controls whether or not a
FixedColorScale
will be ignored for the purposes of generating a legend. |
void |
setBarLength(double length)
Sets the length of the bar displaying the color scale.
|
void |
setBarWidth(double width)
Sets the width of the bar displaying the color scale.
|
void |
setIgnoreFixedColorScale(boolean ignore)
Sets the flag that controls whether or not a
FixedColorScale
will be ignored for the purposes of generating a legend. |
public ColorScaleLegendBuilder()
public double getBarWidth()
public void setBarWidth(double width)
width - the width (in Java2D units).public double getBarLength()
public void setBarLength(double length)
length - the length (in Java2D units).public boolean getIgnoreFixedColorScale()
FixedColorScale
will be ignored for the purposes of generating a legend.public void setIgnoreFixedColorScale(boolean ignore)
FixedColorScale
will be ignored for the purposes of generating a legend.ignore - the new flag value.public TableElement createLegend(Plot3D plot, Anchor2D anchor, Orientation orientation, ChartStyle style)
ColorScaleRenderer then this method will return null
and no legend will be drawn on the chart.createLegend in interface LegendBuilderplot - the plot (null not permitted).anchor - the anchor (null not permitted).orientation - the orientation (null not permitted).style - the chart style (null not permitted).null).public boolean equals(java.lang.Object obj)
equals in class java.lang.Objectobj - the object (null permitted).