java.awt.image.ImageObserver
, java.awt.MenuContainer
, java.io.Serializable
, javax.accessibility.Accessible
, JXCollapsiblePane.CollapsiblePaneContainer
public class JXTaskPane extends javax.swing.JPanel implements JXCollapsiblePane.CollapsiblePaneContainer
JXTaskPane
is a container for tasks and other
arbitrary components.
Several JXTaskPane
s are usually grouped together within a
JXTaskPaneContainer
. However it is not mandatory
to use a JXTaskPaneContainer as the parent for JXTaskPane. The JXTaskPane can
be added to any other container. See
JXTaskPaneContainer
to understand the benefits of
using it as the parent container.
JXTaskPane
provides control to expand and
collapse the content area in order to show or hide the task list. It can have an
icon
, a title
and can be marked as
special
. Marking a JXTaskPane
as
special
(setSpecial(boolean)
is only a hint for
the pluggable UI which will usually paint it differently (by example by
using another color for the border of the pane).
When the JXTaskPane is expanded or collapsed, it will be
animated with a fade effect. The animated can be disabled on a per
component basis through setAnimated(boolean)
.
To disable the animation for all newly created JXTaskPane
,
use the UIManager property:
UIManager.put("TaskPane.animate", Boolean.FALSE);
.
Example:
JXFrame frame = new JXFrame();
// a container to put all JXTaskPane together
JXTaskPaneContainer taskPaneContainer = new JXTaskPaneContainer();
// create a first taskPane with common actions
JXTaskPane actionPane = new JXTaskPane();
actionPane.setTitle("Files and Folders");
actionPane.setSpecial(true);
// actions can be added, a hyperlink will be created
Action renameSelectedFile = createRenameFileAction();
actionPane.add(renameSelectedFile);
actionPane.add(createDeleteFileAction());
// add this taskPane to the taskPaneContainer
taskPaneContainer.add(actionPane);
// create another taskPane, it will show details of the selected file
JXTaskPane details = new JXTaskPane();
details.setTitle("Details");
// add standard components to the details taskPane
JLabel searchLabel = new JLabel("Search:");
JTextField searchField = new JTextField("");
details.add(searchLabel);
details.add(searchField);
taskPaneContainer.add(details);
// put the action list on the left
frame.add(taskPaneContainer, BorderLayout.EAST);
// and a file browser in the middle
frame.add(fileBrowser, BorderLayout.CENTER);
frame.pack();
frame.setVisible(true);
JXTaskPaneContainer
,
JXCollapsiblePane
,
Serialized Formjava.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
java.awt.Container.AccessibleAWTContainer
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
ANIMATED_CHANGED_KEY |
Used when generating PropertyChangeEvents for the "animated" property
|
static java.lang.String |
ICON_CHANGED_KEY |
Used when generating PropertyChangeEvents for the "icon" property
|
static java.lang.String |
SCROLL_ON_EXPAND_CHANGED_KEY |
Used when generating PropertyChangeEvents for the "scrollOnExpand" property
|
static java.lang.String |
SPECIAL_CHANGED_KEY |
Used when generating PropertyChangeEvents for the "special" property
|
static java.lang.String |
TITLE_CHANGED_KEY |
Used when generating PropertyChangeEvents for the "title" property
|
static java.lang.String |
uiClassID |
JXTaskPane pluggable UI key swingx/TaskPaneUI
|
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor | Description |
---|---|
JXTaskPane() |
Creates a new empty
JXTaskPane . |
Modifier and Type | Method | Description |
---|---|---|
java.awt.Component |
add(javax.swing.Action action) |
Adds an action to this
JXTaskPane . |
protected void |
addImpl(java.awt.Component comp,
java.lang.Object constraints,
int index) |
Overridden to redirect call to the content pane.
|
java.awt.Container |
getContentPane() |
Returns the contentPane object for this JXTaskPane.
|
javax.swing.Icon |
getIcon() |
Returns the icon currently displayed in the border of this pane.
|
java.lang.String |
getTitle() |
Returns the title currently displayed in the border of this pane.
|
java.lang.String |
getUIClassID() |
Returns the name of the L&F class that renders this component.
|
java.awt.Container |
getValidatingContainer() |
|
boolean |
isAnimated() |
Returns true if this task pane is animated during expand/collapse
transition.
|
boolean |
isCollapsed() |
Returns the collapsed state of this task pane.
|
boolean |
isScrollOnExpand() |
Should this group scroll to be visible after
this group was expanded.
|
boolean |
isSpecial() |
Returns true if this pane is "special".
|
protected java.lang.String |
paramString() |
|
void |
remove(int index) |
Overridden to redirect call to the content pane.
|
void |
remove(java.awt.Component comp) |
Overridden to redirect call to the content pane
|
void |
removeAll() |
Overridden to redirect call to the content pane.
|
void |
setAnimated(boolean animated) |
Enables or disables animation during expand/collapse transition.
|
void |
setCollapsed(boolean collapsed) |
Expands or collapses this group.
|
void |
setIcon(javax.swing.Icon icon) |
Sets the icon to be displayed in the border of this pane.
|
void |
setLayout(java.awt.LayoutManager mgr) |
Overridden to redirect call to the content pane.
|
void |
setScrollOnExpand(boolean scrollOnExpand) |
Should this group be scrolled to be visible on expand.
|
void |
setSpecial(boolean special) |
Sets this pane to be "special" or not.
|
void |
setTitle(java.lang.String title) |
Sets the title to be displayed in the border of this pane.
|
void |
setUI(TaskPaneUI ui) |
Sets the L&F object that renders this component.
|
void |
updateUI() |
Notification from the
UIManager that the L&F has changed. |
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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
add, add, add, 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, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
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, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
public static final java.lang.String uiClassID
public static final java.lang.String SCROLL_ON_EXPAND_CHANGED_KEY
public static final java.lang.String TITLE_CHANGED_KEY
public static final java.lang.String ICON_CHANGED_KEY
public static final java.lang.String SPECIAL_CHANGED_KEY
public static final java.lang.String ANIMATED_CHANGED_KEY
public java.awt.Container getContentPane()
public void updateUI()
UIManager
that the L&F has changed.
Replaces the current UI object with the latest version from the UIManager
.updateUI
in class javax.swing.JPanel
JComponent.updateUI()
public void setUI(TaskPaneUI ui)
ui
- the TaskPaneUI
L&F objectUIDefaults.getUI(javax.swing.JComponent)
public java.lang.String getUIClassID()
getUIClassID
in class javax.swing.JPanel
uiClassID
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- the title to be displayed in the border of this panepublic javax.swing.Icon getIcon()
public void setIcon(javax.swing.Icon icon)
icon
- the icon to be displayed in the border of this panepublic boolean isSpecial()
setSpecial(boolean)
public void setSpecial(boolean special)
JXTaskPane
as special
is only a hint for the pluggable UI which will
usually paint it differently (by example by using another color for the
border of the pane).
Usually the first JXTaskPane in a JXTaskPaneContainer is marked as special because it contains the default set of actions which can be executed given the current context.
special
- true if this pane is "special", false otherwisepublic void setScrollOnExpand(boolean scrollOnExpand)
scrollOnExpand
- true to scroll this group to be
visible if this group is expanded.setCollapsed(boolean)
public boolean isScrollOnExpand()
public void setCollapsed(boolean collapsed)
collapsed
- true to collapse the group, false to expand itpublic boolean isCollapsed()
true
if the task pane is collapsed; false
otherwisepublic void setAnimated(boolean animated)
animated
- public boolean isAnimated()
public java.awt.Component add(javax.swing.Action action)
JXTaskPane
. Returns a
component built from the action. The returned component has been
added to the JXTaskPane
.action
- public java.awt.Container getValidatingContainer()
getValidatingContainer
in interface JXCollapsiblePane.CollapsiblePaneContainer
JXCollapsiblePane.CollapsiblePaneContainer
protected void addImpl(java.awt.Component comp, java.lang.Object constraints, int index)
addImpl
in class java.awt.Container
public void setLayout(java.awt.LayoutManager mgr)
setLayout
in class java.awt.Container
public void remove(java.awt.Component comp)
remove
in class java.awt.Container
public void remove(int index)
remove
in class java.awt.Container
public void removeAll()
removeAll
in class java.awt.Container
protected java.lang.String paramString()
paramString
in class javax.swing.JPanel
JComponent.paramString()