cytoscape.view.cytopanels
Class BiModalJSplitPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JSplitPane
                  cytoscape.view.cytopanels.BiModalJSplitPane

All Implemented Interfaces:

Accessible, CytoPanelContainer, ImageObserver, MenuContainer, Serializable

public class BiModalJSplitPane

extends JSplitPane

implements CytoPanelContainer

The BiModalJSplitPane class extends JSplitPane to provide two modes:

• MODE_SHOW_SPLIT: The split in the split pane appears as it normally would, and the user can resize the split pane as needed.
• MODE_HIDE_SPLIT: The split in the split pane is hidden, and the user cannot resize the split pane.

BIModalJSplitPane also implements the CytoPanelContainer interface.

Author:

Ethan Cerami, Ben Gross

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Field Summary

static int	MODE_HIDE_SPLIT
static String	MODE_PROPERTY Property listener modes.
static int	MODE_SHOW_SPLIT Available modes of the BiModalJSplitPane.

Fields inherited from class javax.swing.JSplitPane

BOTTOM, CONTINUOUS_LAYOUT_PROPERTY, DIVIDER, DIVIDER_LOCATION_PROPERTY, DIVIDER_SIZE_PROPERTY, HORIZONTAL_SPLIT, LAST_DIVIDER_LOCATION_PROPERTY, LEFT, ONE_TOUCH_EXPANDABLE_PROPERTY, ORIENTATION_PROPERTY, RESIZE_WEIGHT_PROPERTY, RIGHT, TOP, VERTICAL_SPLIT

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BiModalJSplitPane(JFrame f, int orientation, int initialMode, Component leftComponent, Component rightComponent)
Constructor.

Method Summary

Rectangle	getBounds() Gets the bounds of the applications mainframe.
Point	getLocationOnScreen() Gets the location of the applications mainframe.
int	getMode() Gets the current mode.
void	insertCytoPanel(CytoPanelImp cytoPanel, int compassDirection) Inserts CytoPanel at desired compass direction.
void	setMode(CytoPanelState cytoPanelState, int newMode) Sets the BiModalJSplitframe mode.

Methods inherited from class javax.swing.JSplitPane

getAccessibleContext, getBottomComponent, getDividerLocation, getDividerSize, getLastDividerLocation, getLeftComponent, getMaximumDividerLocation, getMinimumDividerLocation, getOrientation, getResizeWeight, getRightComponent, getTopComponent, getUI, getUIClassID, isContinuousLayout, isOneTouchExpandable, isValidateRoot, remove, remove, removeAll, resetToPreferredSizes, setBottomComponent, setContinuousLayout, setDividerLocation, setDividerLocation, setDividerSize, setLastDividerLocation, setLeftComponent, setOneTouchExpandable, setOrientation, setResizeWeight, setRightComponent, setTopComponent, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MODE_SHOW_SPLIT

public static final int MODE_SHOW_SPLIT

Available modes of the BiModalJSplitPane.

See Also:

Constant Field Values

MODE_HIDE_SPLIT

public static final int MODE_HIDE_SPLIT

See Also:

Constant Field Values

MODE_PROPERTY

public static final String MODE_PROPERTY

Property listener modes.

See Also:

Constant Field Values

Constructor Detail

BiModalJSplitPane

public BiModalJSplitPane(JFrame f,
                         int orientation,
                         int initialMode,
                         Component leftComponent,
                         Component rightComponent)

Constructor.

Parameters:

orientation - JSplitPane Orientation. JSplitPane.HORIZONTAL_SPLIT or JSplitPane.VERTICAL_SPLIT.

initialMode - Initial Mode. MODE_SHOW_SPLIT or MODE_HIDE_SPLIT.

leftComponent - Left/Top Component.

rightComponent - Right/Bottom Component.

Method Detail

insertCytoPanel

public void insertCytoPanel(CytoPanelImp cytoPanel,
                            int compassDirection)

Inserts CytoPanel at desired compass direction.

Specified by:

insertCytoPanel in interface CytoPanelContainer

Parameters:

cytoPanel - CytoPanel reference.

compassDirection - SwingConstants integer value.

getLocationOnScreen

public Point getLocationOnScreen()

Gets the location of the applications mainframe.

Specified by:

getLocationOnScreen in interface CytoPanelContainer

Returns:

Point object.

getBounds

public Rectangle getBounds()

Gets the bounds of the applications mainframe.

Specified by:

getBounds in interface CytoPanelContainer

Returns:

Rectangle Object.

setMode

public void setMode(CytoPanelState cytoPanelState,
                    int newMode)

Sets the BiModalJSplitframe mode.

Parameters:

newMode - MODE_SHOW_SPLIT or MODE_HIDE_SPLIT.

getMode

public int getMode()

Gets the current mode.

Returns:

MODE_SHOW_SPLIT or MODE_HIDE_SPLIT.