oracle.ide.model.panels

Class ProjectSettingsTraversablePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.ide.panels.DefaultTraversablePanel

oracle.ide.model.panels.ProjectSettingsTraversablePanel

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplicationContentPanel, ClasspathPanel, GenericPanel, JProjectDependencyPanel, JProjectPanel, LazyLoadedTraversable, ResourceBundleOptionsPanel, TechnologiesPanel

public abstract class ProjectSettingsTraversablePanel
extends DefaultTraversablePanel

This panel is designed for use in the Project Properties dialog. The TraversableContext must contain the project properties HashStructure that will be edited. It must also contain the workspace-level properties HashStructure to support those properties that are registered as shareable across projects in a workspace.

In the case of the Project Properties dialog, this panel can edit user-private properties, project-shared properties, or workspace- shared properties. Subclasses must get the appropriate properties data, by calling getPropertyData(Namespace). Note that despite the name, this class is now also used for panels in the Application Properties dialog. Not all terminology may have been updated to reflect this.

See Also:

storeSharedProperties(oracle.ide.util.Namespace, oracle.javatools.data.HashStructure), storeWorkspaceLevelProperties(oracle.ide.util.Namespace, oracle.javatools.data.HashStructure), getPropertyData(Namespace), PropertiesDialog, 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

Modifier and Type	Field and Description
static java.lang.String	CHAINED_PROPERTY_DATA_KEY Deprecated.
static java.lang.String	DEFAULT_PROJECT_KEY Deprecated.
static java.lang.String	EDITING_CUSTOM_PROPERTIES_KEY Deprecated.
static java.lang.String	PROPERTY_DATA_KEY Deprecated.
static java.lang.String	USER_ONLY_PROPERTY_DATA_KEY Deprecated.

Fields inherited from class javax.swing.JComponent

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

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

Constructors

Constructor and Description
ProjectSettingsTraversablePanel()

Method Summary

Modifier and Type	Method and Description
void	activateProperties(TraversableContext tc, boolean useCustom) Enables or disables custom properties.
java.awt.Component	add(java.awt.Component comp)
java.awt.Component	add(java.awt.Component comp, int index)
void	add(java.awt.Component comp, java.lang.Object constraints)
void	add(java.awt.Component comp, java.lang.Object constraints, int index)
boolean	arePropertiesOverridden() Deprecated. No replacement.
static boolean	editingUserProperties(Namespace data) Indicates whether or not the supplied Namespace corresponds to user properties opposed to shared properties.
protected boolean	editsSharedProperties() Indicates whether this panel supports editing of Workspace-level properties that are shared across projects.
abstract 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.
protected java.lang.String	getHashAdapterDelegateKey() If the properties edited by this panel may be managed by a HSAdapterDelegate, override this method and return the key that identifies the parent hash structure.
java.awt.LayoutManager	getLayout()
protected static Project	getProject(Namespace data) Returns the Project that is being edited.
protected static Project	getProject(Namespace data, boolean projectCopy) Returns the Project that is being edited.
protected static Workspace	getProjectsOwningWorkspace(Namespace data) Returns the current Workspacein the Namespace.
protected static PropertyStorage	getPropertyData(Namespace data) Gets a PropertyStorage object that wraps the properties under edit.
abstract java.lang.String[]	getPropertyKeys() Subclasses must implement this method and return the list of property keys for this Project Properties panel.
static boolean	isDefaultProject(Namespace data) Indicates whether or not the data in the supplied Namespace corresponds to the default project properties data.
static boolean	isEditingSharedProperties(Namespace data) Indicates whether this panel is currently editing Workspace-level properties that are shared across projects.
boolean	isUserOnly() The default implementation returns false, indicating that the properties that are edited on this panel can be set at the user and at the project level.
void	onEntry(TraversableContext traversableContext) Does nothing by default.
abstract void	onProjectPanelEntry(TraversableContext traversableContext) Subclasses must implement this method which is invoked when the panel is about to be displayed.
void	remove(java.awt.Component comp)
void	remove(int index)
void	removeAll()
void	setLayout(java.awt.LayoutManager mgr)
boolean	supportsSharedProperties()

Methods inherited from class oracle.ide.panels.DefaultTraversablePanel

gbc, gbc, getComponent, getDefaultTitle, getExitTransition, getHelpID, getText, onExit, 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, 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

Methods inherited from class java.awt.Container

add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PROJECT_KEY

@Deprecated
public static final java.lang.String DEFAULT_PROJECT_KEY

Deprecated.

See Also:

Constant Field Values

EDITING_CUSTOM_PROPERTIES_KEY

@Deprecated
public static final java.lang.String EDITING_CUSTOM_PROPERTIES_KEY

Deprecated.

See Also:

Constant Field Values

PROPERTY_DATA_KEY

@Deprecated
public static final java.lang.String PROPERTY_DATA_KEY

Deprecated.

See Also:

Constant Field Values

CHAINED_PROPERTY_DATA_KEY

@Deprecated
public static final java.lang.String CHAINED_PROPERTY_DATA_KEY

Deprecated.

See Also:

Constant Field Values

USER_ONLY_PROPERTY_DATA_KEY

@Deprecated
public static final java.lang.String USER_ONLY_PROPERTY_DATA_KEY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ProjectSettingsTraversablePanel

public ProjectSettingsTraversablePanel()

Method Detail

onEntry

public void onEntry(TraversableContext traversableContext)

Description copied from class: DefaultTraversablePanel

Does nothing by default.

Specified by:

onEntry in interface Traversable

Overrides:

onEntry in class DefaultTraversablePanel

Parameters:

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

See Also:

Traversable.onEntry(TraversableContext)

onProjectPanelEntry

public abstract void onProjectPanelEntry(TraversableContext traversableContext)

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

Note: This method should be protected. This method should not be called directly; instead use onEntry(oracle.ide.panels.TraversableContext) when displaying this panel.

Parameters:

traversableContext - the shared data context

getDataKey

public abstract 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.

Returns:

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

See Also:

getPropertyKeys()

getPropertyKeys

public abstract java.lang.String[] getPropertyKeys()

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 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"

Returns:

a list of property keys for this panel

See Also:

getDataKey()

getHashAdapterDelegateKey

protected java.lang.String getHashAdapterDelegateKey()

If the properties edited by this panel may be managed by a HSAdapterDelegate, override this method and return the key that identifies the parent hash structure.

Note: Only override this method if all properties edited in this GUI are delegated using a single key. If some properties are delegated while others are not, use a HSAdapterDelegateComponent to wrap the components that edit those properties.

See Also:

HSAdapterDelegateComponent

getProjectsOwningWorkspace

protected static Workspace getProjectsOwningWorkspace(Namespace data)

Returns the current Workspacein the Namespace. This method should not be used to retrieve the workspace properties under edit.

Parameters:

data - the data used in the context of this panel

Returns:

a Workspaceor null

Throws:

java.lang.NullPointerException - if data is null

getProject

protected static Project getProject(Namespace data)

Returns the Project that is being edited. This method should not be used to retrieve the project properties under edit, nor should it be modified. Instead call getPropertyData(oracle.ide.util.Namespace) and edit properties in that object.

Parameters:

data - the shared data used in the context of this panel

Returns:

the Project under edit; could be null if called outside the context of the Project Properties dialog

Throws:

java.lang.NullPointerException - if data is null

See Also:

getProject(Namespace, boolean), getPropertyData(oracle.ide.util.Namespace)

getProject

protected static Project getProject(Namespace data,
                                    boolean projectCopy)

Returns the Project that is being edited. When projectCopy is true, a copy of the Project is returned and any direct edits to this Project's properties will not be persisted and no changes made during the lifetime of the dialog will be visible in the Project object.

This method should not be used to retrieve or edit the properties of the Project under edit. Instead call getPropertyData(oracle.ide.util.Namespace).

Parameters:

data - the data used in the context of this panel

projectCopy - if true, returns a copy of the original project, without any edits made in the settings dialog

Returns:

a Project

Throws:

java.lang.NullPointerException - if data is null

See Also:

getProject(Namespace), getPropertyData(oracle.ide.util.Namespace)

getPropertyData

protected static PropertyStorage getPropertyData(Namespace data)

Gets a PropertyStorage object that wraps the properties under edit. This method handles returning the correct properties object, either those stored at the project-level or those stored in the workspace.

Parameters:

data - the data used in the context of this panel

Returns:

a PropertyStorage

Throws:

java.lang.NullPointerException - if data is null

See Also:

supportsWorkspaceSharedProperties()

editsSharedProperties

protected boolean editsSharedProperties()

Indicates whether this panel supports editing of Workspace-level properties that are shared across projects. The default implementation returns false. Subclasses must override this method and return true to allow editing of workspace-level shared properties from the Project Properties dialog.

Note: Not only must the panel return true here but the key that identifies the root of your properties hash structure must be registered using the shared-properties-hook.

Returns:

true if properties can be stored at the workspace level and shared across projects, false otherwise

isEditingSharedProperties

public static boolean isEditingSharedProperties(Namespace data)

Indicates whether this panel is currently editing Workspace-level properties that are shared across projects.

Parameters:

data - The TraversableContext for the panel

Returns:

true if currently editing Workspace-shared properties; false otherwise.

supportsSharedProperties

public final boolean supportsSharedProperties()

isUserOnly

public boolean isUserOnly()

The default implementation returns false, indicating that the properties that are edited on this panel can be set at the user and at the project level.

Subclasses that provide UI for user-only properties, those which are never stored in the project, should override this method and return true.

Returns:

true if the properties can only be set at the user level, false otherwise

isDefaultProject

public static final boolean isDefaultProject(Namespace data)

Indicates whether or not the data in the supplied Namespace corresponds to the default project properties data.

Parameters:

data - the shared Namespace

Returns:

true if the data is from the default project. Returns false if the data is a real project.

editingUserProperties

public static final boolean editingUserProperties(Namespace data)

Indicates whether or not the supplied Namespace corresponds to user properties opposed to shared properties.

Returns:

true if the data is user-specific project properties. Returns false if the data corresponds to (shared) project properties.

activateProperties

public final void activateProperties(TraversableContext tc,
                                     boolean useCustom)

Enables or disables custom properties. When useCustom is true, the custom properties are enabled so that they are accessible in the chained HashStructure. When useCustom is false, the custom properties are hidden so that they are not accessible from the project.

Parameters:

tc - the shared data context

useCustom - when true, custom properties are enabled, when false they are disabled and only project-level (shared) properties are used

See Also:

HashStructureNode.getProperties(), HashStructureNode.getPropertiesForOverriding()

arePropertiesOverridden

@Deprecated
public boolean arePropertiesOverridden()

Deprecated. No replacement.

setLayout

public void setLayout(java.awt.LayoutManager mgr)

Overrides:

setLayout in class java.awt.Container

add

public java.awt.Component add(java.awt.Component comp)

Overrides:

add in class java.awt.Container

add

public java.awt.Component add(java.awt.Component comp,
                              int index)

Overrides:

add in class java.awt.Container

add

public void add(java.awt.Component comp,
                java.lang.Object constraints)

Overrides:

add in class java.awt.Container

add

public void add(java.awt.Component comp,
                java.lang.Object constraints,
                int index)

Overrides:

add in class java.awt.Container

remove

public void remove(java.awt.Component comp)

Overrides:

remove in class java.awt.Container

remove

public void remove(int index)

Overrides:

remove in class java.awt.Container

removeAll

public void removeAll()

Overrides:

removeAll in class java.awt.Container

getLayout

public java.awt.LayoutManager getLayout()

Overrides:

getLayout in class java.awt.Container