public final class TaskContent extends javax.swing.JPanel implements StepContent
By default TaskContent uses the following components to display the elements of TaskContentProvider:
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.
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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
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, transferFocusDownCycle, validate, validateTree
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, 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, transferFocusBackward, transferFocusUpCycle
public TaskContent(Step node)
public TaskContent(Step node, TaskContentProvider provider)
public Step getStep()
getStep
in interface StepContent
public TaskContentProvider getTaskContentProvider()
public void setRequirementComponent(java.awt.Component comp)
public java.awt.Component getRequirementComponent()
public void setDescriptionComponent(java.awt.Component desc)
public java.awt.Component getDescriptionComponent()
public void setControlPanel(java.awt.Component actionPanel)
public java.awt.Component getControlPanel()
public void addActionControl(javax.swing.Action action)
public void addActionControl(java.awt.Component comp)
public void removeActionControl(javax.swing.Action action)
public void removeActionControl(java.awt.Component comp)
public void setHelpPanel(java.awt.Component helpPanel)
public java.awt.Component getHelpPanel()
public void setSummaryComponent(java.awt.Component comp)
public java.awt.Component getSummaryComponent()
public java.awt.Component getComponent()
getComponent
in interface StepContent
public void addContentActionListener(ContentActionListener l)
addContentActionListener
in interface StepContent
public void removeContentActionListener(ContentActionListener l)
removeContentActionListener
in interface StepContent
public ContentActionListener[] getContentActionListeners()
public void setLayout(java.awt.LayoutManager lm)
setLayout
in class java.awt.Container
protected void fireContentActionPerformed(ContentElement elem)