oracle.ide.panels
Class ActionDescriptionPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.ide.panels.ActionDescriptionPanel

All Implemented Interfaces:

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

public class ActionDescriptionPanel
extends javax.swing.JPanel

See Also:

Serialized Form

Nested Class Summary

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.

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

Method Summary

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.

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

Method Detail

build

public static ActionDescriptionPanel build(java.lang.String headerMessage,
                                           java.lang.String descriptionMessage,
                                           java.lang.String... optionsMessages)

build

public static ActionDescriptionPanel build(int messageType,
                                           java.lang.String headerMessage,
                                           java.lang.String descriptionMessage,
                                           java.lang.String... optionsMessages)

build

public static ActionDescriptionPanel build(javax.swing.JComponent additionalTopContent,
                                           javax.swing.JComponent additionalBottomContent,
                                           java.lang.String headerMessage,
                                           java.lang.String descriptionMessage,
                                           java.lang.String... optionsMessages)

build

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)

setAdditionalTopContent

public void setAdditionalTopContent(javax.swing.JComponent content)

Sets additional content placed before the options panel. Replaces the current content if any.

Parameters:

content - additional content that will be placed before the options panel

setAdditionalBottomContent

public void setAdditionalBottomContent(javax.swing.JComponent content)

Sets additional content placed after the options panel. Replaces the current content if any.

Parameters:

content - additional content that will be placed after the options panel

getAdditionalTopContent

public javax.swing.JComponent getAdditionalTopContent()

Returns any additional content set before the options panel.

Returns:

a JComponent if exists or null

getAdditionalBottomContent

public javax.swing.JComponent getAdditionalBottomContent()

Returns any additional content set after the options panel.

Returns:

a JComponent if exists or null

getSelectedOptionText

public java.lang.String getSelectedOptionText()

Return the text of the selected option from the action description panel.

Returns:

the index, null if no selection has been made

getSelectedOptionIndex

public int getSelectedOptionIndex()

Return the index of the selected option from the action description panel.

Returns:

the index, -1 if no selection has been made

setSelectedOption

public void setSelectedOption(int index)

Set the option to be selected.

Parameters:

index - the index to be set to selected

Throws:

oracle.ide.util.Assert.CheckException - if index < 0 or index >= getOptionCount()

clearSelectedOption

public void clearSelectedOption()

Clear the currently selected option.

getOptionsCount

public int getOptionsCount()

Get the total number of options.

Returns:

the option count

addSelectionChangedListener

public boolean addSelectionChangedListener(ActionDescriptionPanel.OptionSelectionChangedListener optionSelectionChangedListener)

Adds a OptionSelectionChangedListener to be notified when selection has changed.

Parameters:

optionSelectionChangedListener - the listener to be notified when selection changes.

Returns:

true if the listener was added

removeSelectionChangedListener

public boolean removeSelectionChangedListener(ActionDescriptionPanel.OptionSelectionChangedListener optionSelectionChangedListener)

Removes a OptionSelectionChangedListener from the list of listeners to be notified when selection has changed.

Parameters:

optionSelectionChangedListener - the listener to remove

Returns:

true if the listener was removed