bibliothek.gui.dock.focus
Class DefaultDockableSelection

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by bibliothek.gui.dock.focus.AbstractDockableSelection
                      extended by bibliothek.gui.dock.focus.DefaultDockableSelection
All Implemented Interfaces:
DockableSelection, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Direct Known Subclasses:
BasicDockableSelection, EclipseDockableSelection

public class DefaultDockableSelection
extends AbstractDockableSelection

A DockableSelection that uses a JList to display all the available Dockables. Subclasses can rearange the layout of this selection using Container.removeAll() and later getList() to get access to the component which represents the list.

Author:
Benjamin Sigg
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class bibliothek.gui.dock.focus.AbstractDockableSelection
CANCEL, DOWN, LEFT, RIGHT, SELECT, UP
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
DefaultDockableSelection()
          Creates a new selection
 
Method Summary
protected  void down()
          Called when a down arrow key was pressed.
protected  javax.swing.JComponent getList()
          Gets the component which represents the list.
protected  void iconChanged(int index, Dockable dockable)
          Called when the icon of dockable changed.
protected  void insert(int index, Dockable dockable)
          Called when a new dockable can be selected.
protected  void left()
          Called when a left arrow key was pressed.
protected  void remove(int index, Dockable dockable)
          Called when a dockable is no longer selectable.
protected  void right()
          Called when a right arrow key was pressed.
protected  void select(Dockable dockable)
          Called when this selection is forced to select a specific dockable.
protected  void titleChanged(int index, Dockable dockable)
          Called when the title text of dockable changed.
protected  void up()
          Called when an up arrow key was pressed.
 void updateUI()
           
 
Methods inherited from class bibliothek.gui.dock.focus.AbstractDockableSelection
addDockableSelectionListener, cancel, close, getComponent, getController, hasChoices, open, removeDockableSelectionListener, select, selectable, setSelection
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI
 
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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, transferFocusBackward, 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, 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, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DefaultDockableSelection

public DefaultDockableSelection()
Creates a new selection

Method Detail

updateUI

public void updateUI()
Overrides:
updateUI in class javax.swing.JPanel

getList

protected javax.swing.JComponent getList()
Gets the component which represents the list.

Returns:
the list

up

protected void up()
Description copied from class: AbstractDockableSelection
Called when an up arrow key was pressed.

Specified by:
up in class AbstractDockableSelection

right

protected void right()
Description copied from class: AbstractDockableSelection
Called when a right arrow key was pressed.

Specified by:
right in class AbstractDockableSelection

down

protected void down()
Description copied from class: AbstractDockableSelection
Called when a down arrow key was pressed.

Specified by:
down in class AbstractDockableSelection

left

protected void left()
Description copied from class: AbstractDockableSelection
Called when a left arrow key was pressed.

Specified by:
left in class AbstractDockableSelection

iconChanged

protected void iconChanged(int index,
                           Dockable dockable)
Description copied from class: AbstractDockableSelection
Called when the icon of dockable changed.

Specified by:
iconChanged in class AbstractDockableSelection
Parameters:
index - the location of dockable
dockable - the element whose icon changed

insert

protected void insert(int index,
                      Dockable dockable)
Description copied from class: AbstractDockableSelection
Called when a new dockable can be selected.

Specified by:
insert in class AbstractDockableSelection
Parameters:
index - the location of the dockable in the list of all known dockables.
dockable - the new element

remove

protected void remove(int index,
                      Dockable dockable)
Description copied from class: AbstractDockableSelection
Called when a dockable is no longer selectable.

Specified by:
remove in class AbstractDockableSelection
Parameters:
index - the index of the removed element
dockable - the removed element

select

protected void select(Dockable dockable)
Description copied from class: AbstractDockableSelection
Called when this selection is forced to select a specific dockable.

Specified by:
select in class AbstractDockableSelection
Parameters:
dockable - the element to select, can be null

titleChanged

protected void titleChanged(int index,
                            Dockable dockable)
Description copied from class: AbstractDockableSelection
Called when the title text of dockable changed.

Specified by:
titleChanged in class AbstractDockableSelection
Parameters:
index - the location of dockable
dockable - the element whose title changed