uk.ac.starlink.ttools.plot2
Class ZoneContent

java.lang.Object
  uk.ac.starlink.ttools.plot2.ZoneContent

public class ZoneContent
extends Object

Aggregates a list of items describing what appears in one zone of a Gang.

Since:

25 Jan 2016

Author:

Mark Taylor

Constructor Summary

ZoneContent(PlotLayer[] layers, Icon legend, float[] legPos, String title)
Constructor.

Method Summary

PlotLayer[]	getLayers() Returns plot layers.
Icon	getLegend() Returns legend icon.
float[]	getLegendPosition() Returns legend position if internal legend is required.
String	getTitle() Returns plot title if required.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoneContent

public ZoneContent(PlotLayer[] layers,
                   Icon legend,
                   float[] legPos,
                   String title)

Constructor.

Parameters:

layers - plot layers to be painted

legend - legend icon if required, or null

legPos - legend position if intenal legend is required; 2-element (x,y) array, each element in range 0-1

title - title text, or null

Method Detail

getLayers

public PlotLayer[] getLayers()

Returns plot layers.

Returns:

layers to paint in zone

getLegend

public Icon getLegend()

Returns legend icon.

Returns:

legend icon, or null

getLegendPosition

public float[] getLegendPosition()

Returns legend position if internal legend is required.

Returns:

2-element (x,y) array, each element in range 0-1, or null

getTitle

public String getTitle()

Returns plot title if required.

Returns:

title text, or null