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.

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.

setHeaderDescription

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.

isSubstepView

addContentActionListener

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.