org.jdesktop.swingx
Class JXTaskPaneContainer
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
org.jdesktop.swingx.JXTaskPaneContainer
- All Implemented Interfaces:
- ImageObserver, MenuContainer, Serializable, Scrollable
public class JXTaskPaneContainer
- extends JComponent
- implements Scrollable
JXTaskPaneContainer
provides an elegant view
to display a list of tasks ordered by groups (JXTaskPane
.
Although JXTaskPane
can be added to any other
container, the JXTaskPaneContainer
will provide better
fidelity when it comes to matching the look and feel of the host operating
system than any other panel. As example, when using on a Windows platform,
the JXTaskPaneContainer
will be painted with light gradient
background. Also JXTaskPaneContainer
takes care of using the
right LayoutManager
(as required by
JXCollapsiblePane
) so that
JXTaskPane
behaves correctly when collapsing and
expanding its content.
JXTaskPaneContainer can be added to a JScrollPane.
Example:
JXFrame frame = new JXFrame();
// a container to put all JXTaskPane together
JXTaskPaneContainer taskPaneContainer = new JXTaskPaneContainer();
// add JXTaskPanes to the container
JXTaskPane actionPane = createActionPane();
JXTaskPane miscActionPane = createMiscActionPane();
JXTaskPane detailsPane = createDetailsPane();
taskPaneContainer.add(actionPane);
taskPaneContainer.add(miscActionPane);
taskPaneContainer.add(detailsPane);
// put the action list on the left in a JScrollPane
// as we have several taskPane and we want to make sure they
// all get visible.
frame.add(new JScrollPane(taskPaneContainer), BorderLayout.EAST);
// and a file browser in the middle
frame.add(fileBrowser, BorderLayout.CENTER);
frame.pack().
frame.setVisible(true);
- See Also:
- Serialized Form
Method Summary |
void |
add(JXTaskPane group)
Adds a JXTaskPane to this JXTaskPaneContainer. |
Dimension |
getPreferredScrollableViewportSize()
Returns the preferred size of the viewport for a view component. |
int |
getScrollableBlockIncrement(Rectangle visibleRect,
int orientation,
int direction)
Components that display logical rows or columns should compute
the scroll increment that will completely expose one block
of rows or columns, depending on the value of orientation. |
boolean |
getScrollableTracksViewportHeight()
Return true if a viewport should always force the height of this
Scrollable to match the height of the viewport. |
boolean |
getScrollableTracksViewportWidth()
Return true if a viewport should always force the width of this
Scrollable to match the width of the viewport. |
int |
getScrollableUnitIncrement(Rectangle visibleRect,
int orientation,
int direction)
Components that display logical rows or columns should compute
the scroll increment that will completely expose one new row
or column, depending on the value of orientation. |
String |
getUIClassID()
Returns the name of the L&F class that renders this component. |
void |
remove(JXTaskPane group)
Removes a JXTaskPane from this JXTaskPaneContainer. |
void |
setUI(TaskPaneContainerUI ui)
Sets the L&F object that renders this component. |
void |
updateUI()
Notification from the UIManager that the L&F has changed. |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, paramString, 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 |
uiClassID
public static final String uiClassID
- See Also:
- Constant Field Values
JXTaskPaneContainer
public JXTaskPaneContainer()
- Creates a new empty taskpane.
updateUI
public void updateUI()
- Notification from the
UIManager
that the L&F has changed.
Replaces the current UI object with the latest version from the UIManager
.
- Overrides:
updateUI
in class JComponent
- See Also:
JComponent.updateUI()
setUI
public void setUI(TaskPaneContainerUI ui)
- Sets the L&F object that renders this component.
- Parameters:
ui
- the TaskPaneContainerUI
L&F object- See Also:
UIDefaults.getUI(javax.swing.JComponent)
getUIClassID
public String getUIClassID()
- Returns the name of the L&F class that renders this component.
- Overrides:
getUIClassID
in class JComponent
- Returns:
- the string
uiClassID
- See Also:
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
add
public void add(JXTaskPane group)
- Adds a
JXTaskPane
to this JXTaskPaneContainer.
- Parameters:
group
-
remove
public void remove(JXTaskPane group)
- Removes a
JXTaskPane
from this JXTaskPaneContainer.
- Parameters:
group
-
getPreferredScrollableViewportSize
public Dimension getPreferredScrollableViewportSize()
- Description copied from interface:
javax.swing.Scrollable
- Returns the preferred size of the viewport for a view component.
For example, the preferred size of a
JList
component
is the size required to accommodate all of the cells in its list.
However, the value of preferredScrollableViewportSize
is the size required for JList.getVisibleRowCount
rows.
A component without any properties that would affect the viewport
size should just return getPreferredSize
here.
- Specified by:
getPreferredScrollableViewportSize
in interface Scrollable
- Returns:
- the preferredSize of a
JViewport
whose view
is this Scrollable
- See Also:
Scrollable.getPreferredScrollableViewportSize()
getScrollableBlockIncrement
public int getScrollableBlockIncrement(Rectangle visibleRect,
int orientation,
int direction)
- Description copied from interface:
javax.swing.Scrollable
- Components that display logical rows or columns should compute
the scroll increment that will completely expose one block
of rows or columns, depending on the value of orientation.
Scrolling containers, like JScrollPane, will use this method
each time the user requests a block scroll.
- Specified by:
getScrollableBlockIncrement
in interface Scrollable
- Parameters:
visibleRect
- The view area visible within the viewportorientation
- Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.direction
- Less than zero to scroll up/left, greater than zero for down/right.
- Returns:
- The "block" increment for scrolling in the specified direction.
This value should always be positive.
- See Also:
Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)
getScrollableTracksViewportHeight
public boolean getScrollableTracksViewportHeight()
- Description copied from interface:
javax.swing.Scrollable
- Return true if a viewport should always force the height of this
Scrollable to match the height of the viewport. For example a
columnar text view that flowed text in left to right columns
could effectively disable vertical scrolling by returning
true here.
Scrolling containers, like JViewport, will use this method each
time they are validated.
- Specified by:
getScrollableTracksViewportHeight
in interface Scrollable
- Returns:
- True if a viewport should force the Scrollables height to match its own.
- See Also:
Scrollable.getScrollableTracksViewportHeight()
getScrollableTracksViewportWidth
public boolean getScrollableTracksViewportWidth()
- Description copied from interface:
javax.swing.Scrollable
- Return true if a viewport should always force the width of this
Scrollable
to match the width of the viewport.
For example a normal
text view that supported line wrapping would return true here, since it
would be undesirable for wrapped lines to disappear beyond the right
edge of the viewport. Note that returning true for a Scrollable
whose ancestor is a JScrollPane effectively disables horizontal
scrolling.
Scrolling containers, like JViewport, will use this method each
time they are validated.
- Specified by:
getScrollableTracksViewportWidth
in interface Scrollable
- Returns:
- True if a viewport should force the Scrollables width to match its own.
- See Also:
Scrollable.getScrollableTracksViewportWidth()
getScrollableUnitIncrement
public int getScrollableUnitIncrement(Rectangle visibleRect,
int orientation,
int direction)
- Description copied from interface:
javax.swing.Scrollable
- Components that display logical rows or columns should compute
the scroll increment that will completely expose one new row
or column, depending on the value of orientation. Ideally,
components should handle a partially exposed row or column by
returning the distance required to completely expose the item.
Scrolling containers, like JScrollPane, will use this method
each time the user requests a unit scroll.
- Specified by:
getScrollableUnitIncrement
in interface Scrollable
- Parameters:
visibleRect
- The view area visible within the viewportorientation
- Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.direction
- Less than zero to scroll up/left, greater than zero for down/right.
- Returns:
- The "unit" increment for scrolling in the specified direction.
This value should always be positive.
- See Also:
Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)