Skip navigation links

oracle.javatools.ui.checklist
Class Step

java.lang.Object
oracle.javatools.ui.checklist.Step

public final class Step

extends java.lang.Object

Checklist consist of Steps. Step can be simple or complex and contain substeps. As of now, we support only one level of substeps. ie., a substep cannot be complex and have subsets within it. The content of the step should be provided by StepContent interface. When the step is expanded by the user in the Checklist, the StepContent will be shown in the checklist. Each step consists of following elements:

• (Required) Step number
• (Conditionally Required) Step icon of a standard size is required for the top-level steps. No icon is displayed in the substeps, so it's not required for substeps
• (Required) Step title
• (Required) Disclosure indicator (note, as specified in the Interaction section below, the user can toggle the disclosure state of a step by clicking anywhere in the header; it's not necessary to click the disclosure indicator, but having it there makes it clear to the user that there is more to see beneath each step).
• (Optional) Status indicator if the client configured the checklist to support step status management
• StepContent which contains the details for the step.

Nested Class Summary

static class

Step.StepStatus List of different step status.

Constructor Summary

Step()
Create a step.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a PropertyChangeListener to this step.
void	addSubstep(Step step) Add a substep to this parent.
void	addSubstep(Step step, int index) Add a substep to this parent at the specified location.
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Fire PropertyChangeEvent.
boolean	getAllowsSubsteps() Returns whether this step allows substeps within it.
StepContent	getContent() Returns the step content of this step.
boolean	getDrillDownSubsteps() Returns whether the substeps of this step is showing.
javax.swing.Icon	getIcon() Returns the step icon.
int	getIndex() Returns the index of the step in the model if this is parent step.
Step	getParent() Returns the parent step of this step.
Step.StepStatus	getStatus() Returns the step status.
Step	getSubstepAt(int index) Returns the substep at the specified location.
int	getSubstepCount() Returns the number of substeps within this step.
int	getSubstepIndex(Step step) Returns the index of the substep inside this parent step.
Step[]	getSubsteps() Returns the array of all substeps within this parent step.
java.lang.String	getTitle() Returns the step title.
boolean	isEnabled() Returns whether the step is enabled or not.
boolean	isExpanded() Returns whether the step is expanded or not.
boolean	isSelected() Returns whether this step is selected or not.
boolean	isSimple() Returns whether this step contains any substep or not.
boolean	isVisible() Returns whether the step is visible or not.
void	removeAllSubsteps() Remove all substeps from this parent step.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a PropertyChangeListener to this step.
void	removeSubstep(Step step) Remove the substep from this parent step.
void	setContent(StepContent content) Set the StepContent for this step.
void	setDrillDownSubsteps(boolean drillDown) Sets whether the substeps of this step is showing.
void	setEnabled(boolean enable) Set whether the step is enabled.
void	setExpanded(boolean expanded) Set whether the step is expanded or not.
void	setIcon(javax.swing.Icon icon) Sets the icon for this step.
void	setSelected(boolean selected) Select this step.
void	setStatus(Step.StepStatus status) Sets the status for this step.
void	setTitle(java.lang.String title) Sets the title for this step.
void	setVisible(boolean visible) Set whether the step is visible or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Step

public Step()

Create a step.

Method Detail

setTitle

public void setTitle(java.lang.String title)

Sets the title for this step.

getTitle

public java.lang.String getTitle()

Returns the step title.

setIcon

public void setIcon(javax.swing.Icon icon)

Sets the icon for this step.

getIcon

public javax.swing.Icon getIcon()

Returns the step icon.

setStatus

public void setStatus(Step.StepStatus status)

Sets the status for this step. By default the status will be NOT_STARTED.

getStatus

public Step.StepStatus getStatus()

Returns the step status.

setExpanded

public void setExpanded(boolean expanded)

Set whether the step is expanded or not. When expanded step will show its content which will contain all details about the step.

isExpanded

public boolean isExpanded()

Returns whether the step is expanded or not.

setSelected

public void setSelected(boolean selected)

Select this step.

isSelected

public boolean isSelected()

Returns whether this step is selected or not.

setVisible

public void setVisible(boolean visible)

Set whether the step is visible or not. By default the step will be visible.

isVisible

public boolean isVisible()

Returns whether the step is visible or not.

setEnabled

public void setEnabled(boolean enable)

Set whether the step is enabled. When step is disabled user can still expand or collapse the step. Its content providers responsibility to enable or disable the step cotent based on the state of the step. By default the step will be enabled.

isEnabled

public boolean isEnabled()

Returns whether the step is enabled or not.

setContent

public void setContent(StepContent content)

Set the StepContent for this step.

getContent

public StepContent getContent()

Returns the step content of this step.

getAllowsSubsteps

public boolean getAllowsSubsteps()

Returns whether this step allows substeps within it. As of now, we support only one level of substeps. ie., a substep cannot be complex and have subsets within it.

getSubstepCount

public int getSubstepCount()

Returns the number of substeps within this step.

getSubstepAt

public Step getSubstepAt(int index)

Returns the substep at the specified location.

getSubstepIndex

public int getSubstepIndex(Step step)

Returns the index of the substep inside this parent step.

getSubsteps

public Step[] getSubsteps()

Returns the array of all substeps within this parent step.

addSubstep

public void addSubstep(Step step)

Add a substep to this parent.

addSubstep

public void addSubstep(Step step,
                       int index)

Add a substep to this parent at the specified location.

removeSubstep

public void removeSubstep(Step step)

Remove the substep from this parent step.

removeAllSubsteps

public void removeAllSubsteps()

Remove all substeps from this parent step.

setDrillDownSubsteps

public void setDrillDownSubsteps(boolean drillDown)

Sets whether the substeps of this step is showing.

getDrillDownSubsteps

public boolean getDrillDownSubsteps()

Returns whether the substeps of this step is showing.

getParent

public Step getParent()

Returns the parent step of this step. This will return null for the top level parent step.

getIndex

public int getIndex()

Returns the index of the step in the model if this is parent step. Otherwise if this is a substep, returns the index in its parent.

isSimple

public boolean isSimple()

Returns whether this step contains any substep or not.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener to this step.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove a PropertyChangeListener to this step.

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Fire PropertyChangeEvent.

Skip navigation links