Skip navigation links

oracle.javatools.ui.checklist
Class Checklist

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
oracle.javatools.ui.checklist.Checklist

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

XMLChecklist

public class Checklist

extends javax.swing.JPanel

Unlike a wizard, the checklist is intended to provide a linear, but ultimately flexible and lightweight, guide through a series of related tasks. Each task is represented by Step. Users can follow the prescribed path in exact sequence, or explore tasks at random (unless a specific step drives whether others are displayed/enabled).

ChecklistModel Checklist gets all the steps and substeps from ChecklistModel. If clients doesn't specify a checklist model, DefaultChecklistModel will be used. All the steps or substeps should be added to this ChecklistModel and Checklist will show the corresponding StepPanel in it.

Checklist Components The checklist itself includes the following elements:

• Convenience disclosure control for all the steps lets the user open them and quickly scan contents to get a sense of what everything is about, and easily close all open steps
• A series of steps, each of which may be "simple" or "complex"
• ChecklistHeader, which contains an icon, title and description at the top.

Substep View If a step has substeps, GoToSubstep will be displayed in the TaskContent which will take to the substeps. The full checklist will be replaced with the substep drilldown, and when finished, the user can simply navigate back to the higher level. In substep view the parent step will appear in the top level header.

Selected Step Users can select a step by clicking on the StepHeader or clicking on any user interactable items like links or buttons inside the step content. Checklist supports only single selection and at a given point, only one step can be selected.

StepHeaderBanding StepHeaderBanding can be used to display a group of StepHeaders in one background color followed by the same number of steps in a different background color. This visual representation makes it easier to see the distinct steps. Clients can set the banding colors using setStepHeaderBanding. If it is not set, default colors from the look and feel will be used.

StepStatus Checklist can be configured to show step status in the step header for all the steps. Clients can use setShowStatus method.

ContentActionListener ContentActionListener can be added to Checklist which will notify to all registered listeners whenever some ContentActionEvent occurs in any of the StepContents in the checklist.

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

Checklist()
Create a Checklist component with a DefaultChecklistModel.

Checklist(ChecklistModel model)
Create a Checklist component with the specified ChecklistModel.

Method Summary

void	addContentActionListener(ContentActionListener l) Add a ContentActionListener to the checklist.
protected void	collapseSubsteps() Collapse Substeps and return to main view.
protected StepPanel	createDefaultStepPanel(Step step, int index, boolean isSubstep) Creates a default StepPanel for the specified Step.
protected void	expandSubsteps(Step step) Expand Checklist into Substep view for the specified step.
protected void	fireContentActionPerformed(ContentElement elem) Fires ContentActionEvent on all registered listener for the specified ContentElement.
ChecklistModel	getChecklistModel() Returns the ChecklistModel associated with this checklist.
ContentActionListener[]	getContentActionListener() Returns the array of all registered ContentActionListeners.
Step	getDrilledDownStep() Returns the root step for which the substeps are currently shown in the checklist.
java.lang.String	getHeaderDescription() Returns the header description text.
javax.swing.Icon	getHeaderIcon() Returns the Checklist Header icon.
java.lang.String	getHeaderText() Returns the Checklist header title text.
Step	getSelectedStep() Returns the current selected step.
boolean	getShowStatus() Returns whether to show the status for all the steps or substeps in the StepHeader or not.
java.awt.Color[]	getStepHeaderBandingColors() Returns the array of different colors used for branding.
int	getStepHeaderBandingCount() Returns the number of step headers to be displayed in same color before moving to the next color specified in header banding.
boolean	isSubstepView() Returns true if the checklist is showing substeps currently.
void	removeContentActionListener(ContentActionListener l) Remove the ContentActionListener from the checklist.
void	setChecklistModel(ChecklistModel model) Sets the checklist model for the checklist component.
void	setHeaderDescription(java.lang.String desc) Sets the header description text.
void	setHeaderIcon(javax.swing.Icon icon) Sets the Checklist Header icon at top.
void	setHeaderText(java.lang.String title) Sets the Checklist header title text.
void	setSelectedStep(Step step) Select the specified step.
void	setShowStatus(boolean show) Sets whether to show status for all the steps or substeps in the StepHeader or not.
void	setStepHeaderBanding(int count, java.awt.Color... colors) StepHeaderBanding can be used to display a group of StepHeaders in one background color followed by the same number of steps in a different background color.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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

Checklist

public Checklist()

Create a Checklist component with a DefaultChecklistModel.

Checklist

public Checklist(ChecklistModel model)

Create a Checklist component with the specified ChecklistModel.

Method Detail

setChecklistModel

public void setChecklistModel(ChecklistModel model)

Sets the checklist model for the checklist component.

getChecklistModel

public ChecklistModel getChecklistModel()

Returns the ChecklistModel associated with this checklist.

setHeaderIcon

public void setHeaderIcon(javax.swing.Icon icon)

Sets the Checklist Header icon at top.

getHeaderIcon

public javax.swing.Icon getHeaderIcon()

Returns the Checklist Header icon.

setHeaderText

public void setHeaderText(java.lang.String title)

Sets the Checklist header title text.

getHeaderText

public java.lang.String getHeaderText()

Returns the Checklist header title text.

setHeaderDescription

public void setHeaderDescription(java.lang.String desc)

Sets the header description text. This text can contain a html text.

getHeaderDescription

public java.lang.String getHeaderDescription()

Returns the header description text.

setStepHeaderBanding

public void setStepHeaderBanding(int count,
                                 java.awt.Color... colors)

StepHeaderBanding can be used to display a group of StepHeaders in one background color followed by the same number of steps in a different background color. If this is not set, default colors from the look and feel will be used.

Parameters:

count - number of step header rows to be displayed in one color before moving to the next color.

colors - different colors to alternate after the specified count.

getStepHeaderBandingColors

public java.awt.Color[] getStepHeaderBandingColors()

Returns the array of different colors used for branding.

getStepHeaderBandingCount

public int getStepHeaderBandingCount()

Returns the number of step headers to be displayed in same color before moving to the next color specified in header banding.

setSelectedStep

public void setSelectedStep(Step step)

Select the specified step. Checklist supports only single selection and at a given point, only one step or substep can be selected in checklist.

getSelectedStep

public Step getSelectedStep()

Returns the current selected step.

setShowStatus

public void setShowStatus(boolean show)

Sets whether to show status for all the steps or substeps in the StepHeader or not.

getShowStatus

public boolean getShowStatus()

Returns whether to show the status for all the steps or substeps in the StepHeader or not.

getDrilledDownStep

public Step getDrilledDownStep()

Returns the root step for which the substeps are currently shown in the checklist. This will return null if the checklist is not in substep view i.e. checklist is not showing the substeps.

isSubstepView

public boolean isSubstepView()

Returns true if the checklist is showing substeps currently.

addContentActionListener

public void addContentActionListener(ContentActionListener l)

Add a ContentActionListener to the checklist. The source of ContentActionEvent fired to these registered checklist will be this Checklist components. Clients can find the actual StepkContent which in which this ContentActionEvent was generated by using getSelectedStep from the Checklist.

removeContentActionListener

public void removeContentActionListener(ContentActionListener l)

Remove the ContentActionListener from the checklist.

getContentActionListener

public ContentActionListener[] getContentActionListener()

Returns the array of all registered ContentActionListeners.

createDefaultStepPanel

protected StepPanel createDefaultStepPanel(Step step,
                                           int index,
                                           boolean isSubstep)

Creates a default StepPanel for the specified Step. Clients can override this method to customize the StepPanel or StepHeader.

Parameters:

step - Step for which StepPanel is created

index - index of the step

isSubstep - whether this is a substep or root step.

Returns:

Returns the StepPanel for the specified Step.

expandSubsteps

protected void expandSubsteps(Step step)

Expand Checklist into Substep view for the specified step. The specified step should have substeps with it.

collapseSubsteps

protected void collapseSubsteps()

Collapse Substeps and return to main view.

fireContentActionPerformed

protected void fireContentActionPerformed(ContentElement elem)

Fires ContentActionEvent on all registered listener for the specified ContentElement.

Skip navigation links