BreakawayPanel (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - loci.visbio.util.BreakawayPanel

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
```
public class BreakawayPanel
extends JPanel
implements ActionListener
```
BreakawayPanel is a container with arrows for controlling which edge of its parent container it borders, or whether it floats in a separate window.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoSize` Flag indicating whether owner window gets intelligently resized.
`protected BioArrowButton`	`bottom` Arrow buttons.
`protected String`	`edge` The edge upon which the breakaway panel lies.
`protected BioArrowButton`	`left` Arrow buttons.
`protected Window`	`owner` Owner window for breakaway panel and its parent.
`protected Container`	`pane` Pane to which GUI components can be added to the breakaway panel.
`protected Container`	`parent` Parent container.
`protected BioArrowButton`	`right` Arrow buttons.
`protected JScrollPane`	`scrollPane` Scroll pane (if any).
`protected BioArrowButton`	`top` Arrow buttons.
`protected JFrame`	`window` Floating window containing the breakaway panel.

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.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

BreakawayPanel(Container parent, String name, boolean scroll)
Creates a new breakaway panel.

Constructors
Constructor and Description
`BreakawayPanel(Container parent, String name, boolean scroll)` Creates a new breakaway panel.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Handles button presses.
`Container`	`getContentPane()` Gets pane to which GUI components can be added.
`String`	`getEdge()` Gets the edge upon which the breakaway panel lies.
`JFrame`	`getWindow()` Gets floating window used when panel breaks away from its parent.
`boolean`	`isAutoSize()` Gets whether changing the edge intelligently resizes the owner window.
`void`	`repack()` Enlarges the window to its preferred size if it is too small.
`void`	`reshow()` If breakaway panel is in a separate window, ensures it is visible.
`void`	`setAutoSize(boolean autoSize)` Sets whether changing the edge intelligently resizes the owner window.
`void`	`setContentPane(Container c)` Sets pane containing GUI components.
`void`	`setDownEnabled(boolean enabled)` Toggles availability of down arrow button.
`void`	`setEdge(String e)` Sets the edge upon which the breakaway panel lies.
`void`	`setLeftEnabled(boolean enabled)` Toggles availability of left arrow button.
`void`	`setRightEnabled(boolean enabled)` Toggles availability of right arrow button.
`void`	`setUpEnabled(boolean enabled)` Toggles availability of up arrow button.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, 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, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, 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, remove, remove, removeAll, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

- Field Detail
  - parent
```
protected Container parent
```
    Parent container.
  - owner
```
protected Window owner
```
    Owner window for breakaway panel and its parent.
  - window
```
protected JFrame window
```
    Floating window containing the breakaway panel.
  - pane
```
protected Container pane
```
    Pane to which GUI components can be added to the breakaway panel.
  - scrollPane
```
protected JScrollPane scrollPane
```
    Scroll pane (if any).
  - edge
```
protected String edge
```
    The edge upon which the breakaway panel lies.
  - autoSize
```
protected boolean autoSize
```
    Flag indicating whether owner window gets intelligently resized.
  - top
```
protected BioArrowButton top
```
    Arrow buttons.
  - bottom
```
protected BioArrowButton bottom
```
    Arrow buttons.
  - left
```
protected BioArrowButton left
```
    Arrow buttons.
  - right
```
protected BioArrowButton right
```
    Arrow buttons.
- Constructor Detail
  - BreakawayPanel
```
public BreakawayPanel(Container parent,
                      String name,
                      boolean scroll)
```
    Creates a new breakaway panel.
    
    Parameters:
    
    parent - Panel's parent container, which uses BorderLayout
    
    name - Title to display when panel is floating in a separate window
    
    scroll - Whether to display scroll bars when needed
- Method Detail
  - setContentPane
```
public void setContentPane(Container c)
```
    Sets pane containing GUI components.
  - getContentPane
```
public Container getContentPane()
```
    Gets pane to which GUI components can be added.
  - getWindow
```
public JFrame getWindow()
```
    Gets floating window used when panel breaks away from its parent.
  - setEdge
```
public void setEdge(String e)
```
    Sets the edge upon which the breakaway panel lies. Automatically adds the breakaway panel to its parent container in the proper location.
    
    Parameters:
    
    e - Valid edge values are BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST, BorderLayout.WEST, and null for floating.
  - getEdge
```
public String getEdge()
```
    Gets the edge upon which the breakaway panel lies.
  - setAutoSize
```
public void setAutoSize(boolean autoSize)
```
    Sets whether changing the edge intelligently resizes the owner window.
  - isAutoSize
```
public boolean isAutoSize()
```
    Gets whether changing the edge intelligently resizes the owner window.
  - reshow
```
public void reshow()
```
    If breakaway panel is in a separate window, ensures it is visible.
  - repack
```
public void repack()
```
    Enlarges the window to its preferred size if it is too small.
  - setUpEnabled
```
public void setUpEnabled(boolean enabled)
```
    Toggles availability of up arrow button.
  - setDownEnabled
```
public void setDownEnabled(boolean enabled)
```
    Toggles availability of down arrow button.
  - setLeftEnabled
```
public void setLeftEnabled(boolean enabled)
```
    Toggles availability of left arrow button.
  - setRightEnabled
```
public void setRightEnabled(boolean enabled)
```
    Toggles availability of right arrow button.
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Handles button presses.
    
    Specified by:
    
    actionPerformed in interface ActionListener

Class BreakawayPanel

Nested Class Summary

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

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.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

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

parent

owner

window

pane

scrollPane

edge

autoSize

top

bottom

left

right

Constructor Detail

BreakawayPanel

Method Detail

setContentPane

getContentPane

getWindow

setEdge

getEdge

setAutoSize

isAutoSize

reshow

repack

setUpEnabled

setDownEnabled

setLeftEnabled

setRightEnabled

actionPerformed