org.cytoscape.util.swing

Class BasicCollapsiblePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.cytoscape.util.swing.BasicCollapsiblePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class BasicCollapsiblePanel
extends JPanel

A user-triggered collapsible panel containing the component (trigger) in the titled border

See Also:

Serialized Form

Module: swing-util-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>swing-util-api</artifactId>
</dependency>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BasicCollapsiblePanel.CollapseListener

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 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
BasicCollapsiblePanel(JRadioButton component) Constructor for an option button controlled collapsible panel.
BasicCollapsiblePanel(String text) Constructor for a label/button controlled collapsible panel.

Method Summary

Modifier and Type	Method and Description
Component	add(Component comp) Overridden to add any new components to the content panel, as might be expected.
Component	add(Component comp, int index) Overridden to add any new components to the content panel, as might be expected.
void	add(Component comp, Object constraints) Overridden to add any new components to the content panel, as might be expected.
void	add(Component comp, Object constraints, int index) Overridden to add any new components to the content panel, as might be expected.
Component	add(String name, Component comp) Overridden to add any new components to the content panel, as might be expected.
void	addCollapseListener(BasicCollapsiblePanel.CollapseListener listener)
JPanel	getContentPane() This class requires that all content be placed within a designated panel, this method returns that panel.
boolean	isCollapsed() Returns the current state of the panel, collapsed (true) or expanded (false).
boolean	removeCollapeListener(BasicCollapsiblePanel.CollapseListener listener)
void	setCollapsed(boolean collapse) Collapses or expands the panel.
void	setTitleComponentText(String text) Sets the title of of the border title component.
void	setToolTipText(String text) Sets the tooltip text of this BasicCollapsiblePanel.

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, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

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

Constructor Detail

BasicCollapsiblePanel

public BasicCollapsiblePanel(JRadioButton component)

Constructor for an option button controlled collapsible panel. This is useful when a group of options each have unique sub contents. The radio buttons should be created, grouped, and then used to construct their own collapsible panels. This way choosing a different option in the same option group will collapse all unselected options. Expanded panels draw a border around the contents and through the radio button in the fashion of a titled border.

Parameters:

component - Radio button that expands and collapses the panel based on if it is selected or not

BasicCollapsiblePanel

public BasicCollapsiblePanel(String text)

Constructor for a label/button controlled collapsible panel. Displays a clickable title that resembles a native titled border except for an arrow on the right side indicating an expandable panel. The actual border only appears when the panel is expanded.

Parameters:

text - Title of the collapsible panel in string format, used to create a button with text and an arrow icon

Method Detail

setTitleComponentText

public void setTitleComponentText(String text)

Sets the title of of the border title component.

Parameters:

text - The string title.

getContentPane

public JPanel getContentPane()

This class requires that all content be placed within a designated panel, this method returns that panel.

Returns:

panel The content panel.

add

public Component add(Component comp)

Overridden to add any new components to the content panel, as might be expected.

Overrides:

add in class Container

Parameters:

comp - The component to add.

add

public Component add(Component comp,
                     int index)

Overridden to add any new components to the content panel, as might be expected.

Overrides:

add in class Container

Parameters:

comp - The component to add.

index - The index at which to add the component.

add

public void add(Component comp,
                Object constraints)

Overridden to add any new components to the content panel, as might be expected.

Overrides:

add in class Container

Parameters:

comp - The component to add.

constraints - The constraints to adding.

add

public void add(Component comp,
                Object constraints,
                int index)

Overridden to add any new components to the content panel, as might be expected.

Overrides:

add in class Container

Parameters:

comp - The component to add.

constraints - The constraints to adding.

index - The index at which to add the component.

add

public Component add(String name,
                     Component comp)

Overridden to add any new components to the content panel, as might be expected.

Overrides:

add in class Container

Parameters:

name - The name of the component to add.

comp - The component to add.

setCollapsed

public void setCollapsed(boolean collapse)

Collapses or expands the panel. This is done by adding or removing the content pane, alternating between a frame and empty border, and changing the title arrow. Also, the current state is stored in the collapsed boolean.

Parameters:

collapse - When set to true, the panel is collapsed, else it is expanded

isCollapsed

public boolean isCollapsed()

Returns the current state of the panel, collapsed (true) or expanded (false).

Returns:

collapsed Returns true if the panel is collapsed and false if it is expanded

setToolTipText

public void setToolTipText(String text)

Sets the tooltip text of this BasicCollapsiblePanel.

Overrides:

setToolTipText in class JComponent

Parameters:

text - The string to set as the tooltip.

addCollapseListener

public void addCollapseListener(BasicCollapsiblePanel.CollapseListener listener)

removeCollapeListener

public boolean removeCollapeListener(BasicCollapsiblePanel.CollapseListener listener)