com.metamatrix.toolbox.ui.callback
Class CallbackChoicesDialogPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by com.metamatrix.toolbox.ui.widget.DialogPanel
                      extended by com.metamatrix.toolbox.ui.callback.CallbackChoicesDialogPanel
All Implemented Interfaces:
UIConstants, ButtonConstants, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class CallbackChoicesDialogPanel
extends DialogPanel

CallbackChoicesDialogPanel is a specialization of DialogPanel that automatically configures the DialogPanel's Accept, Cancel, and navigation buttons to the CallbackChoices options, and sets the appropriate response on the callback. When CallbackChoicesDialogPanel is used to handle a Callback, there is no need to capture the selected button in the panel and set the callback response. The content component for this panel must be built and set by the callback handler, just like normal DialogPanel instances.

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 com.metamatrix.toolbox.ui.widget.ButtonConstants
ACCEPT_BUTTON, APPLY_BUTTON, BACK_BUTTON, CANCEL_BUTTON, CONTEXT_SENSITIVE_HELP, DEFAULTS_BUTTON, DETAILS_BUTTON, EXIT_BUTTON, FINISH_BUTTON, HELP_BUTTON, LOGIN_BUTTON, NEXT_BUTTON, NO_BUTTON, OVERWRITE_BUTTON, REPLACE_BUTTON, RETRY_BUTTON, SKIP_BUTTON, YES_BUTTON
 
Fields inherited from interface com.metamatrix.toolbox.ui.UIConstants
DATE_FORMAT_PROPERTY, SPACER_HORIZONTAL_LENGTH_PROPERTY, WINDOW_BORDER_PROPERTY
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
CallbackChoicesDialogPanel(Callback callback)
          Construct a CallbackChoicesDialogPanel to configure it's buttons to the callback's choice options.
 
Method Summary
protected  void accept(WidgetActionEvent event)
          Called when the panel's parent is a DialogWindow and the user activates the accept button.
protected  void cancel(WidgetActionEvent event)
          Called when the panel's parent is a DialogWindow and the user activates the cancel button or cancels the dialog via the title bar close button (with the 'X' icon) or the title bar system menu 'Close' option.
protected  void setChoice(int index)
           
 
Methods inherited from class com.metamatrix.toolbox.ui.widget.DialogPanel
addAcceptButton, addAcceptButton, addCancelButton, addCancelButton, addHelpButton, addHelpButton, addNavigationButton, addNavigationButton, addNavigationComponent, addNavigationSpacer, addNavigationSpacer, buildNavigationBar, canAccept, canCancel, createAcceptButton, createCancelButton, createHelpButton, createNavigationBar, equalizeNavigationButtonWidths, getAcceptButton, getAcceptButtons, getCancelButton, getContent, getContentContainer, getHelpButton, getNavigationBar, getNavigationButton, getNavigationComponent, getNavigationComponentIndex, getSelectedButton, getWindowAncestor, initializeDialogPanel, removeNavigationButton, removeNavigationComponent, removeNavigationSpacer, setCanAccept, setCanCancel, setContent, setLayout, setVisible, validateState, windowActivated, windowAdded
 
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, 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

CallbackChoicesDialogPanel

public CallbackChoicesDialogPanel(Callback callback)
Construct a CallbackChoicesDialogPanel to configure it's buttons to the callback's choice options.

Method Detail

accept

protected void accept(WidgetActionEvent event)
Description copied from class: DialogPanel
Called when the panel's parent is a DialogWindow and the user activates the accept button. Does nothing by default.

Overrides:
accept in class DialogPanel
Parameters:
event - The WidgetActionEvent generated from activating the button

setChoice

protected void setChoice(int index)

cancel

protected void cancel(WidgetActionEvent event)
Description copied from class: DialogPanel
Called when the panel's parent is a DialogWindow and the user activates the cancel button or cancels the dialog via the title bar close button (with the 'X' icon) or the title bar system menu 'Close' option. Does nothing by default.

Overrides:
cancel in class DialogPanel
Parameters:
event - The WidgetActionEvent generated from activating the button or closing the window


Copyright © 2009. All Rights Reserved.