oracle.javatools.ui.checklist

Class TaskContentProvider

java.lang.Object

oracle.javatools.ui.checklist.TaskContentProvider

public final class TaskContentProvider
extends java.lang.Object

Content provider for TaskContent. TaskContentProvider provides the following information for performing a task:

• List of key assumptions and/or prerequisites (TaskRequirements).
• Conceptual image that compliments the brief descriptive text and helps the user understand what the task is about.
• A very brief text describing the step purpose/task(s).
• Action button (ContentElement) that launches a target UI so the user can perform the task.
• One or more standard links (ContentElement) to target documentation content as appropriate for the task.
• List of task summary or suggested next steps that the user might to explore for this particular task, including links to additional information as appropriate.

Constructor Summary

Constructors

Constructor and Description
TaskContentProvider() Creates the TaskContentProvider.

Method Summary

Modifier and Type	Method and Description
void	addContentElement(ContentElement element) Add a ContentElement to the task.
ContentElement	addContentElement(java.lang.String id, ContentElement.Type type, java.lang.String label, javax.swing.Icon icon, java.lang.String target, java.lang.String hint) Add a ContentElement to the task.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a PropertyChangeListener to this content provider.
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Fires a PropertyChangeEvent to the registered listeners.
ContentElement[]	getContentElements() Returns the array of all ContentElements for the task.
java.lang.String	getDescription() Returns the task description.
java.awt.Image	getImage() Returns the conceptual image for this task.
java.util.List<java.lang.String>	getRequirements() Returns the list of requirements for the task.
java.lang.String	getRequirementsHeaderLabel() Returns the header label for showing the list of requirements.
java.util.List<java.lang.String>	getSummary() Returns the list of summary for the task.
java.lang.String	getSummaryHeaderLabel() Returns the header label for showing the list of summary.
void	removeContentElement(ContentElement elem) Remove the ContentElement from the task.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener from this content provider.
void	setDescription(java.lang.String description) Sets the task description.
void	setImage(java.awt.Image image) Sets the conceptual image for this task.
void	setRequirementHeaderLabel(java.lang.String headerLabel) Sets the header label for showing the list of requirements.
void	setRequirements(java.util.List<java.lang.String> requirements) Set the list of requirements for the task.
void	setRequirements(java.lang.String headerLabel, java.util.List<java.lang.String> requirements) Sets the task requirements.
void	setSummary(java.util.List<java.lang.String> summary) Set the list of summary for the task.
void	setSummary(java.lang.String headerLabel, java.util.List<java.lang.String> summary) Set the list of summary for the task.
void	setSummaryHeaderLabel(java.lang.String headerLabel) Sets the header label for showing the list of task summary.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskContentProvider

public TaskContentProvider()

Creates the TaskContentProvider.

Method Detail

setRequirementHeaderLabel

public void setRequirementHeaderLabel(java.lang.String headerLabel)

Sets the header label for showing the list of requirements. If the header label is not set, default header title will be used.

getRequirementsHeaderLabel

public java.lang.String getRequirementsHeaderLabel()

Returns the header label for showing the list of requirements.

setRequirements

public void setRequirements(java.util.List<java.lang.String> requirements)

Set the list of requirements for the task.

getRequirements

public java.util.List<java.lang.String> getRequirements()

Returns the list of requirements for the task.

setRequirements

public void setRequirements(java.lang.String headerLabel,
                            java.util.List<java.lang.String> requirements)

Sets the task requirements.

setImage

public void setImage(java.awt.Image image)

Sets the conceptual image for this task.

getImage

public java.awt.Image getImage()

Returns the conceptual image for this task.

setDescription

public void setDescription(java.lang.String description)

Sets the task description.

getDescription

public java.lang.String getDescription()

Returns the task description.

setSummaryHeaderLabel

public void setSummaryHeaderLabel(java.lang.String headerLabel)

Sets the header label for showing the list of task summary. If the header label is not set, default header title will be used.

getSummaryHeaderLabel

public java.lang.String getSummaryHeaderLabel()

Returns the header label for showing the list of summary.

setSummary

public void setSummary(java.util.List<java.lang.String> summary)

Set the list of summary for the task.

getSummary

public java.util.List<java.lang.String> getSummary()

Returns the list of summary for the task.

setSummary

public void setSummary(java.lang.String headerLabel,
                       java.util.List<java.lang.String> summary)

Set the list of summary for the task.

addContentElement

public void addContentElement(ContentElement element)

Add a ContentElement to the task.

addContentElement

public ContentElement addContentElement(java.lang.String id,
                                        ContentElement.Type type,
                                        java.lang.String label,
                                        javax.swing.Icon icon,
                                        java.lang.String target,
                                        java.lang.String hint)

Add a ContentElement to the task.

removeContentElement

public void removeContentElement(ContentElement elem)

Remove the ContentElement from the task.

getContentElements

public ContentElement[] getContentElements()

Returns the array of all ContentElements for the task.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener to this content provider.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a PropertyChangeListener from this content provider.

firePropertyChange

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

Fires a PropertyChangeEvent to the registered listeners.