Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

oracle.jbo.uicli.controls
Class JUShuttlePanel

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 oracle.jbo.uicli.controls.JUShuttlePanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, JUPanel

public class JUShuttlePanel
extends javax.swing.JPanel
implements JUPanel

This class represents a shuttle panel. It can be extended to provide a different layout.

See Also:
Serialized Form

Nested Class Summary
protected static class JUShuttlePanel.ActionType
          An enumeration of the various actions that can be invoked from the shuttle panel
protected static class JUShuttlePanel.ListType
          An enumeration of the (two) lists associated with the shuttle panel
 
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
JUShuttlePanel()
           
JUShuttlePanel(JUPanelBinding panelBinding, java.lang.String regionName)
           
JUShuttlePanel(java.lang.String pageDef, java.lang.String regionName)
           
 
Method Summary
 void addActionBindingListener(JUCtrlActionBindingListener listener)
          add a listener to the model of the selected list.
 void cancel()
          invoke the cancel operation on the shuttle.
protected  void componentResized()
          Default implementation to resize the panel.
protected  javax.swing.JButton createButton(JUShuttlePanel.ActionType buttonType, java.lang.String label, javax.swing.JPanel container, boolean isEnabled)
          A default implementation to create a button for the shuttlepanel.
protected  javax.swing.JLabel createLabel(JUShuttlePanel.ListType listType)
          The default implementation to get the labels.
 JUCtrlListBinding getAvailableListBinding()
           
 JUShuttleModel getModel()
           
 JUPanelBinding getPanelBinding()
          JUPanel implementation
 JUCtrlListBinding getSelectedListBinding()
           
 void jbInit()
           
 void removeActionBindingListener(JUCtrlActionBindingListener listener)
          remove a listener from the model of the selected list.
 void setModel(BindingContext bindCtx, JUPanelBinding panelBinding, java.lang.String regionName)
          This method associates the shuttle panel with the shuttle binding
 void setModel(JUPanelBinding panelBinding, java.lang.String regionName)
          Do not use this method if the shuttle panel is used as the only databound panel in the form.
 void setModel(JUShuttleModel shuttleModel)
          The method assosicates the shuttle panel with the shuttle bunding.
 
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
 

Constructor Detail

JUShuttlePanel

public JUShuttlePanel()

JUShuttlePanel

public JUShuttlePanel(JUPanelBinding panelBinding,
                      java.lang.String regionName)

JUShuttlePanel

public JUShuttlePanel(java.lang.String pageDef,
                      java.lang.String regionName)
Method Detail

jbInit

public void jbInit()
            throws java.lang.Exception
Throws:
java.lang.Exception

createButton

protected javax.swing.JButton createButton(JUShuttlePanel.ActionType buttonType,
                                           java.lang.String label,
                                           javax.swing.JPanel container,
                                           boolean isEnabled)
A default implementation to create a button for the shuttlepanel. This method may be overridden to provide custom buttons

Parameters:
buttonType - the action the button will be bound to.
label - the default label that may be used for the button text.
container - the default container where the button may be placed.
isEnabled - the default value to enable the button.
Returns:
the button. A custom implementation may return null for a given action. In that case, the action will not be bound.

createLabel

protected javax.swing.JLabel createLabel(JUShuttlePanel.ListType listType)
The default implementation to get the labels. This method also adds the label to the panel.

Parameters:
listType - the list identified by the label
Returns:
created label

getPanelBinding

public final JUPanelBinding getPanelBinding()
JUPanel implementation

Specified by:
getPanelBinding in interface JUPanel

getAvailableListBinding

public final JUCtrlListBinding getAvailableListBinding()
Returns:
the listbinding associated with the 'Available' list.

getSelectedListBinding

public final JUCtrlListBinding getSelectedListBinding()
Returns:
the listbinding associated with the 'Selected' list.

addActionBindingListener

public final void addActionBindingListener(JUCtrlActionBindingListener listener)
add a listener to the model of the selected list. the listener gets notified when data in the model changes.


removeActionBindingListener

public final void removeActionBindingListener(JUCtrlActionBindingListener listener)
remove a listener from the model of the selected list.


setModel

public void setModel(JUPanelBinding panelBinding,
                     java.lang.String regionName)
Do not use this method if the shuttle panel is used as the only databound panel in the form. Instead, use @link JUShuttlePanel#setModel(BindingContext,JUPanelBinding,String) If the shuttle panel is contained in a panel that has data binding, then this method can be used for convenience.

Parameters:
panelBinding - the panelbinding
regionName - the identifier for the shuttle region

setModel

public void setModel(JUShuttleModel shuttleModel)
The method assosicates the shuttle panel with the shuttle bunding.

Parameters:
shuttleModel - the model for the Shuttle

getModel

public JUShuttleModel getModel()
Returns:
the Binding for the Panel

setModel

public final void setModel(BindingContext bindCtx,
                           JUPanelBinding panelBinding,
                           java.lang.String regionName)
This method associates the shuttle panel with the shuttle binding

Parameters:
bindCtx - the binding context
panelBinding - the panel binding
regionName - the identifier for the shuttle region

cancel

public void cancel()
invoke the cancel operation on the shuttle. This action is implicitly invoked on a window closing event. This method can be used to invoke it explicitly.


componentResized

protected void componentResized()
Default implementation to resize the panel. If the UI is customized then this method should be customized as well.


Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

Copyright © 1997, 2011, Oracle. All rights reserved.