DasCanvas

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JLayeredPane
      - org.das2.graph.DasCanvas

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, Editable
```
public class DasCanvas
extends javax.swing.JLayeredPane
implements java.awt.print.Printable, Editable, javax.swing.Scrollable
```
Canvas for das2 graphics. The DasCanvas contains any number of DasCanvasComponents such as axes, plots, colorbars, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DasCanvas.CanvasAction`
`static class`	`DasCanvas.Cell`
`static class`	`DasCanvas.GlassPane` JPanel that lives above all other components, and is capable of blocking keyboard and mouse input from all components underneath.
`static class`	`DasCanvas.HotLine` TODO
`protected static class`	`DasCanvas.RowColumnLayout` Layout manager for managing the Row, Column layout implemented by swing.

Nested classes/interfaces inherited from class javax.swing.JLayeredPane
javax.swing.JLayeredPane.AccessibleJLayeredPane

Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`static javax.swing.Action`	`ABOUT_ACTION` Override Component.setBounds for debugging.
`static java.lang.Integer`	`ANNOTATION_LAYER` Z-Layer
`static java.lang.Integer`	`AXIS_LAYER` Z-Layer
`java.lang.String`	`broken`
`static java.lang.Integer`	`DEFAULT_LAYER` Default drawing layer of the JLayeredPane
`static javax.swing.Action`	`EDIT_DAS_PROPERTIES_ACTION`
`static java.lang.Integer`	`GLASS_PANE_LAYER` Z-Layer
`static java.lang.Integer`	`HORIZONTAL_AXIS_LAYER` Z-Layer
`static java.lang.Integer`	`PLOT_LAYER` Z-Layer for drawing the plot.
`static javax.swing.Action`	`PRINT_ACTION`
`static java.lang.String`	`PROP_BASEFONT` Property name for the base font.
`static java.lang.String`	`PROP_PAINTCOUNT`
`static java.lang.String`	`PROP_SCALEFONTS` The font used should be the base font scaled based on the canvas size.
`javax.swing.Action`	`PROPERTIES_ACTION`
`static javax.swing.Action`	`REFRESH_ACTION`
`static javax.swing.Action`	`SAVE_AS_PDF_ACTION`
`static javax.swing.Action`	`SAVE_AS_PNG_ACTION`
`static javax.swing.Action`	`SAVE_AS_SVG_ACTION`
`protected boolean`	`scaleFonts` The font used should be the base font scaled based on the canvas size.
`static java.lang.Integer`	`VERTICAL_AXIS_LAYER` Z-Layer for vertical axis.

Fields inherited from class javax.swing.JLayeredPane
DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Printable
NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`DasCanvas()` Creates a new instance of DasCanvas.
`DasCanvas(int width, int height)` Creates a new instance of DasCanvas with the specified width and height

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(DasCanvasComponent c, DasRow row, DasColumn column)` This methods adds the specified `DasCanvasComponent` to this canvas.
`void`	`addBottomDecorator(Painter painter)` add a decorator that will be painted on below all other objects.
`protected void`	`addImpl(java.awt.Component comp, java.lang.Object constraints, int index)` This is doing something special setting the LAYER_PROPERTY.
`void`	`addTopDecorator(Painter painter)` add a decorator that will be painted on top of all other objects.
`void`	`changePerformed(java.lang.Object client, java.lang.Object lockObject)` indicate to the canvas that a change is now complete.
`static boolean`	`childIsDirty(DasCanvas c)` scans through all the canvas components and returns true if any are in a "dirty" state and need repainting.
`static DasCanvas`	`createFormCanvas(java.lang.String name, int width, int height)`
`java.util.List`	`devicePositionList()` returns a list of all the rows and columns on the canvas.
`static javax.swing.Action[]`	`getActions()`
`DasApplication`	`getApplication()`
`java.awt.Font`	`getBaseFont()` the base font, which is the font or the font which is scaled when scaleFont is true.
`DasCanvasComponent`	`getCanvasComponentAt(int x, int y)` Returns the DasCanvasComponent that contains the (x, y) location.
`DasCanvasComponent[]`	`getCanvasComponents()` return the components.
`DasCanvasComponent`	`getCanvasComponents(int index)` return the component at the index.
`DasCanvas.Cell`	`getCellAt(int x, int y)` TODO
`DasApplication`	`getDasApplication()` return the application object for this canvas.
`java.lang.String`	`getDasName()` return the name identifying the component.
`java.util.List`	`getDevicePositionList()` return a list of all the rows and columns.
`DnDSupport`	`getDnDSupport()` TODO
`boolean`	`getEditingMode()` TODO
`static DasCanvas`	`getFocusCanvas()` return the canvas that has the focus.
`java.awt.Component`	`getGlassPane()` returns the GlassPane above all other components.
`java.awt.image.BufferedImage`	`getImage(int width, int height)` Creates a BufferedImage by blocking until the image is ready.
`java.lang.String`	`getImageMetadata()` returns JSON code that can be used to get plot positions and axes.
`java.awt.Image`	`getImageNonPrint(int width, int height)` Creates a BufferedImage by blocking until the image is ready.
`DasCanvas.HotLine`	`getLineAt(int x, int y)` TODO
`java.awt.Dimension`	`getMaximumSize()` simply returns getPreferredSize()
`int`	`getPaintCount()` provide a property which can be used to monitor updates.
`java.awt.Dimension`	`getPreferredScrollableViewportSize()`
`java.awt.print.Printable`	`getPrintable()` Returns an instance of `java.awt.print.Printable` that can be used to render this canvas to a printer.
`java.lang.String`	`getPrintingTag()` printingTag is the DateFormat string to use to tag printed images.
`int`	`getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)`
`boolean`	`getScrollableTracksViewportHeight()`
`boolean`	`getScrollableTracksViewportWidth()`
`int`	`getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)`
`boolean`	`hasBottomDecorators()` returns true if there are any bottom decorators.
`boolean`	`hasTopDecorators()` returns true if there are any top decorators.
`boolean`	`isAntiAlias()` true if data will be fully rendered with anti-aliasing.
`boolean`	`isDirty()` returns true if work needs to be done to make the canvas clean.
`boolean`	`isFitted()` If true, and the canvas was added to a scrollpane, the canvas will size itself to fit within the scrollpane.
`boolean`	`isPendingChanges()` returns true if there are changes pending.
`boolean`	`isPendingChanges(java.lang.Object lockObject)` ask the canvas if the particular change is already pending.
`protected boolean`	`isPrintingThread()` return true if the current thread is registered as the one printing this component.
`boolean`	`isScaleFonts()` true if the fonts should be rescaled as the window size is changed.
`boolean`	`isTextAntiAlias()` return true if fonts will be fully rendered.
`boolean`	`isValueAdjusting()` returns true if an operation is being performed that should be treated as atomic.
`boolean`	`lisPaintingForPrint()` Java1.6 has this function native
`void`	`makeCurrent()` make this the current canvas
`java.util.concurrent.locks.Lock`	`mutatorLock()` access the lock for an atomic operation.
`DasPlot`	`otherPlotOnTop(DasAxis aThis)` return a plot which shares this row and column, or null.
`protected void`	`paintComponent(java.awt.Graphics g1)` paints the canvas itself.
`void`	`pendingChanges(java.util.Map<java.lang.Object,java.lang.Object> result)` return a list of pending changes.
`void`	`performingChange(java.lang.Object client, java.lang.Object lockObject)` indicate to the canvas that a change is being performed.
`void`	`prepareForOutput(int width, int height)` resets the width and height, then waits for all update messages to be processed.
`void`	`print(java.awt.Graphics g1)` print the canvas, filling the background and the painting.
`int`	`print(java.awt.Graphics printGraphics, java.awt.print.PageFormat format, int pageIndex)` Prints the canvas, scaling and possibly rotating it to improve fit.
`void`	`registerPendingChange(java.lang.Object client, java.lang.Object lockObject)` indicate to the canvas that a change will be made soon.
`void`	`remove(java.awt.Component comp)` Removes the component, specified by `index`, from this container, calling its uninstallComponent method if it's a DasCanvasComponent.
`void`	`remove(int index)` Removes the component, specified by `index`, from this container, calling its uninstallComponent method if it's a DasCanvasComponent.
`void`	`removeBottomDecorator(Painter painter)` remove the decorator.
`void`	`removeBottomDecorators()` remove all bottom decorators.
`void`	`removeDasDevicePosition(DasDevicePosition position)` remove the device position from the list we keep track of.
`void`	`removepwDevicePosition(DasDevicePosition position)` Deprecated. use removeDasDevicePosition instead.
`void`	`removeTopDecorator(Painter painter)` remove the decorator.
`void`	`removeTopDecorators()` remove all top decorators.
`void`	`resizeAllComponents()` introduced as a kludgy way for clients to force the canvas to resize all of its components.
`void`	`setAntiAlias(boolean antiAlias)` true if data will be fully rendered with anti-aliasing.
`void`	`setApplication(DasApplication application)`
`void`	`setBaseFont(java.awt.Font font)` the base font, which is the font or the font which is scaled with canvas size when scaleFont is true.
`void`	`setDasName(java.lang.String name)` set the name identifying the component.
`static void`	`setDisableActions(boolean val)`
`void`	`setEditingMode(boolean b)` TODO
`void`	`setFitted(boolean fitted)` If true, and the canvas was added to a scrollpane, the canvas will size itself to fit within the scrollpane.
`void`	`setFont(java.awt.Font font)`
`void`	`setPreferredHeight(int height)` Sets the preferred height of the canvas to the specified height.
`void`	`setPreferredWidth(int width)` Sets the preferred width of the canvas to the specified width.
`void`	`setPrintingTag(java.lang.String printingTag)` printingTag is the string to use to tag printed images.
`void`	`setScaleFonts(boolean scaleFonts)` true if the fonts should be rescaled as the window size is changed.
`void`	`setTextAntiAlias(boolean textAntiAlias)` true if fonts will be fully rendered.
`boolean`	`startDrag(int x, int y, int action, java.awt.event.MouseEvent evt)` TODO
`java.lang.String`	`toString()`
`void`	`waitUntilIdle()` Blocks the caller's thread until all events have been dispatched from the awt event thread, and then waits for the RequestProcessor to finish all tasks with this canvas as the lock object.
`void`	`waitUntilIdle(boolean monitors)` blocks until everything is idle, including no active monitors.
`void`	`waitUntilValid()` process all pending operations and make sure we're repainted.
`void`	`writeToGraphicsOutput(java.io.OutputStream out, GraphicsOutput go)` write to various graphics devices such as png, pdf and svg.
`void`	`writeToGraphicsOutput(java.lang.String filename, java.lang.String graphicsOutput)` write to future implementations of graphicsOutput.
`void`	`writeToImageImmediately(java.awt.Image image)` Writes on to the image without waiting, using the print method.
`void`	`writeToImageImmediatelyNoCount(java.awt.Image image)` silly code so that Autoplot can get an image without incrementing paintCount.
`void`	`writeToImageImmediatelyNonPrint(java.awt.Image image)` This by passes the normal print method used in writeToImageImmedately, which sets the printing flags which tell the components, like DasPlot, to fully reset.
`void`	`writeToPDF(java.lang.String filename)` write the canvas to a PDF file.
`void`	`writeToPng(java.io.OutputStream out, int w, int h)` uses getImage to get an image of the canvas and encodes it as a png.
`void`	`writeToPng(java.lang.String filename)` uses getImage to get an image of the canvas and encodes it as a png.
`void`	`writeToSVG(java.lang.String filename)`

Methods inherited from class javax.swing.JLayeredPane
getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, paramString, putLayer, removeAll, setLayer, setLayer, setPosition

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintImmediately, paintImmediately, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_LAYER
```
public static final java.lang.Integer DEFAULT_LAYER
```
    Default drawing layer of the JLayeredPane
  - PLOT_LAYER
```
public static final java.lang.Integer PLOT_LAYER
```
    Z-Layer for drawing the plot.
  - VERTICAL_AXIS_LAYER
```
public static final java.lang.Integer VERTICAL_AXIS_LAYER
```
    Z-Layer for vertical axis. Presently lower than the horizontal axis, presumably to remove ambiguity
  - HORIZONTAL_AXIS_LAYER
```
public static final java.lang.Integer HORIZONTAL_AXIS_LAYER
```
    Z-Layer
  - AXIS_LAYER
```
public static final java.lang.Integer AXIS_LAYER
```
    Z-Layer
  - ANNOTATION_LAYER
```
public static final java.lang.Integer ANNOTATION_LAYER
```
    Z-Layer
  - GLASS_PANE_LAYER
```
public static final java.lang.Integer GLASS_PANE_LAYER
```
    Z-Layer
  - SAVE_AS_PNG_ACTION
```
public static final javax.swing.Action SAVE_AS_PNG_ACTION
```
  - SAVE_AS_SVG_ACTION
```
public static final javax.swing.Action SAVE_AS_SVG_ACTION
```
  - SAVE_AS_PDF_ACTION
```
public static final javax.swing.Action SAVE_AS_PDF_ACTION
```
  - EDIT_DAS_PROPERTIES_ACTION
```
public static final javax.swing.Action EDIT_DAS_PROPERTIES_ACTION
```
  - PRINT_ACTION
```
public static final javax.swing.Action PRINT_ACTION
```
  - REFRESH_ACTION
```
public static final javax.swing.Action REFRESH_ACTION
```
  - ABOUT_ACTION
```
public static final javax.swing.Action ABOUT_ACTION
```
    Override Component.setBounds for debugging.
  - PROPERTIES_ACTION
```
public final javax.swing.Action PROPERTIES_ACTION
```
  - broken
```
public java.lang.String broken
```
  - scaleFonts
```
protected boolean scaleFonts
```
    The font used should be the base font scaled based on the canvas size. If this is false, then the canvas font is simply the base font.
  - PROP_SCALEFONTS
```
public static final java.lang.String PROP_SCALEFONTS
```
    The font used should be the base font scaled based on the canvas size. If this is false, then the canvas font is simply the base font.
    
    See Also:
    
    Constant Field Values
  - PROP_BASEFONT
```
public static final java.lang.String PROP_BASEFONT
```
    Property name for the base font.
    
    See Also:
    
    Constant Field Values
  - PROP_PAINTCOUNT
```
public static final java.lang.String PROP_PAINTCOUNT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DasCanvas
```
public DasCanvas()
```
    Creates a new instance of DasCanvas.
  - DasCanvas
```
public DasCanvas(int width,
                 int height)
```
    Creates a new instance of DasCanvas with the specified width and height
    
    Parameters:
    
    width - The width of the DasCanvas
    
    height - The height of the DasCanvas
- Method Detail
  - getFocusCanvas
```
public static DasCanvas getFocusCanvas()
```
    return the canvas that has the focus.
    
    Returns:
  - otherPlotOnTop
```
public DasPlot otherPlotOnTop(DasAxis aThis)
```
    return a plot which shares this row and column, or null.
    
    Parameters:
    
    aThis -
    
    Returns:
    
    a plot which shares this row and column, or null.
  - devicePositionList
```
public java.util.List devicePositionList()
```
    returns a list of all the rows and columns on the canvas.
    
    Returns:
  - setDisableActions
```
public static void setDisableActions(boolean val)
```
  - getActions
```
public static javax.swing.Action[] getActions()
```
  - addTopDecorator
```
public void addTopDecorator(Painter painter)
```
    add a decorator that will be painted on top of all other objects. Each decorator object should complete painting within 100 milliseconds, and the total for all decorators should not exceed 300 milliseconds. This should be done on the event thread.
    
    Parameters:
    
    painter -
  - removeTopDecorator
```
public void removeTopDecorator(Painter painter)
```
    remove the decorator. This should be done on the event thread.
    
    Parameters:
    
    painter -
  - removeTopDecorators
```
public void removeTopDecorators()
```
    remove all top decorators. This should be done on the event thread.
  - hasTopDecorators
```
public boolean hasTopDecorators()
```
    returns true if there are any top decorators.
    
    Returns:
    
    true if there are any decorators.
  - addBottomDecorator
```
public void addBottomDecorator(Painter painter)
```
    add a decorator that will be painted on below all other objects. Each decorator object should complete painting within 100 milliseconds, and the total for all decorators should not exceed 300 milliseconds. This should be done on the event thread.
    
    Parameters:
    
    painter -
  - removeBottomDecorator
```
public void removeBottomDecorator(Painter painter)
```
    remove the decorator. This should be done on the event thread.
    
    Parameters:
    
    painter -
  - removeBottomDecorators
```
public void removeBottomDecorators()
```
    remove all bottom decorators. This should be done on the event thread.
  - hasBottomDecorators
```
public boolean hasBottomDecorators()
```
    returns true if there are any bottom decorators.
    
    Returns:
    
    true if there are any decorators.
  - getGlassPane
```
public java.awt.Component getGlassPane()
```
    returns the GlassPane above all other components. This is used for drawing dragRenderers, etc.
    
    Returns:
  - getDevicePositionList
```
public java.util.List getDevicePositionList()
```
    return a list of all the rows and columns.
    
    Returns:
    
    a list of all the rows and columns.
  - getApplication
```
public DasApplication getApplication()
```
  - setApplication
```
public void setApplication(DasApplication application)
```
  - getMaximumSize
```
public java.awt.Dimension getMaximumSize()
```
    simply returns getPreferredSize()
    
    Overrides:
    
    getMaximumSize in class javax.swing.JComponent
    
    Returns:
    
    getPreferredSize()
  - paintComponent
```
protected void paintComponent(java.awt.Graphics g1)
```
    paints the canvas itself. If printing, stamps the date on it as well.
    
    Overrides:
    
    paintComponent in class javax.swing.JComponent
    
    Parameters:
    
    g1 - the Graphics object
  - print
```
public int print(java.awt.Graphics printGraphics,
                 java.awt.print.PageFormat format,
                 int pageIndex)
```
    Prints the canvas, scaling and possibly rotating it to improve fit.
    
    Specified by:
    
    print in interface java.awt.print.Printable
    
    Parameters:
    
    printGraphics - the Graphics object.
    
    format - the PageFormat object.
    
    pageIndex - should be 0, since the image will be on one page.
    
    Returns:
    
    Printable.PAGE_EXISTS or Printable.NO_SUCH_PAGE
  - isPrintingThread
```
protected final boolean isPrintingThread()
```
    return true if the current thread is registered as the one printing this component.
    
    Returns:
    
    true if the current thread is registered as the one printing this component.
  - lisPaintingForPrint
```
public boolean lisPaintingForPrint()
```
    Java1.6 has this function native
    
    Returns:
  - print
```
public void print(java.awt.Graphics g1)
```
    print the canvas, filling the background and the painting.
    
    Overrides:
    
    print in class javax.swing.JComponent
    
    Parameters:
    
    g1 - the graphics context.
  - getPrintable
```
public java.awt.print.Printable getPrintable()
```
    Returns an instance of java.awt.print.Printable that can be used to render this canvas to a printer. The current implementation returns a reference to this canvas. This method is provided so that in the future, the canvas can delegate it's printing to another object.
    
    Returns:
    
    a Printable instance for rendering this component.
  - getImageMetadata
```
public java.lang.String getImageMetadata()
```
    returns JSON code that can be used to get plot positions and axes.
    
    Returns:
  - writeToPng
```
public void writeToPng(java.io.OutputStream out,
                       int w,
                       int h)
                throws java.io.IOException
```
    uses getImage to get an image of the canvas and encodes it as a png. Note this now puts in a JSON representation of plot locations in the "plotInfo" tag. The plotInfo tag will contain:
    "size:[640,480]" "numberOfPlots:0" "plots: { ... }" where each plot contains: "title" "xaxis" "yaxis"
    See http://autoplot.org/richPng. It is the responsibility of the caller to close the stream.
    Parameters:
    
    out - the outputStream. This is left open, so the opener code must close it!
    
    w - width in pixels
    
    h - height in pixels
    
    Throws:
    
    java.io.IOException - if there is an error opening the file for writing
  - writeToPng
```
public void writeToPng(java.lang.String filename)
                throws java.io.IOException
```
    uses getImage to get an image of the canvas and encodes it as a png. Note this now puts in a JSON representation of plot locations in the "plotInfo" tag. See http://autoplot.org/richPng
    
    Parameters:
    
    filename - the specified filename
    
    Throws:
    
    java.io.IOException - if there is an error opening the file for writing
  - writeToPDF
```
public void writeToPDF(java.lang.String filename)
                throws java.io.IOException
```
    write the canvas to a PDF file.
    
    Parameters:
    
    filename - the PDF file name.
    
    Throws:
    
    java.io.IOException
  - writeToGraphicsOutput
```
public void writeToGraphicsOutput(java.io.OutputStream out,
                                  GraphicsOutput go)
                           throws java.io.IOException
```
    write to various graphics devices such as png, pdf and svg. This handles the synchronization and parameter settings.
    
    Parameters:
    
    out - OutputStream to receive the data
    
    go - GraphicsOutput object.
    
    Throws:
    
    java.io.IOException
  - writeToGraphicsOutput
```
public void writeToGraphicsOutput(java.lang.String filename,
                                  java.lang.String graphicsOutput)
                           throws java.io.IOException,
                                  java.lang.ClassNotFoundException,
                                  java.lang.InstantiationException,
                                  java.lang.IllegalAccessException
```
    write to future implementations of graphicsOutput.
    
    Parameters:
    
    filename -
    
    graphicsOutput -
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
    
    java.lang.InstantiationException
    
    java.lang.IllegalAccessException
    
    See Also:
    
    GraphicsOutput
  - writeToSVG
```
public void writeToSVG(java.lang.String filename)
                throws java.io.IOException
```
    Parameters:
    
    filename - the specified filename
    
    Throws:
    
    java.io.IOException - if there is an error opening the file for writing
  - isDirty
```
public boolean isDirty()
```
    returns true if work needs to be done to make the canvas clean. This checks each component's isDirty.
    
    Returns:
    
    true if work needs to be done to make the canvas clean
  - childIsDirty
```
public static boolean childIsDirty(DasCanvas c)
```
    scans through all the canvas components and returns true if any are in a "dirty" state and need repainting.
    
    Parameters:
    
    c -
    
    Returns:
    
    true if any canvas component is dirty.
  - waitUntilIdle
```
public void waitUntilIdle(boolean monitors)
                   throws java.lang.InterruptedException
```
    blocks until everything is idle, including no active monitors. PRESENTLY THIS DOES NOT CHECK MONITORS!
    
    Parameters:
    
    monitors -
    
    Throws:
    
    java.lang.InterruptedException
  - waitUntilIdle
```
public void waitUntilIdle()
```
    Blocks the caller's thread until all events have been dispatched from the awt event thread, and then waits for the RequestProcessor to finish all tasks with this canvas as the lock object.
  - pendingChanges
```
public void pendingChanges(java.util.Map<java.lang.Object,java.lang.Object> result)
```
    return a list of pending changes.
    
    Parameters:
    
    result -
    
    See Also:
    
    waitUntilIdle
  - resizeAllComponents
```
public void resizeAllComponents()
```
    introduced as a kludgy way for clients to force the canvas to resize all of its components. validate or revalidate should probably do this.
  - waitUntilValid
```
public void waitUntilValid()
```
    process all pending operations and make sure we're repainted. See PlotCommand in Autoplot.
  - prepareForOutput
```
public void prepareForOutput(int width,
                             int height)
```
    resets the width and height, then waits for all update messages to be processed. In headless mode, the GUI components are validated. This must not be called from the event queue, because it uses eventQueueBlocker!
    
    Parameters:
    
    width - the width of the output in pixels.
    
    height - the width of the output in pixels.
    
    Throws:
    
    java.lang.IllegalStateException - if called from the event queue.
  - getImage
```
public java.awt.image.BufferedImage getImage(int width,
                                             int height)
```
    Creates a BufferedImage by blocking until the image is ready. This includes waiting for datasets to load, etc. Works by submitting an invokeAfter request to the RequestProcessor that calls writeToImageImmediately(Image).
    
    Parameters:
    
    width -
    
    height -
    
    Returns:
    
    a BufferedImage
  - getImageNonPrint
```
public java.awt.Image getImageNonPrint(int width,
                                       int height)
```
    Creates a BufferedImage by blocking until the image is ready. This includes waiting for datasets to load, etc. Works by submitting an invokeAfter request to the RequestProcessor that calls writeToImageImmediately(Image). Note, this calls writeToImageImmediatelyNonPrint, which avoids the usual overhead of revalidating the DasPlot elements we normally do when printing to a new device.
    
    Parameters:
    
    width -
    
    height -
    
    Returns:
    
    an Image
  - writeToImageImmediately
```
public void writeToImageImmediately(java.awt.Image image)
```
    Writes on to the image without waiting, using the print method. The graphics context is accessed with image.getGraphics.
    
    Parameters:
    
    image - the image
  - writeToImageImmediatelyNoCount
```
public void writeToImageImmediatelyNoCount(java.awt.Image image)
```
    silly code so that Autoplot can get an image without incrementing paintCount.
    
    Parameters:
    
    image -
  - writeToImageImmediatelyNonPrint
```
public void writeToImageImmediatelyNonPrint(java.awt.Image image)
```
    This by passes the normal print method used in writeToImageImmedately, which sets the printing flags which tell the components, like DasPlot, to fully reset. This was introduced so that Autoplot could get thumbnails and an image of the canvas for its layout tab without having to reset.
    
    Parameters:
    
    image - the image
  - add
```
public void add(DasCanvasComponent c,
                DasRow row,
                DasColumn column)
```
    This methods adds the specified DasCanvasComponent to this canvas.
    
    Parameters:
    
    c - the component to be added to this canvas Note that the canvas will need to be revalidated after the component is added.
    
    row - DasRow specifying the layout of the component.
    
    column - DasColumn specifying the layout of the component.
  - addImpl
```
protected void addImpl(java.awt.Component comp,
                       java.lang.Object constraints,
                       int index)
```
    This is doing something special setting the LAYER_PROPERTY. We check to see if the property is already set, and if it is not then we set it to the default value. (This is to allow client code to set it before adding the component.)
    
    Overrides:
    
    addImpl in class javax.swing.JLayeredPane
    
    Parameters:
    
    comp -
    
    constraints -
    
    index -
  - setPreferredWidth
```
public void setPreferredWidth(int width)
```
    Sets the preferred width of the canvas to the specified width.
    
    Parameters:
    
    width - the specified width.
  - setPreferredHeight
```
public void setPreferredHeight(int height)
```
    Sets the preferred height of the canvas to the specified height.
    
    Parameters:
    
    height - the specified height
  - isScaleFonts
```
public boolean isScaleFonts()
```
    true if the fonts should be rescaled as the window size is changed.
    
    Returns:
    
    true if the fonts should be rescaled as the window size is changed.
  - setScaleFonts
```
public void setScaleFonts(boolean scaleFonts)
```
    true if the fonts should be rescaled as the window size is changed.
    
    Parameters:
    
    scaleFonts - true if the fonts should be rescaled as the window size is changed.
  - getBaseFont
```
public java.awt.Font getBaseFont()
```
    the base font, which is the font or the font which is scaled when scaleFont is true.
    
    Returns:
    
    the base font, which is the font or the font which is scaled when scaleFont is true.
  - setBaseFont
```
public void setBaseFont(java.awt.Font font)
```
    the base font, which is the font or the font which is scaled with canvas size when scaleFont is true.
    
    Parameters:
    
    font - the font used to derive all other fonts.
  - setFont
```
public void setFont(java.awt.Font font)
```
    Overrides:
    
    setFont in class javax.swing.JComponent
  - getCanvasComponentAt
```
public DasCanvasComponent getCanvasComponentAt(int x,
                                               int y)
```
    Returns the DasCanvasComponent that contains the (x, y) location. If there is no component at that location, this method returns null
    
    Parameters:
    
    x - the x coordinate
    
    y - the y coordinate
    
    Returns:
    
    the component at the specified point, or null
  - remove
```
public void remove(int index)
```
    Removes the component, specified by index, from this container, calling its uninstallComponent method if it's a DasCanvasComponent.
    
    Overrides:
    
    remove in class javax.swing.JLayeredPane
    
    Parameters:
    
    index - the index of the component to be removed.
  - remove
```
public void remove(java.awt.Component comp)
```
    Removes the component, specified by index, from this container, calling its uninstallComponent method if it's a DasCanvasComponent.
    
    Overrides:
    
    remove in class java.awt.Container
    
    Parameters:
    
    comp - the component
  - getLineAt
```
public DasCanvas.HotLine getLineAt(int x,
                                   int y)
```
    TODO
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - getCellAt
```
public DasCanvas.Cell getCellAt(int x,
                                int y)
```
    TODO
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - removeDasDevicePosition
```
public void removeDasDevicePosition(DasDevicePosition position)
```
    remove the device position from the list we keep track of. Note those with parent rows and columns should not be registered (or at least existing code doesn't add it).
    
    Parameters:
    
    position -
  - removepwDevicePosition
```
public void removepwDevicePosition(DasDevicePosition position)
```
    Deprecated. use removeDasDevicePosition instead.
    
    TODO
    
    Parameters:
    
    position -
  - createFormCanvas
```
public static DasCanvas createFormCanvas(java.lang.String name,
                                         int width,
                                         int height)
```
    Parameters:
    
    name -
    
    width -
    
    height -
    
    Returns:
    
    DasCanvas with a name.
  - getEditingMode
```
public boolean getEditingMode()
```
    TODO
    
    Returns:
  - setEditingMode
```
public void setEditingMode(boolean b)
```
    TODO
    
    Parameters:
    
    b -
  - getDnDSupport
```
public DnDSupport getDnDSupport()
```
    TODO
    
    Returns:
  - startDrag
```
public boolean startDrag(int x,
                         int y,
                         int action,
                         java.awt.event.MouseEvent evt)
```
    TODO
    
    Parameters:
    
    x -
    
    y -
    
    action -
    
    evt -
    
    Returns:
  - getDasName
```
public java.lang.String getDasName()
```
    return the name identifying the component.
    
    Returns:
    
    the name identifying the component.
  - setDasName
```
public void setDasName(java.lang.String name)
                throws DasNameException
```
    set the name identifying the component.
    
    Parameters:
    
    name - the name identifying the component.
    
    Throws:
    
    DasNameException - when the name is not a valid name ("[A-Za-z][A-Za-z0-9_]*")
  - getPaintCount
```
public int getPaintCount()
```
    provide a property which can be used to monitor updates.
    
    Returns:
    
    arbitrary int which will change as the canvas is painted.
  - getDasApplication
```
public DasApplication getDasApplication()
```
    return the application object for this canvas.
    
    Returns:
    
    the application object for this canvas.
  - getCanvasComponents
```
public DasCanvasComponent getCanvasComponents(int index)
```
    return the component at the index.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the component at the index.
  - getCanvasComponents
```
public DasCanvasComponent[] getCanvasComponents()
```
    return the components.
    
    Returns:
    
    the components.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.awt.Component
  - getPrintingTag
```
public java.lang.String getPrintingTag()
```
    printingTag is the DateFormat string to use to tag printed images.
    
    Returns:
    
    Value of property printingTag.
  - setPrintingTag
```
public void setPrintingTag(java.lang.String printingTag)
```
    printingTag is the string to use to tag printed images. This can be 'yyyymmdd (SimpleDateFormat) or $Y$m$d, or just a string.
    
    Parameters:
    
    printingTag - New value of property printingTag.
  - isTextAntiAlias
```
public boolean isTextAntiAlias()
```
    return true if fonts will be fully rendered.
    
    Returns:
    
    true if fonts will be fully rendered.
  - setTextAntiAlias
```
public void setTextAntiAlias(boolean textAntiAlias)
```
    true if fonts will be fully rendered.
    
    Parameters:
    
    textAntiAlias - true if fonts will be fully rendered.
  - isAntiAlias
```
public boolean isAntiAlias()
```
    true if data will be fully rendered with anti-aliasing.
    
    Returns:
    
    true if data will be fully rendered with anti-aliasing.
  - setAntiAlias
```
public void setAntiAlias(boolean antiAlias)
```
    true if data will be fully rendered with anti-aliasing.
    
    Parameters:
    
    antiAlias - if data will be fully rendered with anti-aliasing.
  - isFitted
```
public boolean isFitted()
```
    If true, and the canvas was added to a scrollpane, the canvas will size itself to fit within the scrollpane.
    
    Returns:
    
    value of fitted property
  - setFitted
```
public void setFitted(boolean fitted)
```
    If true, and the canvas was added to a scrollpane, the canvas will size itself to fit within the scrollpane.
    
    Parameters:
    
    fitted - value of fitted property
  - makeCurrent
```
public final void makeCurrent()
```
    make this the current canvas
  - getPreferredScrollableViewportSize
```
public java.awt.Dimension getPreferredScrollableViewportSize()
```
    Specified by:
    
    getPreferredScrollableViewportSize in interface javax.swing.Scrollable
  - getScrollableUnitIncrement
```
public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
                                      int orientation,
                                      int direction)
```
    Specified by:
    
    getScrollableUnitIncrement in interface javax.swing.Scrollable
  - getScrollableBlockIncrement
```
public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
                                       int orientation,
                                       int direction)
```
    Specified by:
    
    getScrollableBlockIncrement in interface javax.swing.Scrollable
  - getScrollableTracksViewportWidth
```
public boolean getScrollableTracksViewportWidth()
```
    Specified by:
    
    getScrollableTracksViewportWidth in interface javax.swing.Scrollable
  - getScrollableTracksViewportHeight
```
public boolean getScrollableTracksViewportHeight()
```
    Specified by:
    
    getScrollableTracksViewportHeight in interface javax.swing.Scrollable
  - isPendingChanges
```
public boolean isPendingChanges(java.lang.Object lockObject)
```
    ask the canvas if the particular change is already pending.
    
    Parameters:
    
    lockObject - an object identifying the change
    
    Returns:
    
    true if that particular change is pending.
    
    See Also:
    
    ChangesSupport
  - registerPendingChange
```
public void registerPendingChange(java.lang.Object client,
                                  java.lang.Object lockObject)
```
    indicate to the canvas that a change will be made soon. For example, the canvas should wait for the change to be performed before creating an image.
    
    Parameters:
    
    client - the client registering the change
    
    lockObject - an object identifying the change
    
    See Also:
    
    ChangesSupport
  - performingChange
```
public void performingChange(java.lang.Object client,
                             java.lang.Object lockObject)
```
    indicate to the canvas that a change is being performed.
    
    Parameters:
    
    client - the client registering the change
    
    lockObject - an object identifying the change
    
    See Also:
    
    ChangesSupport
  - changePerformed
```
public void changePerformed(java.lang.Object client,
                            java.lang.Object lockObject)
```
    indicate to the canvas that a change is now complete.
    
    Parameters:
    
    client - the client registering the change
    
    lockObject - an object identifying the change
    
    See Also:
    
    ChangesSupport
  - isPendingChanges
```
public boolean isPendingChanges()
```
    returns true if there are changes pending.
    
    Returns:
    
    true if there are changes pending.
    
    See Also:
    
    ChangesSupport
  - mutatorLock
```
public java.util.concurrent.locks.Lock mutatorLock()
```
    access the lock for an atomic operation.
    
    Returns:
    
    the lock.
    
    See Also:
    
    ChangesSupport
  - isValueAdjusting
```
public boolean isValueAdjusting()
```
    returns true if an operation is being performed that should be treated as atomic.
    
    Returns:
    
    true if an operation is being performed that should be treated as atomic.
    
    See Also:
    
    ChangesSupport

Class DasCanvas

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JLayeredPane

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JLayeredPane

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.print.Printable

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JLayeredPane

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LAYER

PLOT_LAYER

VERTICAL_AXIS_LAYER

HORIZONTAL_AXIS_LAYER

AXIS_LAYER

ANNOTATION_LAYER

GLASS_PANE_LAYER

SAVE_AS_PNG_ACTION

SAVE_AS_SVG_ACTION

SAVE_AS_PDF_ACTION

EDIT_DAS_PROPERTIES_ACTION

PRINT_ACTION

REFRESH_ACTION

ABOUT_ACTION

PROPERTIES_ACTION

broken

scaleFonts

PROP_SCALEFONTS

PROP_BASEFONT

PROP_PAINTCOUNT

Constructor Detail

DasCanvas

DasCanvas

Method Detail

getFocusCanvas

otherPlotOnTop

devicePositionList

setDisableActions

getActions

addTopDecorator

removeTopDecorator

removeTopDecorators

hasTopDecorators

addBottomDecorator

removeBottomDecorator

removeBottomDecorators

hasBottomDecorators

getGlassPane

getDevicePositionList

getApplication

setApplication

getMaximumSize

paintComponent

print

isPrintingThread

lisPaintingForPrint

print

getPrintable

getImageMetadata

writeToPng

writeToPng

writeToPDF

writeToGraphicsOutput

writeToGraphicsOutput

writeToSVG

isDirty

childIsDirty

waitUntilIdle

waitUntilIdle

pendingChanges