public class ActionDescriptionPanel
extends javax.swing.JPanel
Modifier and Type | Class and Description |
---|---|
static class |
ActionDescriptionPanel.OptionSelectionChangedEvent
The event that gets triggered when the selected option has changed.
|
static class |
ActionDescriptionPanel.OptionSelectionChangedListener
The listener that get notified when the selected option has changed.
|
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
Modifier and Type | Method and Description |
---|---|
boolean |
addSelectionChangedListener(ActionDescriptionPanel.OptionSelectionChangedListener optionSelectionChangedListener)
Adds a
OptionSelectionChangedListener to be notified when
selection has changed. |
static ActionDescriptionPanel |
build(int messageType,
java.lang.String headerMessage,
java.lang.String descriptionMessage,
java.lang.String... optionsMessages) |
static ActionDescriptionPanel |
build(javax.swing.JComponent additionalTopContent,
javax.swing.JComponent additionalBottomContent,
int messageType,
java.lang.String headerMessage,
java.lang.String descriptionMessage,
java.lang.String... optionsMessages) |
static ActionDescriptionPanel |
build(javax.swing.JComponent additionalTopContent,
javax.swing.JComponent additionalBottomContent,
java.lang.String headerMessage,
java.lang.String descriptionMessage,
java.lang.String... optionsMessages) |
static ActionDescriptionPanel |
build(java.lang.String headerMessage,
java.lang.String descriptionMessage,
java.lang.String... optionsMessages) |
void |
clearSelectedOption()
Clear the currently selected option.
|
javax.swing.JComponent |
getAdditionalBottomContent()
Returns any additional content set after the options panel.
|
javax.swing.JComponent |
getAdditionalTopContent()
Returns any additional content set before the options panel.
|
int |
getOptionsCount()
Get the total number of options.
|
int |
getSelectedOptionIndex()
Return the index of the selected option from the action description panel.
|
java.lang.String |
getSelectedOptionText()
Return the text of the selected option from the action description panel.
|
boolean |
removeSelectionChangedListener(ActionDescriptionPanel.OptionSelectionChangedListener optionSelectionChangedListener)
Removes a
OptionSelectionChangedListener from the list of listeners
to be notified when selection has changed. |
void |
setAdditionalBottomContent(javax.swing.JComponent content)
Sets additional content placed after the options panel.
|
void |
setAdditionalTopContent(javax.swing.JComponent content)
Sets additional content placed before the options panel.
|
void |
setSelectedOption(int index)
Set the option to be selected.
|
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, setLayout, 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 static ActionDescriptionPanel build(java.lang.String headerMessage, java.lang.String descriptionMessage, java.lang.String... optionsMessages)
public static ActionDescriptionPanel build(int messageType, java.lang.String headerMessage, java.lang.String descriptionMessage, java.lang.String... optionsMessages)
public static ActionDescriptionPanel build(javax.swing.JComponent additionalTopContent, javax.swing.JComponent additionalBottomContent, java.lang.String headerMessage, java.lang.String descriptionMessage, java.lang.String... optionsMessages)
public static ActionDescriptionPanel build(javax.swing.JComponent additionalTopContent, javax.swing.JComponent additionalBottomContent, int messageType, java.lang.String headerMessage, java.lang.String descriptionMessage, java.lang.String... optionsMessages)
public void setAdditionalTopContent(javax.swing.JComponent content)
content
- additional content that will be placed before the options panelpublic void setAdditionalBottomContent(javax.swing.JComponent content)
content
- additional content that will be placed after the options panelpublic javax.swing.JComponent getAdditionalTopContent()
public javax.swing.JComponent getAdditionalBottomContent()
public java.lang.String getSelectedOptionText()
null
if no selection has been madepublic int getSelectedOptionIndex()
public void setSelectedOption(int index)
index
- the index to be set to selectedoracle.ide.util.Assert.CheckException
- if
index < 0 or index >= getOptionCount()
public void clearSelectedOption()
public int getOptionsCount()
public boolean addSelectionChangedListener(ActionDescriptionPanel.OptionSelectionChangedListener optionSelectionChangedListener)
OptionSelectionChangedListener
to be notified when
selection has changed.optionSelectionChangedListener
- the listener to be notified when
selection changes.true
if the listener was addedpublic boolean removeSelectionChangedListener(ActionDescriptionPanel.OptionSelectionChangedListener optionSelectionChangedListener)
OptionSelectionChangedListener
from the list of listeners
to be notified when selection has changed.optionSelectionChangedListener
- the listener to removetrue
if the listener was removed