cytoscape.view.cytopanels
Class CytoPanelImp

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  cytoscape.view.cytopanels.CytoPanelImp

All Implemented Interfaces:

CytoPanel, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener

public class CytoPanelImp
extends JPanel
implements CytoPanel, ChangeListener

The CytoPanel class extends JPanel to provide the following functionality:

• Floating/Docking of Panel.
  CytoPanel also implements CytoPanel interface.

  Author:

  Ethan Cerami, Benjamin Gross

  See Also:

  Serialized Form

  Nested Class Summary

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

  JComponent.AccessibleJComponent

  Field Summary

  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

  CytoPanelImp(int compassDirection, int tabPlacement, CytoPanelState cytoPanelState)
  Constructor.

  Method Summary

  Component	add(Component component) Adds a component to the CytoPanel.
  Component	add(Component component, int index) Adds a component to the CytoPanel at specified index.
  Component	add(String title, Component component) Adds a component to the CytoPanel with a specified title.
  void	add(String title, Icon icon, Component component) Adds a component to the CytoPanel with specified title and icon.
  void	add(String title, Icon icon, Component component, String tip) Adds a component to the CytoPanel with specified title, icon, and tool tip.
  void	addComponentToSouth(Component pComponent) Add a component to the CytoPanel just below the TabbedPane.
  void	addCytoPanelListener(CytoPanelListener cytoPanelListener) Adds a CytoPanel listener.
  int	getCompassDirection() Returns the int indicating the location within the layout.
  Component	getComponentAt(int index) Returns the component at index.
  int	getCytoPanelComponentCount() Returns the number of components in the CytoPanel.
  Component	getSelectedComponent() Returns the currently selected component.
  int	getSelectedIndex() Returns the currently selected index.
  CytoPanelState	getState() Gets the state of the CytoPanel.
  String	getTitle() Returns the proper title based on our compass direction.
  int	indexOfComponent(Component component) Returns the index for the specified component.
  int	indexOfComponent(String title) Returns the first Component index with given title.
  void	remove(Component component) Removes specified component from the CytoPanel.
  void	remove(int index) Removes the component from the CytoPanel at the specified index.
  void	removeAll() Removes all the components from the CytoPanel.
  void	removeComponentAtSouth(Component pComponent) Remove a component from the CytoPanel just below the TabbedPane.
  void	removeCytoPanelListener(CytoPanelListener cytoPanelListener) Removes a CytoPanel listener.
  void	setCytoPanelContainer(CytoPanelContainer cytoPanelContainer) Sets CytoPanelContainer interface reference.
  void	setSelectedIndex(int index) Sets the selected index on the CytoPanel.
  void	setState(CytoPanelState cytoPanelState) Sets the state of the CytoPanel.
  void	stateChanged(ChangeEvent e) Our implementation of the ChangeListener interface, to determine when new tab has been selected

  Methods inherited from class javax.swing.JPanel

  getAccessibleContext, getUI, getUIClassID, setUI, updateUI

  Methods inherited from class javax.swing.JComponent

  addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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

  Methods inherited from class java.awt.Container

  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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, hide, 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, 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, transferFocusUpCycle

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  CytoPanelImp

  public CytoPanelImp(int compassDirection,
                      int tabPlacement,
                      CytoPanelState cytoPanelState)

  Constructor.

  Parameters:

  compassDirection - Compass direction of this CytoPanel.

  tabPlacement - Tab placement of this CytoPanel.

  cytoPanelState - The starting CytoPanel state.

  Method Detail

  setCytoPanelContainer

  public void setCytoPanelContainer(CytoPanelContainer cytoPanelContainer)

  Sets CytoPanelContainer interface reference.

  Parameters:

  cytoPanelContainer - Reference to CytoPanelContainer

  getTitle

  public String getTitle()

  Returns the proper title based on our compass direction.

  Specified by:

  getTitle in interface CytoPanel

  Returns:

  A title string

  add

  public Component add(Component component)

  Adds a component to the CytoPanel.

  Specified by:

  add in interface CytoPanel

  Overrides:

  add in class Container

  Parameters:

  component - Component reference.

  Returns:

  component Component reference.

  add

  public Component add(Component component,
                       int index)

  Adds a component to the CytoPanel at specified index.

  Specified by:

  add in interface CytoPanel

  Overrides:

  add in class Container

  Parameters:

  component - Component reference.

  index - Component index.

  Returns:

  component Component reference.

  add

  public Component add(String title,
                       Component component)

  Adds a component to the CytoPanel with a specified title.

  Specified by:

  add in interface CytoPanel

  Overrides:

  add in class Container

  Parameters:

  title - Component title.

  component - Component reference.

  Returns:

  component Component reference.

  add

  public void add(String title,
                  Icon icon,
                  Component component)

  Adds a component to the CytoPanel with specified title and icon.

  Specified by:

  add in interface CytoPanel

  Parameters:

  title - Component title (can be null).

  icon - Component icon (can be null).

  component - Component reference.

  add

  public void add(String title,
                  Icon icon,
                  Component component,
                  String tip)

  Adds a component to the CytoPanel with specified title, icon, and tool tip.

  Specified by:

  add in interface CytoPanel

  Parameters:

  title - Component title (can be null).

  icon - Component icon (can be null).

  component - Component reference.

  tip - Component Tool tip text.

  getCytoPanelComponentCount

  public int getCytoPanelComponentCount()

  Returns the number of components in the CytoPanel.

  Specified by:

  getCytoPanelComponentCount in interface CytoPanel

  Returns:

  int Number of components.

  getSelectedComponent

  public Component getSelectedComponent()

  Returns the currently selected component.

  Specified by:

  getSelectedComponent in interface CytoPanel

  Returns:

  component Currently selected Component reference.

  getComponentAt

  public Component getComponentAt(int index)

  Returns the component at index.

  Specified by:

  getComponentAt in interface CytoPanel

  Returns:

  component at the given index.

  getSelectedIndex

  public int getSelectedIndex()

  Returns the currently selected index.

  Specified by:

  getSelectedIndex in interface CytoPanel

  Returns:

  index Currently selected index.

  indexOfComponent

  public int indexOfComponent(Component component)

  Returns the index for the specified component.

  Specified by:

  indexOfComponent in interface CytoPanel

  Parameters:

  component - Component reference.

  Returns:

  int Index of the Component or -1 if not found.

  indexOfComponent

  public int indexOfComponent(String title)

  Returns the first Component index with given title.

  Specified by:

  indexOfComponent in interface CytoPanel

  Parameters:

  title - Component title.

  Returns:

  int Component index with given title or -1 if not found.

  remove

  public void remove(Component component)

  Removes specified component from the CytoPanel.

  Specified by:

  remove in interface CytoPanel

  Overrides:

  remove in class Container

  Parameters:

  component - Component reference.

  remove

  public void remove(int index)

  Removes the component from the CytoPanel at the specified index.

  Specified by:

  remove in interface CytoPanel

  Overrides:

  remove in class Container

  Parameters:

  index - Component index.

  removeAll

  public void removeAll()

  Removes all the components from the CytoPanel.

  Specified by:

  removeAll in interface CytoPanel

  Overrides:

  removeAll in class Container

  setSelectedIndex

  public void setSelectedIndex(int index)

  Sets the selected index on the CytoPanel.

  Specified by:

  setSelectedIndex in interface CytoPanel

  Parameters:

  index - The desired index.

  setState

  public void setState(CytoPanelState cytoPanelState)

  Sets the state of the CytoPanel.

  Specified by:

  setState in interface CytoPanel

  Parameters:

  cytoPanelState - A CytoPanelState.

  getState

  public CytoPanelState getState()

  Gets the state of the CytoPanel.

  Specified by:

  getState in interface CytoPanel

  Returns:

  A CytoPanelState.

  addCytoPanelListener

  public void addCytoPanelListener(CytoPanelListener cytoPanelListener)

  Adds a CytoPanel listener.

  Specified by:

  addCytoPanelListener in interface CytoPanel

  Parameters:

  cytoPanelListener - Reference to a CytoPanelListener.

  removeCytoPanelListener

  public void removeCytoPanelListener(CytoPanelListener cytoPanelListener)

  Removes a CytoPanel listener.

  Specified by:

  removeCytoPanelListener in interface CytoPanel

  Parameters:

  cytoPanelListener - Reference to a CytoPanelListener.

  stateChanged

  public void stateChanged(ChangeEvent e)

  Our implementation of the ChangeListener interface, to determine when new tab has been selected

  Specified by:

  stateChanged in interface ChangeListener

  addComponentToSouth

  public void addComponentToSouth(Component pComponent)

  Add a component to the CytoPanel just below the TabbedPane.

  Parameters:

  pComponent - the component to be added.

  removeComponentAtSouth

  public void removeComponentAtSouth(Component pComponent)

  Remove a component from the CytoPanel just below the TabbedPane.

  Parameters:

  pComponent - the component to be removed.

  getCompassDirection

  public int getCompassDirection()

  Returns the int indicating the location within the layout.

  Specified by:

  getCompassDirection in interface CytoPanel

  Returns:

  The int indicating the location within the layout.