Skip navigation links

oracle.javatools.ui.checklist
Class TaskContent

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

All Implemented Interfaces:

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

public final class TaskContent

extends javax.swing.JPanel

implements StepContent

TaskContent is a step content that shows the list of requirements for performing the task, help links, action buttons, description, conceptual image for this particular task. TaskContent gets all the required elements from TaskContentProvider. In most of the cases clients have to just create the TaskContent component with TaskContentProvider and attach ContentActionListener to listen for any user interactions with the ContentElements in this TaskContent.

By default TaskContent uses the following components to display the elements of TaskContentProvider:

• Requirements: HeaderPanel which displays the Requirements title in the header at top and list of requirements as bulleted items below it. The bulleted list is shown in a RichHintLabel and hence each item can have a link or any html text. This component will appear at the top left of the TaskContent component.
• Image: ImageCanvas components which displays the image below the Requirements component on the left side of the TaskContent component. Clients cannot customize this component.
• Description: RichHintLabel which appears below the Image component and occupies the whole width of the TaskContent component. This description component supports html text.
• ActionControl: This region appears at the top right of the TaskComponent and is right aligned. This contains all ACTIONBUTTON type of ContentElements from TaskContentProvider.
• HelpPanel: This region appears below the ActionControlPanel and contains all HELPLINK type of ContentElements.

Clients can use their own component to display the elements of TaskContentProvider like the requirements, image, descrioption, controls, etc., But it is their responsibility to control how those elements are displayed and to change it accordingly whenever TaskContentProvider updates its elements.

Events: TaskContent will fire ContentActionEvent whenever the ContentElements are activated. ContentElements could be action buttons in the control panel or hyperlinks or helplinks in the HelpPanel. If the requirements or summary or the description contains any links, a default HYPERLINK ContentElement will be created and ContentActionEvent will be fired for those elements when the links are activated by the user. Clients can listen for these events using ContentActionListener and perform the action like opening the target in a help dialog or browser, etc., If clients add any custom components to the CotrolsPanel, its their responsibility to handle the action for those components. ContentActionEvent will not be fired for those components.

Enabled When the Step is disabled, all the action controls inside the control panel will be disabled.

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

TaskContent(Step node)
Creates the TaskContent component for the specified step.

TaskContent(Step node, TaskContentProvider provider)
Creates the TaskContent component for the specified step and TaskContentProvider.

Method Summary

void	addActionControl(javax.swing.Action action) Adds a button with the specified action to the ControlPanel.
void	addActionControl(java.awt.Component comp) Adds a custom component to the ControlPanel.
void	addContentActionListener(ContentActionListener l) Attach a ContentActionListener to the TaskContent.
protected void	fireContentActionPerformed(ContentElement elem) Fires ContentActionEvent to all registered listeners.
java.awt.Component	getComponent() Returns this content component for the specified step.
ContentActionListener[]	getContentActionListeners() Returns the array of all ContentActionListeners attached to this TaskContent.
java.awt.Component	getControlPanel() Returns the control panel of this TaskContent.
java.awt.Component	getDescriptionComponent() Returns the description component of the TaskContent.
java.awt.Component	getHelpPanel() Returns the HelpPanel of this TaskContent.
java.awt.Component	getRequirementComponent() Returns the requirement component of this TaskContent.
Step	getStep() Returns the Step this TaskContent is representing.
java.awt.Component	getSummaryComponent() Returns the summary component of this TaskContent.
TaskContentProvider	getTaskContentProvider() Returns the TaskContentProvider for this TaskContent component.
void	removeActionControl(javax.swing.Action action) Removes the action control from the ControlPanel.
void	removeActionControl(java.awt.Component comp) Removes the component from the ControlPanel.
void	removeContentActionListener(ContentActionListener l) Removes the ContentActionListener from the TaskContent.
void	setControlPanel(java.awt.Component actionPanel) Sets the ControlPanel of the TaskContent, which displays all the action controls for the step.
void	setDescriptionComponent(java.awt.Component desc) Sets the description component which shows the description of the provider.
void	setHelpPanel(java.awt.Component helpPanel) Sets the HelpPanel of the TaskContent, which displays all the help links for the step.
void	setLayout(java.awt.LayoutManager lm)
void	setRequirementComponent(java.awt.Component comp) Sets the RequirementComponent which displays all the requirements of the Provider.
void	setSummaryComponent(java.awt.Component comp) Sets the summary component which displays all the summary items of the Provider.

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, 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

TaskContent

public TaskContent(Step node)

Creates the TaskContent component for the specified step. This creates a empty TaskContentProvider, by default.

TaskContent

public TaskContent(Step node,
                   TaskContentProvider provider)

Creates the TaskContent component for the specified step and TaskContentProvider.

Method Detail

getStep

public Step getStep()

Returns the Step this TaskContent is representing.

Specified by:

getStep in interface StepContent

getTaskContentProvider

public TaskContentProvider getTaskContentProvider()

Returns the TaskContentProvider for this TaskContent component.

setRequirementComponent

public void setRequirementComponent(java.awt.Component comp)

Sets the RequirementComponent which displays all the requirements of the Provider. If clients change the default requirement component, its their responsibility to display the list of requirements and update it whenever provider changes its content.

getRequirementComponent

public java.awt.Component getRequirementComponent()

Returns the requirement component of this TaskContent.

setDescriptionComponent

public void setDescriptionComponent(java.awt.Component desc)

Sets the description component which shows the description of the provider. If clients use their own description component its their responsibility to display the descreption of the provider and update it whenever needed.

getDescriptionComponent

public java.awt.Component getDescriptionComponent()

Returns the description component of the TaskContent.

setControlPanel

public void setControlPanel(java.awt.Component actionPanel)

Sets the ControlPanel of the TaskContent, which displays all the action controls for the step. All the ACTIONBUTTON type of ContentElements will be displayed here. Clients can also specify their custom action controls to be added to this panel.

getControlPanel

public java.awt.Component getControlPanel()

Returns the control panel of this TaskContent.

addActionControl

public void addActionControl(javax.swing.Action action)

Adds a button with the specified action to the ControlPanel.

addActionControl

public void addActionControl(java.awt.Component comp)

Adds a custom component to the ControlPanel.

removeActionControl

public void removeActionControl(javax.swing.Action action)

Removes the action control from the ControlPanel.

removeActionControl

public void removeActionControl(java.awt.Component comp)

Removes the component from the ControlPanel.

setHelpPanel

public void setHelpPanel(java.awt.Component helpPanel)

Sets the HelpPanel of the TaskContent, which displays all the help links for the step. All the HELPLINK type of ContentElements will be displayed here.

getHelpPanel

public java.awt.Component getHelpPanel()

Returns the HelpPanel of this TaskContent.

setSummaryComponent

public void setSummaryComponent(java.awt.Component comp)

Sets the summary component which displays all the summary items of the Provider. If clients change the default summary component, its their responsibility to display the list of summary items and update it whenever provider changes its content.

getSummaryComponent

public java.awt.Component getSummaryComponent()

Returns the summary component of this TaskContent.

getComponent

public java.awt.Component getComponent()

Returns this content component for the specified step.

Specified by:

getComponent in interface StepContent

addContentActionListener

public void addContentActionListener(ContentActionListener l)

Attach a ContentActionListener to the TaskContent.

Specified by:

addContentActionListener in interface StepContent

removeContentActionListener

public void removeContentActionListener(ContentActionListener l)

Removes the ContentActionListener from the TaskContent.

Specified by:

removeContentActionListener in interface StepContent

getContentActionListeners

public ContentActionListener[] getContentActionListeners()

Returns the array of all ContentActionListeners attached to this TaskContent.

setLayout

public void setLayout(java.awt.LayoutManager lm)

Overrides:

setLayout in class java.awt.Container

fireContentActionPerformed

protected void fireContentActionPerformed(ContentElement elem)

Fires ContentActionEvent to all registered listeners.

Skip navigation links