org.autoplot.dom

Class PlotController

java.lang.Object

org.autoplot.dom.DomNodeController

org.autoplot.dom.PlotController

public final class PlotController
extends DomNodeController

Manages a Plot node, for example listening for autoRange updates and layout changes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoBinding
java.util.List<PlotElement>	pdListen the plot elements we listen to for autoranging.
protected javax.swing.JMenuItem	plotElementPropsMenuItem
static java.lang.String	PROP_AUTOBINDING true indicates that the controller is allowed to automatically add bindings to the plot axes.
static java.lang.String	PROP_PLOTELEMENTPROPSMENUITEM
java.beans.PropertyChangeListener	rowColListener

Fields inherited from class org.autoplot.dom.DomNodeController

changesSupport, propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
PlotController(Application dom, Plot plot)
PlotController(Application dom, Plot domPlot, DasPlot dasPlot, DasColorBar colorbar)

Method Summary

Modifier and Type	Method and Description
protected void	addPlotElement(PlotElement p, boolean reset) add the plot element to the plot, including the renderer and bindings.
Plot	contextOverview() add a context overview.
protected void	createDasPeer(Canvas canvas, Row domRow, Column domColumn) Create the das2 GUI components that implement the plot.
static void	doHints(Axis axis, java.lang.String hintsString) implement hints like width=40&includeZero=T.
protected void	doPlotElementDefaultsUnitsChange(PlotElement e) See sourceforge ticket.
Application	getApplication()
BindingModel[]	getBindings()
BindingModel	getBindings(int index)
Column	getColumn() return the row for this plot.
DasColorBar	getDasColorBar()
DasPlot	getDasPlot()
javax.swing.JMenuItem[]	getExpertMenuItems()
Plot	getPlot()
PlotElement	getPlotElement() return the plotElement we are listening to.
javax.swing.JMenuItem	getPlotElementPropsMenuItem()
Row	getRow() return the row for this plot.
boolean	isAutoBinding()
void	moveToJustAbove(PlotElement reference, PlotElement p) move the plot element to just above the reference element.
void	moveToJustBelow(PlotElement reference, PlotElement p) move the plot element to just below the reference element.
protected void	removeBindings() remove the bindings created in bindTo.
protected void	removePlotElement(PlotElement p) remove the plot element from this plot: remove renderer, remove bindings, etc.
protected void	removeReferences() remove references this controller has so that they are more likely to be garbage collected.
void	resetZoom(boolean x, boolean y, boolean z) set the zoom so that all of the plotElements' data is visible.
void	setAutoBinding(boolean autoBinding)
void	setExpertMenuItems(javax.swing.JMenuItem[] items) provide spot to locate the menu items that are hidden in basic mode.
void	setExpertMode(boolean expert)
void	setPlotElementPropsMenuItem(javax.swing.JMenuItem pelePropsMenuItem)
void	setTitleAutomatically(java.lang.String title) set the title, leaving autoLabel true.
void	toBottom(PlotElement p) move the plot element to the bottom.
java.lang.String	toString()
void	toTop(PlotElement p) move the plot element to the top.

Methods inherited from class org.autoplot.dom.DomNodeController

addPropertyChangeListener, addPropertyChangeListener, changePerformed, containsString, getController, insertString, isPendingChanges, isValueAdjusting, mutatorLock, pendingChanges, performingChange, printStats, registerPendingChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

pdListen

public java.util.List<PlotElement> pdListen

the plot elements we listen to for autoranging.

rowColListener

public java.beans.PropertyChangeListener rowColListener

PROP_AUTOBINDING

public static final java.lang.String PROP_AUTOBINDING

true indicates that the controller is allowed to automatically add bindings to the plot axes.

See Also:

Constant Field Values

autoBinding

protected boolean autoBinding

plotElementPropsMenuItem

protected javax.swing.JMenuItem plotElementPropsMenuItem

PROP_PLOTELEMENTPROPSMENUITEM

public static final java.lang.String PROP_PLOTELEMENTPROPSMENUITEM

See Also:

Constant Field Values

Constructor Detail

PlotController

public PlotController(Application dom,
                      Plot domPlot,
                      DasPlot dasPlot,
                      DasColorBar colorbar)

PlotController

public PlotController(Application dom,
                      Plot plot)

Method Detail

getPlot

public Plot getPlot()

isAutoBinding

public boolean isAutoBinding()

setAutoBinding

public void setAutoBinding(boolean autoBinding)

createDasPeer

protected void createDasPeer(Canvas canvas,
                             Row domRow,
                             Column domColumn)

Create the das2 GUI components that implement the plot. This should be called from the event thread.

Parameters:

canvas - the canvas containing the item

domRow - the row indicating the vertical position

domColumn - the column indicating the horizontal position

getDasColorBar

public DasColorBar getDasColorBar()

getDasPlot

public DasPlot getDasPlot()

doHints

public static void doHints(Axis axis,
                           java.lang.String hintsString)

implement hints like width=40&includeZero=T.

 includeZero   T or F     make sure that zero is within the result.
 min           0          make zero be the minimum value.
 max           100        make 100 be the maximum value
 width         30nT       use this width.  This is a formatted datum which 
                          is parsed with the units of the axis, or with the number of cycles for log.
 log           T or F     force log or linear axis
 widths        30nT,300nT,3000nT   use one of these widths
 center        0          constrain the center to be this location
 extend        10         percent to extend the range beyond the min and the max, so the width is this percent more.  This is done after other constraints.
               0,10       percent the max by ten percent.
 (not yet) reluctant     T or F     use the old range if it is acceptable.
 

Width or width imply that extend=0, but extend=10 may become the default.

Parameters:

axis - the axis to which we are applying the hints.

hintsString - the string, ampersand-delimited; or null when no hints should be applied.

resetZoom

public void resetZoom(boolean x,
                      boolean y,
                      boolean z)

set the zoom so that all of the plotElements' data is visible. This means finding the "union" of the plotElements' plotDefault ranges. If any plotElement's default log is false, then the new setting will be false.

Parameters:

x - reset zoom in the x dimension.

y - reset zoom in the y dimension.

z - reset zoom in the z dimension.

See Also:

AutoplotUtil.resetZoomX(org.autoplot.dom.Application, org.autoplot.dom.Plot), AutoplotUtil.resetZoomY(org.autoplot.dom.Application, org.autoplot.dom.Plot), AutoplotUtil.resetZoomZ(org.autoplot.dom.Application, org.autoplot.dom.Plot)

getPlotElement

public PlotElement getPlotElement()

return the plotElement we are listening to.

Returns:

toBottom

public void toBottom(PlotElement p)

move the plot element to the bottom.

Parameters:

p -

toTop

public void toTop(PlotElement p)

move the plot element to the top.

Parameters:

p - the plot element

moveToJustAbove

public void moveToJustAbove(PlotElement reference,
                            PlotElement p)

move the plot element to just above the reference element.

Parameters:

reference -

p -

moveToJustBelow

public void moveToJustBelow(PlotElement reference,
                            PlotElement p)

move the plot element to just below the reference element.

Parameters:

reference -

p -

addPlotElement

protected void addPlotElement(PlotElement p,
                              boolean reset)

add the plot element to the plot, including the renderer and bindings.

Parameters:

p -

reset - if true then reset the render type.

contextOverview

public Plot contextOverview()

add a context overview. This uses controllers, and should be rewritten so that it doesn't.

Returns:

the new plot which is the overview.

removePlotElement

protected void removePlotElement(PlotElement p)

remove the plot element from this plot: remove renderer, remove bindings, etc.

Parameters:

p -

doPlotElementDefaultsUnitsChange

protected void doPlotElementDefaultsUnitsChange(PlotElement e)

See sourceforge ticket. We've loaded an old vap file and we need to convert units.dimensionless to a correct unit.

Parameters:

e -

removeBindings

protected void removeBindings()

remove the bindings created in bindTo.

removeReferences

protected void removeReferences()

remove references this controller has so that they are more likely to be garbage collected. This must be called after removeBindings.

getBindings

public BindingModel[] getBindings()

getBindings

public BindingModel getBindings(int index)

getPlotElementPropsMenuItem

public javax.swing.JMenuItem getPlotElementPropsMenuItem()

setPlotElementPropsMenuItem

public void setPlotElementPropsMenuItem(javax.swing.JMenuItem pelePropsMenuItem)

getApplication

public Application getApplication()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setTitleAutomatically

public void setTitleAutomatically(java.lang.String title)

set the title, leaving autoLabel true.

Parameters:

title -

setExpertMenuItems

public void setExpertMenuItems(javax.swing.JMenuItem[] items)

provide spot to locate the menu items that are hidden in basic mode.

Parameters:

items -

getExpertMenuItems

public javax.swing.JMenuItem[] getExpertMenuItems()

setExpertMode

public void setExpertMode(boolean expert)

getRow

public Row getRow()

return the row for this plot. This just calls dom.canvases.get(0).getController().getRowFor(this.plot);

Returns:

getColumn

public Column getColumn()

return the row for this plot. This just calls dom.canvases.get(0).getController().getRowFor(this.plot);

Returns: