JPane

Documentation of 'sgtplot.JPane' Java class JPane

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JLayeredPane
      - sgtplot.JPane

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, AbstractPane

Direct Known Subclasses:

JGraphicLayout, JPlotPane
```
public class JPane
extends javax.swing.JLayeredPane
implements AbstractPane, javax.swing.Scrollable, java.awt.print.Printable
```
The JPane class is extended from javax.swing.JLayeredPane and is the basis for using the gov.noaa.pmel.sgt package with swing components.
The Java scientific graphics toolkit is designed to allow a graphics client developer a great deal of flexibility and freedom. sgtplot is a package that greatly aids a developer in creating graphics applets. sgtplot is not a general purpose graphics package, but provides the tools to enable scientific graphics to be easily incorporated into JApplet.
sgtplot has three main components, the "pane", on which all graphics are drawn. The JPane is a fairly simple class and all drawing is done in "device" coordinates (pixels). By default, the JPane will draw on the screen, but it is designed to allow drawing in an offscreen buffer that can be printed (for applications).
The next component is the Layer. Several Layers can be associated with a single JPane. The Layer class insulates the developer from the details of device coordinates by using "physical" coordinates. Physical coordinates are a right-hand coordinate systems with an origin of (0.0, 0.0) in the lower-left-hand corner and have the same scale in both the vertical and horizontal directions. Thus, a Layer that is 5.0 units wide and 3.0 units high can be made larger and smaller on the screen by resizing the JPane, but will not be distorted. The Layer class is responsible for displaying labels, keys (color, vector, and line), and rulers. A Layer can contain a single Graph.
Finally, the Graph component transforms from user coordinates (e.g. cm/sec, time, degC, or meters) to physical coordinates. The Graph classes handle the display of axes and data. Children of the Graph class are capable of creating Cartesian, polar, and map graphics. For Cartesian graphs, several different axes (log, plain and time), transforms (linear, log, and tablelookup), and CartesianGraph (pixel, line, vector, and contour) classes are available. These classes can be combined in almost any combination.
While only one dataset may be plotted per Layer, co-plotting is supported by allowing layers to use the same transform objects. The order that the layers are plotted can be changed, allowing the developer (or user) to control what may be obscured.
Member functions, in package gov.noaa.pmel.sgt, follow the following naming convention. Member functions that have a P, U, or nothing at the end of the function name are of type double in Physical units, type double in User units, and type int in Device units, respectively. Variables that start with p, u, t, or d are coordinates of type physical, user, time, or device, respectively.
All graphics are rendered when the draw() method is invoked.
Mouse Events
Mouse events are processed by the JPane object to support object selection and zooming. Object selection is accomplished by left clicking the mouse on the desired object. JPane then fires a PropertyChangeEvent of type "objectSelected" that can be listened for by the users application. The user application then invokes the getSelectedObject() method. Zooming is accomplished in several steps.
```
 1) Begin a zoom operation by pressing the left button.
 2) Describe a zoom rectangle by dragging the mouse with the left
    button down.
 3) Finish the zoom operation by releasing the left mouse button.
 
```
When the mouse button has been release JPane fires a PropertyChangeEvent of type "zoomRectangle" that can be listened for by the users application. The user application can then obtain the zoom rectangle by invoking the getZoomBounds() method.
```
 ...
 //
 // register the PropertyChangeListener listener with pane
 // (assuming that application implements PropertyChangeListener)
 //
 mainPane_.addPropertyChangeListener(this);
 //
 ...
 //
 // Implement the propertyChange() method and listen for events
 //
  public void propertyChange(PropertyChangeEvent event) {
    //
    // Listen for property change events from JPane
    //
    String name = event.getPropertyName();
    if(name.equals("zoomRectangle")) {
      //
      // compute zoom rectangle in user units
      //
      Range2D xr = new Range2D();
      Range2D yr = new Range2D();
      Rectangle zm = (Rectangle)event.getNewValue();
      //
      // if rectangle size is one pixel or less return
      //
      if(zm.width <= 1 || zm.height <= 1) return;
      xr.start = graph_.getXPtoU(layer_.getXDtoP(zm.x));
      xr.end = graph_.getXPtoU(layer_.getXDtoP(zm.x + zm.width));
      if(xr.start > xr.end) {
        double temp = xr.start;
        xr.start = xr.end;
        xr.end = temp;
      }
      yr.start = graph_.getYPtoU(layer_.getYDtoP(zm.y));
      yr.end = graph_.getYPtoU(layer_.getYDtoP(zm.y + zm.height));
      if(yr.start > yr.end) {
        double temp = yr.start;
        yr.start = yr.end;
        yr.end = temp;
      }
      //
      // turn batching on so all changes will appear at the
      // same time
      //
      mainPane_.setBatch(true);
      //
      // set range for transforms
      //
      xt_.setRangeU(xr);
      yt_.setRangeU(yr);
      //
      // set range and origin for axes
      //
      Point2D.Double orig = new Point2D.Double(xr.start, yr.start);
      xbot_.setRangeU(xr);
      xbot_.setLocationU(orig);

      yleft_.setRangeU(yr);
      yleft_.setLocationU(orig);
      //
      // set clipping on all graphs
      //
      Component[] comps = mainPane_.getComponents();
      Layer ly;
      for(int i=0; i < comps.length; i++) {
        if(comps[i] instanceof Layer) {
          ly = (Layer)comps[i];
          ((CartesianGraph)ly.getGraph()).setClip(xr.start, xr.end,
                                                  yr.start, yr.end);
        }
      }
      //
      // done with sgtplot modifications, turn batching off
      //
      mainPane_.setBatch(false);
    } else if(name.equals("objectSelected")) {
      //
      // An sgtplot object has been selected.
      // If it is a PointCartesianRenderer that means the key has been
      // selected and so open a dialog to modified the PointAttribute.
      //
      if(event.getNewValue() instanceof PointCartesianRenderer) {
          PointAttribute pattr =
            ((PointCartesianRenderer)event.getNewValue()).getPointAttribute();
          if(pAttrDialog_ == null) {
            pAttrDialog_ = new PointAttributeDialog();
          }
          pAttrDialog_.setPointAttribute(pattr, mainPane_);
          pAttrDialog_.setVisible(true);
      } else {
          //
          // Print the name of the object selected.
          //
          System.out.println("objectSelected = " + event.getNewValue());
      }
    }
  }
 
```
Since:

2.0

See Also:

Layer, Graph, Graphics, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.BaselineResizeBehavior

Field Summary
- Fields inherited from class javax.swing.JLayeredPane
  DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER
- Fields inherited from class javax.swing.JComponent
  TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class java.awt.Component
  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface sgtplot.AbstractPane
  BOTTOM, CENTER, DEFAULT_SCALE, LEFT, MIDDLE, RIGHT, SHRINK_TO_FIT, SPECIFIED_LOCATION, TO_FIT, TOP
- 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

JPane()
Default constructor.

JPane(java.lang.String id, java.awt.Dimension size)
Constructs a Pane.

Constructors
Constructor and Description
`JPane()` Default constructor.
`JPane(java.lang.String id, java.awt.Dimension size)` Constructs a `Pane`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.awt.Component`	`add(java.awt.Component comp)` Adds the specified component to the end of the `Pane`.
`java.awt.Component`	`add(java.awt.Component comp, int index)` Adds the specified component to the `Pane` at the given position.
`void`	`add(java.awt.Component comp, java.lang.Object constraints)` Adds the specified component to the end of this `Pane`.
`void`	`add(java.awt.Component comp, java.lang.Object constraints, int index)` Adds the specified component to the end of this `Pane` at the specified index.
`java.awt.Component`	`add(java.lang.String name, java.awt.Component comp)` Adds the specified component to this `Pane`.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)` Add a PropertyChangeListener to the list.
`void`	`draw()` The `AbstractPane` and all of the attached Classes will be drawn.
`void`	`draw(java.awt.Graphics g)` The `AbstractPane` and all of the attached Classes will be drawn.
`void`	`draw(java.awt.Graphics g, int width, int height)` The `AbstractPane` and all of the attached Classes will be drawn.
`void`	`draw(org.freehep.graphics2d.VectorGraphics g)`
`void`	`draw(org.freehep.graphics2d.VectorGraphics g, int width, int height)`
`void`	`draw(org.freehep.graphics2d.VectorGraphics g, java.lang.String s)`
`void`	`drawPage(org.freehep.graphics2d.VectorGraphics g, java.awt.print.PageFormat pf, boolean scale)`
`java.awt.Component`	`getComponent()` Get the `Component` associated with the pane.
`Layer`	`getFirstLayer()` Get the first `Layer` associated with the `Pane`
`java.lang.String`	`getId()` Get the `Pane` identifier.
`Layer`	`getLayer(java.lang.String id)` Get the `Layer` associated with the `Pane` indicated by the id.
`Layer`	`getLayerFromDataId(java.lang.String id)` Get the `Layer` associated with the `Pane` indicated by the data id.
`java.awt.Dimension`	`getMaximumSize()`
`java.awt.Dimension`	`getMinimumSize()`
`java.lang.Object`	`getObjectAt(int x, int y)` Get the current selected object at a point.
`java.lang.Object[]`	`getObjectsAt(int x, int y)` Return an array of objects whose bounds include x,y.
`java.lang.Object[]`	`getObjectsAt(java.awt.Point pt)` Return an array of objects whose bounds are at point pt.
`int`	`getPageHAlign()` Get horizontal alignment for printing.
`java.awt.Point`	`getPageOrigin()` Get the printer page origin.
`int`	`getPageScaleMode()` Get printing scale mode.
`java.awt.Dimension`	`getPageSize()` Get the printer page size.
`int`	`getPageVAlign()` Get vertical alignment for printing.
`java.awt.Dimension`	`getPreferredScrollableViewportSize()`
`java.awt.Dimension`	`getPreferredSize()`
`int`	`getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)`
`boolean`	`getScrollableTracksViewportHeight()`
`boolean`	`getScrollableTracksViewportWidth()`
`int`	`getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)`
`java.lang.Object`	`getSelectedObject()` Return the last object selected.
`static StrokeDrawer`	`getStrokeDrawer()` Internal method to access jdk1.1 or Java2D line drawing.
`static java.lang.String`	`getVersion()` Return the version of SGT.
`java.awt.Rectangle`	`getZoomBounds()` Get the current zoom bounding box.
`java.awt.Point`	`getZoomStart()` Return the device coordinates of the start of the zoom action.
`void`	`init()` No initialization required.
`boolean`	`isBatch()` Is batching turned on?
`boolean`	`isModified()` Has the plot been modified?
`boolean`	`isMouseEventsEnabled()` Are `MouseEvent`s enabled for processing by SGT?
`boolean`	`isPrinter()` Test if the current `Graphics` object is a printer.
`void`	`moveLayerDown(Layer lyr)` Move the `Layer` down in the stack.
`void`	`moveLayerDown(java.lang.String id)` Move the `Layer` down in the stack.
`void`	`moveLayerUp(Layer lyr)` Move the `Layer` up in the stack.
`void`	`moveLayerUp(java.lang.String id)` Move the `Layer` up in the stack.
`void`	`paintComponent(java.awt.Graphics g)` Override default painting by swing.
`int`	`print(java.awt.Graphics g, java.awt.print.PageFormat pf, int pageIndex)`
`void`	`processMouseEvent(java.awt.event.MouseEvent event)` Overrides the default event methods.
`void`	`processMouseMotionEvent(java.awt.event.MouseEvent event)` Used internally by sgtplot.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)` Remove the PropertyChangeListener from the list.
`void`	`setBatch(boolean batch)` Turn on/off batching of updates to the pane.
`void`	`setBatch(boolean batch, java.lang.String msg)` Turn on/off batching of updates to the pane.
`void`	`setId(java.lang.String id)` Set the `Pane` identifier
`void`	`setModified(boolean mod, java.lang.String mess)` Notify the pane that something has changed and a redraw is required.
`void`	`setMouseEventsEnabled(boolean enable)` Enable/disable the handling of `MouseEvent`s by SGT.
`void`	`setPageAlign(int vert, int horz)` Set alignment for printing.
`void`	`setPageHAlign(int horz)` Set horizontal alignment for printing.
`void`	`setPageOrigin(java.awt.Point p)` Set the printer page origin.
`void`	`setPageScaleMode(int mode)` Set printing scale mode.
`void`	`setPageVAlign(int vert)` Set vertical alignment for printing.
`void`	`setScrollableBlockIncrement(int horiz, int vert)` Set the horizontal and vertical block increments.
`void`	`setScrollableUnitIncrement(int horiz, int vert)` Set the horizontal and vertical unit increments.
`void`	`setSelectedObject(java.lang.Object obj)` Primarily used internally by sgtplot.
`void`	`setSize(java.awt.Dimension d)` Set the size.
`java.lang.String`	`toString()` Get a `String` representatinof the `Pane`.

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

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

Methods inherited from class java.awt.Container
addContainerListener, 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, remove, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

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

Methods inherited from interface sgtplot.AbstractPane
getBounds

- Constructor Detail
  - JPane
```
public JPane(java.lang.String id,
             java.awt.Dimension size)
```
    Constructs a Pane.
    
    Parameters:
    
    id - the Pane identifier
    
    size - the size of the Pane in pixels
  - JPane
```
public JPane()
```
    Default constructor. The identifier is set to an empty string and the size is set to a width and height of 50 pixels. A default constructor is required to work as a component with Visual Cafe.
```
 import gov.noaa.pmel.sgt.JPane;
 ...
 JPane pane;
 ...
 pane = new JPane("main graph", new Dimension(400, 500));
 pane.setLayout(new StackedLayout());
 ...
 
```
    See Also:
    
    StackedLayout
- Method Detail
  - getVersion
```
public static java.lang.String getVersion()
```
    Return the version of SGT.
    
    Since:
    
    3.0
  - draw
```
public void draw(org.freehep.graphics2d.VectorGraphics g,
                 java.lang.String s)
```
  - draw
```
public void draw()
```
    Description copied from interface: AbstractPane
    
    The AbstractPane and all of the attached Classes will be drawn. Drawing will occur in an offscreen image and then copied to the screen. A new offscreen image is created on the first call to draw() or if the size of the pane has been changed. The offscreen image will be used as a "double" buffer when the screen requires redrawing.
    Each Layer that has been added will be drawn in the order added, except if that order has been change using the moveLayerUp() or moveLayerDown() methods.
    
    Specified by:
    
    draw in interface AbstractPane
    
    See Also:
    
    Graphics, Layer
  - init
```
public void init()
```
    No initialization required.
    
    Specified by:
    
    init in interface AbstractPane
  - draw
```
public void draw(org.freehep.graphics2d.VectorGraphics g)
```
  - draw
```
public void draw(org.freehep.graphics2d.VectorGraphics g,
                 int width,
                 int height)
```
  - isPrinter
```
public boolean isPrinter()
```
    Description copied from interface: AbstractPane
    
    Test if the current Graphics object is a printer.
    
    Specified by:
    
    isPrinter in interface AbstractPane
    
    Returns:
    
    true if a printer
  - getStrokeDrawer
```
public static StrokeDrawer getStrokeDrawer()
```
    Internal method to access jdk1.1 or Java2D line drawing.
  - getPageSize
```
public java.awt.Dimension getPageSize()
```
    Description copied from interface: AbstractPane
    
    Get the printer page size.
    
    Specified by:
    
    getPageSize in interface AbstractPane
    
    Returns:
    
    page size
  - paintComponent
```
public void paintComponent(java.awt.Graphics g)
```
    Override default painting by swing.
    
    Overrides:
    
    paintComponent in class javax.swing.JComponent
  - add
```
public java.awt.Component add(java.awt.Component comp)
```
    Adds the specified component to the end of the Pane.
    
    Overrides:
    
    add in class java.awt.Container
    
    Parameters:
    
    comp - the component to be added
    
    Returns:
    
    component argument
  - add
```
public java.awt.Component add(java.awt.Component comp,
                              int index)
```
    Adds the specified component to the Pane at the given position.
    
    Overrides:
    
    add in class java.awt.Container
    
    Parameters:
    
    comp - the component to be added
    
    index - the position at which to insert the component, or -1 to insert the component at the end.
    
    Returns:
    
    component argument
  - add
```
public void add(java.awt.Component comp,
                java.lang.Object constraints)
```
    Adds the specified component to the end of this Pane. Also notifies the layout manager to add the component to this Pane's layout using the specified constraints object.
    
    Overrides:
    
    add in class java.awt.Container
    
    Parameters:
    
    comp - the component to be added
    
    constraints - an object expressing layout constraints for this component
  - add
```
public void add(java.awt.Component comp,
                java.lang.Object constraints,
                int index)
```
    Adds the specified component to the end of this Pane at the specified index. Also notifies the layout manager to add the component to this Pane's layout using the specified constraints object.
    
    Overrides:
    
    add in class java.awt.Container
    
    Parameters:
    
    comp - the component to be added
    
    constraints - an object expressing layout constraints for this component
    
    index - the position in the Pane's list at which to insert the component -1 means insert at the end.
  - add
```
public java.awt.Component add(java.lang.String name,
                              java.awt.Component comp)
```
    Adds the specified component to this Pane. It is strongly advised to use add(Component, Object), in place of this method.
    
    Overrides:
    
    add in class java.awt.Container
  - getId
```
public java.lang.String getId()
```
    Description copied from interface: AbstractPane
    
    Get the Pane identifier.
    
    Specified by:
    
    getId in interface AbstractPane
    
    Returns:
    
    String containing the Pane identifier.
  - setId
```
public void setId(java.lang.String id)
```
    Description copied from interface: AbstractPane
    
    Set the Pane identifier
    
    Specified by:
    
    setId in interface AbstractPane
  - setPageAlign
```
public void setPageAlign(int vert,
                         int horz)
```
    Description copied from interface: AbstractPane
    
    Set alignment for printing.
    
    Specified by:
    
    setPageAlign in interface AbstractPane
    
    Parameters:
    
    vert - vertical alignment
    
    horz - horizontal alignment
    
    See Also:
    
    AbstractPane.TOP, AbstractPane.MIDDLE, AbstractPane.BOTTOM, AbstractPane.LEFT, AbstractPane.CENTER, AbstractPane.RIGHT, AbstractPane.SPECIFIED_LOCATION
  - setPageVAlign
```
public void setPageVAlign(int vert)
```
    Description copied from interface: AbstractPane
    
    Set vertical alignment for printing. Allowed choices include TOP, MIDDLE, and BOTTOM for vert and LEFT, CENTER, and RIGHT for horz. Either can be SPECIFIED_LOCATION.
    
    Specified by:
    
    setPageVAlign in interface AbstractPane
    
    Parameters:
    
    vert - vertical alignment
    
    See Also:
    
    AbstractPane.TOP, AbstractPane.MIDDLE, AbstractPane.BOTTOM, AbstractPane.SPECIFIED_LOCATION
  - setPageHAlign
```
public void setPageHAlign(int horz)
```
    Description copied from interface: AbstractPane
    
    Set horizontal alignment for printing. Allowed choices include TOP, MIDDLE, and BOTTOM.
    
    Specified by:
    
    setPageHAlign in interface AbstractPane
    
    Parameters:
    
    horz - horizontal alignment
    
    See Also:
    
    AbstractPane.LEFT, AbstractPane.CENTER, AbstractPane.RIGHT, AbstractPane.SPECIFIED_LOCATION
  - getPageVAlign
```
public int getPageVAlign()
```
    Description copied from interface: AbstractPane
    
    Get vertical alignment for printing. Allowed choices include LEFT, CENTER, and RIGHT.
    
    Specified by:
    
    getPageVAlign in interface AbstractPane
    
    Returns:
    
    vertical alignment
    
    See Also:
    
    AbstractPane.TOP, AbstractPane.MIDDLE, AbstractPane.BOTTOM, AbstractPane.SPECIFIED_LOCATION
  - getPageHAlign
```
public int getPageHAlign()
```
    Description copied from interface: AbstractPane
    
    Get horizontal alignment for printing.
    
    Specified by:
    
    getPageHAlign in interface AbstractPane
    
    Returns:
    
    horizontal alignment
    
    See Also:
    
    AbstractPane.LEFT, AbstractPane.CENTER, AbstractPane.RIGHT, AbstractPane.SPECIFIED_LOCATION
  - setPageOrigin
```
public void setPageOrigin(java.awt.Point p)
```
    Description copied from interface: AbstractPane
    
    Set the printer page origin. Valid for HAlign = SPECIFIED_LOCATION or VAlign = SPECIFIED_LOCATION.
    
    Specified by:
    
    setPageOrigin in interface AbstractPane
  - getPageOrigin
```
public java.awt.Point getPageOrigin()
```
    Description copied from interface: AbstractPane
    
    Get the printer page origin. Valid for HAlign = SPECIFIED_LOCATION or VAlign = SPECIFIED_LOCATION.
    
    Specified by:
    
    getPageOrigin in interface AbstractPane
  - setSize
```
public void setSize(java.awt.Dimension d)
```
    Set the size.
    
    Overrides:
    
    setSize in class java.awt.Component
  - getFirstLayer
```
public Layer getFirstLayer()
```
    Description copied from interface: AbstractPane
    
    Get the first Layer associated with the Pane
    
    Specified by:
    
    getFirstLayer in interface AbstractPane
    
    Returns:
    
    the first Layer object
  - getLayer
```
public Layer getLayer(java.lang.String id)
               throws LayerNotFoundException
```
    Description copied from interface: AbstractPane
    
    Get the Layer associated with the Pane indicated by the id.
    
    Specified by:
    
    getLayer in interface AbstractPane
    
    Parameters:
    
    id - identifier.
    
    Throws:
    
    LayerNotFoundException - The Layer indicated by the id was not found.
  - getLayerFromDataId
```
public Layer getLayerFromDataId(java.lang.String id)
                         throws LayerNotFoundException
```
    Description copied from interface: AbstractPane
    
    Get the Layer associated with the Pane indicated by the data id.
    
    Specified by:
    
    getLayerFromDataId in interface AbstractPane
    
    Parameters:
    
    id - data identifier
    
    Throws:
    
    LayerNotFoundException - The Layer indicated by the id was not found.
    
    See Also:
    
    SGTData
  - moveLayerUp
```
public void moveLayerUp(Layer lyr)
                 throws LayerNotFoundException
```
    Move the Layer up in the stack. The order of the layers determine when they are drawn. Moving the Layer up causes the Layer to be drawn later and over earlier layers.
    
    Parameters:
    
    lyr - Layer object.
    
    Throws:
    
    LayerNotFoundException - The specified Layer was not found in the list.
    
    See Also:
    
    Layer
  - moveLayerUp
```
public void moveLayerUp(java.lang.String id)
                 throws LayerNotFoundException
```
    Move the Layer up in the stack. The order of the layers determine when they are drawn. Moving the Layer up causes the Layer to be drawn later and over earlier layers.
    
    Parameters:
    
    id - identifier.
    
    Throws:
    
    LayerNotFoundException - The specified Layer was not found in the list.
    
    See Also:
    
    Layer
  - moveLayerDown
```
public void moveLayerDown(Layer lyr)
                   throws LayerNotFoundException
```
    Move the Layer down in the stack. The order of the layers determine when they are drawn. Moving the Layer down causes the Layer to be drawn earlier.
    
    Parameters:
    
    lyr - Layer object.
    
    Throws:
    
    LayerNotFoundException - The specified Layer was not found in the list.
    
    See Also:
    
    Layer
  - moveLayerDown
```
public void moveLayerDown(java.lang.String id)
                   throws LayerNotFoundException
```
    Move the Layer down in the stack. The order of the layers determine when they are drawn. Moving the Layer down causes the Layer to be drawn earlier.
    
    Parameters:
    
    id - identifier
    
    Throws:
    
    LayerNotFoundException - The specified Layer was not found in the list.
    
    See Also:
    
    Layer
  - getSelectedObject
```
public java.lang.Object getSelectedObject()
```
    Description copied from interface: AbstractPane
    
    Return the last object selected. Returns only objects that are part of Layers currently connected to the pane. AbstractPane tests each layer after a MOUSE_DOWN event for an object whose bounding box contains the mouse. The pane object then passes the event on to the next level.
    
    Specified by:
    
    getSelectedObject in interface AbstractPane
  - setSelectedObject
```
public void setSelectedObject(java.lang.Object obj)
```
    Description copied from interface: AbstractPane
    
    Primarily used internally by sgtplot. This can also be used to mark an object as selected for use in an event handler.
    
    Specified by:
    
    setSelectedObject in interface AbstractPane
  - processMouseEvent
```
public void processMouseEvent(java.awt.event.MouseEvent event)
```
    Overrides the default event methods.
    
    Overrides:
    
    processMouseEvent in class javax.swing.JComponent
  - processMouseMotionEvent
```
public void processMouseMotionEvent(java.awt.event.MouseEvent event)
```
    Used internally by sgtplot.
    
    Overrides:
    
    processMouseMotionEvent in class javax.swing.JComponent
  - getZoomBounds
```
public java.awt.Rectangle getZoomBounds()
```
    Get the current zoom bounding box.
    
    Specified by:
    
    getZoomBounds in interface AbstractPane
    
    Returns:
    
    zoom rectangle
  - getZoomStart
```
public java.awt.Point getZoomStart()
```
    Description copied from interface: AbstractPane
    
    Return the device coordinates of the start of the zoom action. The Point is in device coordinates and may require transformation to physical units or user units. Zoom start may be useful to indicate which graph to zoom.
    
    Specified by:
    
    getZoomStart in interface AbstractPane
    
    Returns:
    
    zoom start
    
    Since:
    
    3.0
  - getObjectAt
```
public java.lang.Object getObjectAt(int x,
                                    int y)
```
    Description copied from interface: AbstractPane
    
    Get the current selected object at a point. Used internally by sgtplot.
    
    Specified by:
    
    getObjectAt in interface AbstractPane
  - getObjectsAt
```
public java.lang.Object[] getObjectsAt(int x,
                                       int y)
```
    Description copied from interface: AbstractPane
    
    Return an array of objects whose bounds include x,y.
    
    Specified by:
    
    getObjectsAt in interface AbstractPane
    
    Since:
    
    3.0
  - getObjectsAt
```
public java.lang.Object[] getObjectsAt(java.awt.Point pt)
```
    Description copied from interface: AbstractPane
    
    Return an array of objects whose bounds are at point pt.
    
    Specified by:
    
    getObjectsAt in interface AbstractPane
    
    Since:
    
    3.0
  - getComponent
```
public java.awt.Component getComponent()
```
    Description copied from interface: AbstractPane
    
    Get the Component associated with the pane.
    
    Specified by:
    
    getComponent in interface AbstractPane
  - getMaximumSize
```
public java.awt.Dimension getMaximumSize()
```
    Overrides:
    
    getMaximumSize in class javax.swing.JComponent
  - getMinimumSize
```
public java.awt.Dimension getMinimumSize()
```
    Overrides:
    
    getMinimumSize in class javax.swing.JComponent
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Overrides:
    
    getPreferredSize in class javax.swing.JComponent
  - toString
```
public java.lang.String toString()
```
    Get a String representatinof the Pane.
    
    Overrides:
    
    toString in class java.awt.Component
    
    Returns:
    
    String representation
  - setBatch
```
public void setBatch(boolean batch,
                     java.lang.String msg)
```
    Description copied from interface: AbstractPane
    
    Turn on/off batching of updates to the pane. While batching is true property change events will not cause pane to redraw. When batching is turned back on if the pane has been modified it will then redraw.
    
    Specified by:
    
    setBatch in interface AbstractPane
  - setBatch
```
public void setBatch(boolean batch)
```
    Description copied from interface: AbstractPane
    
    Turn on/off batching of updates to the pane. While batching is true property change events will not cause pane to redraw. When batching is turned back on if the pane has been modified it will then redraw.
    
    Specified by:
    
    setBatch in interface AbstractPane
  - isBatch
```
public boolean isBatch()
```
    Description copied from interface: AbstractPane
    
    Is batching turned on?
    
    Specified by:
    
    isBatch in interface AbstractPane
  - setModified
```
public void setModified(boolean mod,
                        java.lang.String mess)
```
    Description copied from interface: AbstractPane
    
    Notify the pane that something has changed and a redraw is required. Used internally by sgtplot.
    
    Specified by:
    
    setModified in interface AbstractPane
  - isModified
```
public boolean isModified()
```
    Description copied from interface: AbstractPane
    
    Has the plot been modified?
    
    Specified by:
    
    isModified in interface AbstractPane
  - setMouseEventsEnabled
```
public void setMouseEventsEnabled(boolean enable)
```
    Description copied from interface: AbstractPane
    
    Enable/disable the handling of MouseEvents by SGT. Disabling mouse events will turn off object selection, moveable, selectable, draggable, and zooming.
    
    Specified by:
    
    setMouseEventsEnabled in interface AbstractPane
    
    Since:
    
    3.0
  - isMouseEventsEnabled
```
public boolean isMouseEventsEnabled()
```
    Description copied from interface: AbstractPane
    
    Are MouseEvents enabled for processing by SGT?
    
    Specified by:
    
    isMouseEventsEnabled in interface AbstractPane
    
    Since:
    
    3.0
  - setScrollableBlockIncrement
```
public void setScrollableBlockIncrement(int horiz,
                                        int vert)
```
    Set the horizontal and vertical block increments.
  - getScrollableBlockIncrement
```
public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
                                       int orientation,
                                       int direction)
```
    Specified by:
    
    getScrollableBlockIncrement in interface javax.swing.Scrollable
  - setScrollableUnitIncrement
```
public void setScrollableUnitIncrement(int horiz,
                                       int vert)
```
    Set the horizontal and vertical unit increments.
  - getScrollableUnitIncrement
```
public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
                                      int orientation,
                                      int direction)
```
    Specified by:
    
    getScrollableUnitIncrement in interface javax.swing.Scrollable
  - getPreferredScrollableViewportSize
```
public java.awt.Dimension getPreferredScrollableViewportSize()
```
    Specified by:
    
    getPreferredScrollableViewportSize in interface javax.swing.Scrollable
  - getScrollableTracksViewportHeight
```
public boolean getScrollableTracksViewportHeight()
```
    Specified by:
    
    getScrollableTracksViewportHeight in interface javax.swing.Scrollable
  - getScrollableTracksViewportWidth
```
public boolean getScrollableTracksViewportWidth()
```
    Specified by:
    
    getScrollableTracksViewportWidth in interface javax.swing.Scrollable
  - print
```
public int print(java.awt.Graphics g,
                 java.awt.print.PageFormat pf,
                 int pageIndex)
```
    Specified by:
    
    print in interface java.awt.print.Printable
  - setPageScaleMode
```
public void setPageScaleMode(int mode)
```
    Description copied from interface: AbstractPane
    
    Set printing scale mode. Allowable choices are TO_FIT, SHRINK_TO_FIT and DEFAULT_SCALE. Default = DEFAULT_SCALE.
    
    Specified by:
    
    setPageScaleMode in interface AbstractPane
    
    Parameters:
    
    mode - print page scaling
    
    See Also:
    
    AbstractPane.DEFAULT_SCALE, AbstractPane.TO_FIT, AbstractPane.SHRINK_TO_FIT
  - getPageScaleMode
```
public int getPageScaleMode()
```
    Description copied from interface: AbstractPane
    
    Get printing scale mode.
    
    Specified by:
    
    getPageScaleMode in interface AbstractPane
    
    Returns:
    
    AUTO_SCALE, TO_FIT, or SHRINK_TO_FIT
    
    See Also:
    
    AbstractPane.DEFAULT_SCALE, AbstractPane.TO_FIT, AbstractPane.SHRINK_TO_FIT
  - drawPage
```
public void drawPage(org.freehep.graphics2d.VectorGraphics g,
                     java.awt.print.PageFormat pf,
                     boolean scale)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Description copied from interface: AbstractPane
    
    Add a PropertyChangeListener to the list. Properties for Pane and JPane include "objectSelected" and "zoomRectangle".
    
    Specified by:
    
    addPropertyChangeListener in interface AbstractPane
    
    Overrides:
    
    addPropertyChangeListener in class java.awt.Container
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Description copied from interface: AbstractPane
    
    Remove the PropertyChangeListener from the list.
    
    Specified by:
    
    removePropertyChangeListener in interface AbstractPane
    
    Overrides:
    
    removePropertyChangeListener in class java.awt.Component
  - draw
```
public void draw(java.awt.Graphics g)
```
    Description copied from interface: AbstractPane
    
    The AbstractPane and all of the attached Classes will be drawn. Drawing will occur using the supplied Graphics object.
    
    Specified by:
    
    draw in interface AbstractPane
    
    Parameters:
    
    g - User supplied Graphics object
    
    See Also:
    
    Graphics
  - draw
```
public void draw(java.awt.Graphics g,
                 int width,
                 int height)
```
    Description copied from interface: AbstractPane
    
    The AbstractPane and all of the attached Classes will be drawn. Drawing will occur using the supplied Graphics object. And clipping will be done to the width and height.
    
    Specified by:
    
    draw in interface AbstractPane
    
    Parameters:
    
    g - User supplied Graphics object
    
    width - clipping width
    
    height - clipping height
    
    See Also:
    
    Graphics

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class JPane

Nested Class Summary

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

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 sgtplot.AbstractPane

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

Methods inherited from interface sgtplot.AbstractPane

Constructor Detail

JPane

JPane

Method Detail

getVersion

draw

draw

init

draw

draw

isPrinter

getStrokeDrawer

getPageSize

paintComponent

add

add

add

add

add

getId

setId

setPageAlign

setPageVAlign

setPageHAlign

getPageVAlign

getPageHAlign

setPageOrigin

getPageOrigin

setSize

getFirstLayer

getLayer

getLayerFromDataId

moveLayerUp

moveLayerUp

moveLayerDown

moveLayerDown

getSelectedObject

setSelectedObject

processMouseEvent

processMouseMotionEvent

getZoomBounds

getZoomStart

getObjectAt

getObjectsAt

getObjectsAt

getComponent

getMaximumSize

getMinimumSize

getPreferredSize

toString

setBatch

setBatch

isBatch

setModified

isModified

setMouseEventsEnabled

isMouseEventsEnabled

setScrollableBlockIncrement

getScrollableBlockIncrement

setScrollableUnitIncrement

getScrollableUnitIncrement