Package com.metsci.glimpse.core.plot.stacked

Class PlotInfoWrapper

java.lang.Object

com.metsci.glimpse.core.plot.stacked.PlotInfoWrapper

All Implemented Interfaces:

PlotInfo

Direct Known Subclasses:

GroupInfoImpl, TimelineInfo, TimePlotInfoImpl, TimePlotInfoWrapper

public class PlotInfoWrapper
extends Object
implements PlotInfo

Field Summary

Fields

Modifier and Type	Field	Description
PlotInfo	info

Constructor Summary

Constructors

Constructor	Description
PlotInfoWrapper(PlotInfo info)

Method Summary

Modifier and Type	Method	Description
void	addLayout(GlimpseAxisLayout2D childLayout)	Adds the childLayout to the part of the StackedPlot2D represented by this LayoutInfo.
void	deletePlot()	Deprecated. removePlot()
GlimpseAxisLayout2D	getBaseLayout()	Returns the base GlimpseLayout.
Axis1D	getCommonAxis()	Returns the common axis shared by all the plots in a StackedPlot2D.
Axis1D	getCommonAxis(GlimpseTargetStack stack)	Returns the common axis associated with the given GlimpseTargetStack.
Object	getId()	Gets the unique identifier assigned to this plot.
int	getIndentLevel()
GlimpseAxisLayout2D	getLayout()	Returns the GlimpseAxisLayout2D for this plot.
String	getLayoutData()
int	getOrder()
Axis1D	getOrthogonalAxis()	Returns the data axis associated with this plot.
Axis1D	getOrthogonalAxis(GlimpseTargetStack stack)	Returns the data axis associated with the given GlimpseTargetStack.
PlotInfo	getParent()
int	getPlotSpacing()
int	getSize()
StackedPlot2D	getStackedPlot()	Gets a reference to the parent StackedPlot2D which this PlotInfo belongs to.
boolean	isExpanded()
boolean	isGrow()
boolean	isVisible()
void	removePlot()	Removes this plot from its StackedPlot2D.
void	setGrow(boolean grow)	Sets the plot to fill all available space.
void	setIndentLevel(int level)	Sets the indentation level of this plot.
void	setLayoutData(String layoutData)	Sets the MIG Layout constraints which position this PlotInfo within the StackedPlot2D.
void	setLookAndFeel(LookAndFeel laf)
void	setOrder(int order)	Sets the ordering of this plot relative to the other plots in the StackedPlot2D.
void	setParent(PlotInfo parent)
void	setPlotSpacing(int spacing)	Sets the spacing between this plot and those above and below it.
void	setSize(int size)	Sets the size in pixels for this plot.
void	setVisible(boolean visible)	If true, the PlotInfo will be drawn as a row on the timeline, if false the PlotInfo will be hidden.
void	updateLayout(int index)

Methods inherited from class java.lang.Object

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

Field Detail

info

public PlotInfo info

Constructor Detail

PlotInfoWrapper

public PlotInfoWrapper(PlotInfo info)

Method Detail

getLayoutData

public String getLayoutData()

Specified by:

getLayoutData in interface PlotInfo

See Also:

PlotInfo.setLayoutData(String)

setLayoutData

public void setLayoutData(String layoutData)

Description copied from interface: PlotInfo

Sets the MIG Layout constraints which position this PlotInfo within the StackedPlot2D. Normally, calling this method is not necessary because the StackedPlot2D automatically positions its PlotInfo. However, this method can be used to override this default position.

Calling PlotInfo.setLayoutData(String) with null as the argument will cause the StackedPlot2D to resume automatically positioning this PlotInfo.

Specified by:

setLayoutData in interface PlotInfo

getStackedPlot

public StackedPlot2D getStackedPlot()

Description copied from interface: PlotInfo

Gets a reference to the parent StackedPlot2D which this PlotInfo belongs to.

Specified by:

getStackedPlot in interface PlotInfo

Returns:

the parent StackedPlot2D

getId

public Object getId()

Description copied from interface: PlotInfo

Gets the unique identifier assigned to this plot. This identifier can be used to retrieve this plot handle from the StackedPlot2D.

Specified by:

getId in interface PlotInfo

Returns:

the plot unique identifier

getOrder

public int getOrder()

Specified by:

getOrder in interface PlotInfo

Returns:

the ordering value for this plot

getSize

public int getSize()

Specified by:

getSize in interface PlotInfo

Returns:

the pixel size of this plot

setOrder

public void setOrder(int order)

Description copied from interface: PlotInfo

Sets the ordering of this plot relative to the other plots in the StackedPlot2D. The particular value does not matter, only the values relative to other plots. All plots start with order 0. Plots with the same order value are arranged in the order they were added to the StackedPlot2D.

Specified by:

setOrder in interface PlotInfo

Parameters:

order - the ordering value for this plot

setSize

public void setSize(int size)

Description copied from interface: PlotInfo

Sets the size in pixels for this plot. If size < 0, then the plot will attempt to fill all available space, sharing space evenly with other plots with negative size.

For a VERTICAL oriented plot, setSize( ) adjusts the plot height, for a HORIZONTAL oriented plot, the width is adjusted.

Specified by:

setSize in interface PlotInfo

Parameters:

size - the size of the plot in pixels.

isGrow

public boolean isGrow()

Specified by:

isGrow in interface PlotInfo

See Also:

PlotInfo.setGrow(boolean)

setGrow

public void setGrow(boolean grow)

Description copied from interface: PlotInfo

Sets the plot to fill all available space. First, fixed size plots are given their space (set by PlotInfo.setSize(int)) and then all plots set to grow fill the remaining space.

Setting the plot size to a negative value is the same as setting grow to true (but this behavior is deprecated and PlotInfo.setGrow(boolean) should be used). Setting size to a positive value will set grow to false.

Specified by:

setGrow in interface PlotInfo

setPlotSpacing

public void setPlotSpacing(int spacing)

Description copied from interface: PlotInfo

Sets the spacing between this plot and those above and below it. This value overrides the default set via StackedTimePlot2D.setPlotSpacing(int). This controls the space between this plot and the one above or to the right of it. The spacing between this plot and the one below or to the left is controlled by the other plots spacing.

Specified by:

setPlotSpacing in interface PlotInfo

getPlotSpacing

public int getPlotSpacing()

Specified by:

getPlotSpacing in interface PlotInfo

See Also:

PlotInfo.setPlotSpacing(int)

getLayout

public GlimpseAxisLayout2D getLayout()

Description copied from interface: PlotInfo

Returns the GlimpseAxisLayout2D for this plot. This can be used to add subplots of painters to the plotting area.

Specified by:

getLayout in interface PlotInfo

getBaseLayout

public GlimpseAxisLayout2D getBaseLayout()

Description copied from interface: PlotInfo

Returns the base GlimpseLayout. If this plot is made of a single GlimpseLayout, #getLayout() and #getBaseLayout() will return the same GlimpseLayout. Otherwise, the result of #getLayout() will be a child of #getBaseLayout(). Further, #getBaseLayout() will be a direct child of the StackedPlot2D that this PlotInfo is part of.

Specified by:

getBaseLayout in interface PlotInfo

getCommonAxis

public Axis1D getCommonAxis(GlimpseTargetStack stack)

Description copied from interface: PlotInfo

Returns the common axis associated with the given GlimpseTargetStack. Users generally should simply call PlotInfo.getCommonAxis().

Specified by:

getCommonAxis in interface PlotInfo

getOrthogonalAxis

public Axis1D getOrthogonalAxis(GlimpseTargetStack stack)

Description copied from interface: PlotInfo

Returns the data axis associated with the given GlimpseTargetStack. Users generally should simply call PlotInfo.getOrthogonalAxis().

Specified by:

getOrthogonalAxis in interface PlotInfo

getCommonAxis

public Axis1D getCommonAxis()

Description copied from interface: PlotInfo

Returns the common axis shared by all the plots in a StackedPlot2D.

Specified by:

getCommonAxis in interface PlotInfo

Returns:

the shared axis for this plot

getOrthogonalAxis

public Axis1D getOrthogonalAxis()

Description copied from interface: PlotInfo

Returns the data axis associated with this plot. The data axes for each GlimpseLayout in a StackedPlot2D are unlinked by default, but they can be linked if desired using Axis1D.setParent( Axis1D ).

Specified by:

getOrthogonalAxis in interface PlotInfo

Returns:

the data axis for this plot

addLayout

public void addLayout(GlimpseAxisLayout2D childLayout)

Description copied from interface: PlotInfo

Adds the childLayout to the part of the StackedPlot2D represented by this LayoutInfo. Also links the common axis of the child to the common axis of the parent layout.

Specified by:

addLayout in interface PlotInfo

setLookAndFeel

public void setLookAndFeel(LookAndFeel laf)

Specified by:

setLookAndFeel in interface PlotInfo

updateLayout

public void updateLayout(int index)

Specified by:

updateLayout in interface PlotInfo

setVisible

public void setVisible(boolean visible)

Description copied from interface: PlotInfo

If true, the PlotInfo will be drawn as a row on the timeline, if false the PlotInfo will be hidden.

Specified by:

setVisible in interface PlotInfo

isVisible

public boolean isVisible()

Specified by:

isVisible in interface PlotInfo

See Also:

PlotInfo.setVisible(boolean)

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface PlotInfo

setParent

public void setParent(PlotInfo parent)

Specified by:

setParent in interface PlotInfo

getParent

public PlotInfo getParent()

Specified by:

getParent in interface PlotInfo

deletePlot

public void deletePlot()

Deprecated.

removePlot()

Specified by:

deletePlot in interface PlotInfo

removePlot

public void removePlot()

Description copied from interface: PlotInfo

Removes this plot from its StackedPlot2D. This has the same effect as calling StackedPlot2D.removePlot( this.getId( ) )

Specified by:

removePlot in interface PlotInfo

setIndentLevel

public void setIndentLevel(int level)

Description copied from interface: PlotInfo

Sets the indentation level of this plot. This can be

Specified by:

setIndentLevel in interface PlotInfo

getIndentLevel

public int getIndentLevel()

Specified by:

getIndentLevel in interface PlotInfo

See Also:

PlotInfo.setIndentLevel(int)