oracle.ide.model
Class LazyLoadedTraversable

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.ide.panels.DefaultTraversablePanel
                      oracle.ide.model.panels.ProjectSettingsTraversablePanel
                          oracle.ide.model.LazyLoadedTraversable

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, GridBagConstants, LazyTraversable, ApplyListener, Traversable

public class LazyLoadedTraversable
extends ProjectSettingsTraversablePanel
implements Traversable, ApplyListener, LazyTraversable

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 oracle.ide.model.panels.ProjectSettingsTraversablePanel

CHAINED_PROPERTY_DATA_KEY, DEFAULT_PROJECT_KEY, EDITING_CUSTOM_PROPERTIES_KEY, PROPERTY_DATA_KEY, USER_ONLY_PROPERTY_DATA_KEY

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 oracle.ide.controls.GridBagConstants

ANCHOR_C, ANCHOR_E, ANCHOR_N, ANCHOR_NE, ANCHOR_NW, ANCHOR_S, ANCHOR_SE, ANCHOR_SW, ANCHOR_W, FILL_NONE, FILL_X, FILL_XY, FILL_Y

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

LazyLoadedTraversable(MetaClass traversableMetaClass, java.lang.String providerExtensionId)

Method Summary

void	addHierarchyListenerForLoading(java.awt.event.HierarchyListener hierarchyListener) Used to add a hierarchy listener to the wrapper so that when the real object is displayed instead of the load extension button appropriate changes can be made.
void	apply(ApplyEvent e) This method is called when the changes made in the NavigableUIContainer are to be committed to the original data structures.
void	cancel(ApplyEvent e) This method is called when the changes made in the NavigableUIContainer are to be discarded.
java.awt.Component	getComponent() Returns this by default.
java.lang.String	getDataKey() Subclasses should implement this method and return the single key used to identify their project properties, unless the UI describes properties that span more than a single HashStructure, in which case null should be returned.
java.lang.Object	getExitTransition() Returns null by default.
java.lang.String	getHelpID() This method allows a subclass to implement a dynamic means of determining the help ID.
java.lang.String[]	getPropertyKeys() Subclasses must implement this method and return the list of property keys for this Project Properties panel.
boolean	isActingLazy() Indicates whether the real traversable object is being used or the lazy wrapper is displayed to let the user choose to load the extension that provides the real object.
void	onEntry(TraversableContext dataContext) Does nothing by default.
void	onExit(TraversableContext dataContext) Does nothing by default.
void	onProjectPanelEntry(TraversableContext traversableContext) Subclasses must implement this method which is invoked when the panel is about to be displayed.
void	removeHierarchyListenerForLoading(java.awt.event.HierarchyListener hierarchyListener) Used to remove a hierarchy listener from the wrapper once the real object is displayed instead of the load extension button.

Methods inherited from class oracle.ide.model.panels.ProjectSettingsTraversablePanel

activateProperties, arePropertiesOverridden, editingUserProperties, getProject, getPropertyData, isDefaultProject, isUserOnly

Methods inherited from class oracle.ide.panels.DefaultTraversablePanel

gbc, gbc, getDefaultTitle, getText, setDefaultTitle, setHelpID

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

LazyLoadedTraversable

public LazyLoadedTraversable(MetaClass traversableMetaClass,
                             java.lang.String providerExtensionId)

Method Detail

onEntry

public void onEntry(TraversableContext dataContext)

Description copied from class: DefaultTraversablePanel

Does nothing by default.

Specified by:

onEntry in interface Traversable

Overrides:

onEntry in class ProjectSettingsTraversablePanel

Parameters:

dataContext - The data wrapper where the Traversable locates the data that it needs to populate the UI.

See Also:

Traversable.onEntry(TraversableContext)

getComponent

public java.awt.Component getComponent()

Description copied from class: DefaultTraversablePanel

Returns this by default.

Specified by:

getComponent in interface LazyTraversable

Specified by:

getComponent in interface Traversable

Overrides:

getComponent in class DefaultTraversablePanel

Returns:

The UI Component that the user interacts with for creating or editing an object.

See Also:

Traversable.getComponent()

onExit

public void onExit(TraversableContext dataContext)
            throws TraversalException

Description copied from class: DefaultTraversablePanel

Does nothing by default.

Specified by:

onExit in interface Traversable

Overrides:

onExit in class DefaultTraversablePanel

Parameters:

dataContext - The data object where changes made in the UI should be copied so that the changes can be accessed by other Traversables.

Throws:

TraversalException - if the user has entered either incomplete, invalid, or inconsistent data. This exception prevents the property dialog or wizard from continuing and forces the user to stay on the current Traversable until the data entered is valid or the user cancels. The exception class itself is capable of carrying an error message that will be shown to the user. Refer to its javadoc for details.

See Also:

Traversable.onExit(TraversableContext)

getExitTransition

public java.lang.Object getExitTransition()

Description copied from class: DefaultTraversablePanel

Returns null by default.

Specified by:

getExitTransition in interface Traversable

Overrides:

getExitTransition in class DefaultTraversablePanel

Returns:

The exit transition for the Traversable that is used by dynamic interview-style wizards to determine the next course of action. A Traversable class that does not support multiple possible transitions should just return null.

See Also:

Traversable.getExitTransition()

getHelpID

public java.lang.String getHelpID()

Description copied from class: DefaultTraversablePanel

This method allows a subclass to implement a dynamic means of determining the help ID.

Specified by:

getHelpID in interface Traversable

Overrides:

getHelpID in class DefaultTraversablePanel

isActingLazy

public boolean isActingLazy()

Description copied from interface: LazyTraversable

Indicates whether the real traversable object is being used or the lazy wrapper is displayed to let the user choose to load the extension that provides the real object.

Specified by:

isActingLazy in interface LazyTraversable

Returns:

true when the real traversable object is not being used

apply

public void apply(ApplyEvent e)

Description copied from interface: ApplyListener

This method is called when the changes made in the NavigableUIContainer are to be committed to the original data structures. This normally occurs when the user pushes the "OK", "Apply", or "Finish" button.

This method is called as soon as the user's action is recognized. Typically, if the NavigableUIContainer is editing a copy of the original data, there will be an ApplyListener registered that is responsible for flushing the changes from the edited data copy back to the original data structure. The API in the oracle.ide.panels package does not specify when such an ApplyListener is registered or whether one is registered at all.

If you are writing code that must depend on the registration order of such an ApplyListener, you will need to consult the documentation for the code that instantiates the NavigableUIContainer to determine if the registration order for ApplyListeners is specified there.

Specified by:

apply in interface ApplyListener

Parameters:

e - The ApplyEvent that provides contextual information about when the ApplyEvent was fired.

cancel

public void cancel(ApplyEvent e)

Description copied from interface: ApplyListener

This method is called when the changes made in the NavigableUIContainer are to be discarded. This normally occurs when the user pushes the "Cancel" button.

No data validation occurs when the user cancels, and the NavigableUIContainer may or may not call the onExit method of the currently showing Traversable. In general, onExit will not be called.

Specified by:

cancel in interface ApplyListener

Parameters:

e - The ApplyEvent that provides contextual information about when the ApplyEvent was fired.

onProjectPanelEntry

public void onProjectPanelEntry(TraversableContext traversableContext)

Description copied from class: ProjectSettingsTraversablePanel

Subclasses must implement this method which is invoked when the panel is about to be displayed.

Specified by:

onProjectPanelEntry in class ProjectSettingsTraversablePanel

Parameters:

traversableContext - the shared data context

getDataKey

public java.lang.String getDataKey()

Description copied from class: ProjectSettingsTraversablePanel

Subclasses should implement this method and return the single key used to identify their project properties, unless the UI describes properties that span more than a single HashStructure, in which case null should be returned.

Specified by:

getDataKey in class ProjectSettingsTraversablePanel

Returns:

the unique key used to store and retrieve project properties, or null

See Also:

ProjectSettingsTraversablePanel.getPropertyKeys()

getPropertyKeys

public java.lang.String[] getPropertyKeys()

Description copied from class: ProjectSettingsTraversablePanel

Subclasses must implement this method and return the list of property keys for this Project Properties panel. If the data is stored in a single HashStructure, subclasses should implement ProjectSettingsTraversablePanel.getDataKey() and return the key used to store the set of properties, then this method should return the keys as short property names like:

"debugInformation"

If the panel contains UI for properties that span more than one HashStructure, the property keys must be in the form:

"oracle.jdeveloper.compiler.OjcConfiguration/debugInformation"

Specified by:

getPropertyKeys in class ProjectSettingsTraversablePanel

Returns:

a list of property keys for this panel

See Also:

ProjectSettingsTraversablePanel.getDataKey()

addHierarchyListenerForLoading

public void addHierarchyListenerForLoading(java.awt.event.HierarchyListener hierarchyListener)

Description copied from interface: LazyTraversable

Used to add a hierarchy listener to the wrapper so that when the real object is displayed instead of the load extension button appropriate changes can be made. Typically this puts a listener on the load extension button

Specified by:

addHierarchyListenerForLoading in interface LazyTraversable

removeHierarchyListenerForLoading

public void removeHierarchyListenerForLoading(java.awt.event.HierarchyListener hierarchyListener)

Description copied from interface: LazyTraversable

Used to remove a hierarchy listener from the wrapper once the real object is displayed instead of the load extension button. Typically this removes a listener from the load extension button

Specified by:

removeHierarchyListenerForLoading in interface LazyTraversable