oracle.ide.model.panels

Class HSAdapterDelegateComponent

java.lang.Object

oracle.ide.model.panels.HSAdapterDelegateComponent

public final class HSAdapterDelegateComponent
extends java.lang.Object

A class for handling GUI that edits Project or Workspace properties that may be manged by a HSAdapterDelegate. When properties are delegated, meaning not stored directly in the Project or Workspace hash structure, the component behaves as read-only and all keyboard and mouse input to is sub-components is blocked.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HSAdapterDelegateComponent.Scope Describes the scope of property delegation, either Project or Workspace.

Constructor Summary

Constructors

Constructor and Description
HSAdapterDelegateComponent(javax.swing.JComponent comp) Constructs a HSAdapterDelegateComponent which can decorate the supplied component as read-only if the properties edited by the component are not stored in the Project or Workspace but rather delegated to a HSAdapterDelegate object.

Method Summary

Modifier and Type	Method and Description
void	configureComponent(java.lang.String propertyDataKey, HSAdapterDelegateComponent.Scope scope, HashStructureNode node) Configures the component given in the construtor based on whether the properties identified by propertyDataKey are delegated to a HSAdapterDelegate.
javax.swing.JComponent	getComponent() Retrieves the component that handles delegated properties, making itself read-only and blocking input as necessary.
static boolean	propertiesAreDelegated(java.lang.String propertyDataKey, HSAdapterDelegateComponent.Scope scope, HashStructureNode node)

Methods inherited from class java.lang.Object

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

Constructor Detail

HSAdapterDelegateComponent

public HSAdapterDelegateComponent(javax.swing.JComponent comp)

Constructs a HSAdapterDelegateComponent which can decorate the supplied component as read-only if the properties edited by the component are not stored in the Project or Workspace but rather delegated to a HSAdapterDelegate object.

Parameters:

comp - the component to decorate as read-only if properties are delegated to a HSAdapterDelegate

See Also:

configureComponent(java.lang.String, oracle.ide.model.panels.HSAdapterDelegateComponent.Scope, oracle.ide.model.HashStructureNode)

Method Detail

getComponent

public javax.swing.JComponent getComponent()

Retrieves the component that handles delegated properties, making itself read-only and blocking input as necessary.

Note: do not add components directly to this component, instead add them to the blocked component given in the constructor.

Returns:

the root component of the blocking hierarchy.

configureComponent

public void configureComponent(java.lang.String propertyDataKey,
                               HSAdapterDelegateComponent.Scope scope,
                               HashStructureNode node)

Configures the component given in the construtor based on whether the properties identified by propertyDataKey are delegated to a HSAdapterDelegate. When properties are delegated, the component is read-only, otherwise the component is read-write and behaves normally.

Parameters:

propertyDataKey - the key that identifies the hash structure that stores a set of properties, or an individual property key

scope - denotes Project or Workspace scope

node - the Project or Workspace node whose properties are being edited

propertiesAreDelegated

public static boolean propertiesAreDelegated(java.lang.String propertyDataKey,
                                             HSAdapterDelegateComponent.Scope scope,
                                             HashStructureNode node)