oracle.ide.db.components

Class DBObjectIDComponentWrapper

java.lang.Object

oracle.ide.db.components.ComponentWrapper<T>

oracle.ideimpl.db.components.AsynchronousComponentWrapper<T>

oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

oracle.ide.db.components.DBObjectIDComponentWrapper

public class DBObjectIDComponentWrapper
extends oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

ComponentWrapper implementation that wraps one or more DBObjectChoosers in order to edit a DBObjectID property.

The default behaviour uses the metadata for the property, specifically the @References annotation, to determine the right chooser configuration. This class can be subclassed to provide custom logic for properties where required.

Since:

12

Constructor Summary

Constructors

Constructor and Description
DBObjectIDComponentWrapper() Constructs a new wrapper for editing a DBObjectID.

Method Summary

Modifier and Type	Method and Description
protected DBObjectChooser	createObjectChooser(DBObjectChooser parent, java.lang.String... types) Allow subclasses to override the construction of the DBObjectChooser
java.awt.Component	getDefaultFocusComponent() Gets the particular Component that is the focus of the property value.
protected Schema	getDefaultSchema() Gets the default schema to use in all the choosers.
protected javax.swing.text.Document	getDocument() Gets the default Document that this wrapper will listen to.
java.awt.Component[]	getFocusComponents() The UI components whose focus events the component wrapper should listen to (and inform the owning panel of).
protected DBObjectChooser	getObjectChooser() Returns the DBObjectChooser used to select the referenced object.
protected DBObjectChooser	getParentChooser() Returns the DBObjectChooser used to select the parent of the referenced object.
java.lang.Object	getPropertyValue() Gets the value of the property as currently set in the UI Component e.g.
protected DBObjectChooser	getSchemaChooser() Returns the DBObjectChooser used to select the Schema of the referenced object.
protected void	initialiseComponent() If any setup of the Component is needed after the provider/object are known override this method and implement there.
protected void	initialiseComponentListener() Initialises a listener to listen to focus changes to any Component returned by AsynchronousComponentWrapper.getFocusComponents().
protected void	initialiseNewObject(SystemObject obj) If the add button is included, this method will be called on any new object prior to it displaying in the create dialog.
protected boolean	isEditable() Tests whether the chooser(s) should be editable.
protected boolean	isFixedSchema() Tests whether the schema is fixed, and therefore no schema combo should be displayed regardless of the property information.
protected boolean	isIncludeContextObject() Tests whether the chooser should include the context object we are editing (assuming it matches the types listed by the chooser).
protected boolean	isShowAddButton() Tests whether the chooser should include an "add" button for creating (and selecting) new objects.
protected boolean	isShowDBLinkButton() Tests whether the schema chooser (if there is one) should include the dblink button for selecting via a database link.
protected boolean	isShowEditButton() Tests whether the chooser should include an "edit" button for editing the currently selected object
protected void	setActiveImpl(boolean active) Called when a ComponentWrapper is activated/deactivated - typically onEntry/onExit of the owning panel.
protected void	setPropertyValueImpl(java.lang.Object value) Implementation of AsynchronousDocumentComponentWrapper.setPropertyValue(java.lang.Object) which is called with a guarantee that the DocumentListener won't be active.
protected void	setupObjectChooser(DBObjectChooser chooser) Perform any addition configuration of the object chooser before it has the DBObjectProvider and set (i.e.
protected void	setupParentChooser(DBObjectChooser chooser) Perform any addition configuration of the parent object chooser before it has the DBObjectProvider set (i.e.
void	setValidationStatus(java.util.Collection<ValidationException> ves, oracle.ideimpl.db.validate.DBValidationHandler handler) Sets the validation status of the wrapped property value.

Methods inherited from class oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper

addDocumentListener, documentChanged, gainingFocus, isListenOnFocusOnly, losingFocus, setPropertyValue

Methods inherited from class oracle.ideimpl.db.components.AsynchronousComponentWrapper

cancelCurrentWrapper, cancelUpdates, commitCurrentWrapper, isDirty, markDirty, prepareForWrite, registerCancellingComponent, writeFinished, writeUpdates

Methods inherited from class oracle.ide.db.components.ComponentWrapper

addListener, addVetoListener, checkPropertyIsSupported, createComponentForLayout, fireChangeEvent, fireVetoableChangeEvent, getActiveComponent, getCellEditorComponent, getComponent, getComponentContext, getDefaultValidationComponent, getExistingPropertyValue, getLabel, getLogger, getOriginalObject, getOriginalPropertyValue, getPropertyDisplayName, getPropertyHelper, getPropertyName, getProvider, getUpdatedObject, initialise, isActive, isSupported, isVolatile, processComponent, refreshObject, removeListener, removeVetoListener, resetPropertyValue, resourceComponent, setActive, setEnabled, setPropertyDisplayName, setReadOnly, setUIReadOnly, setVisible, showError

Methods inherited from class java.lang.Object

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

Constructor Detail

DBObjectIDComponentWrapper

public DBObjectIDComponentWrapper()

Constructs a new wrapper for editing a DBObjectID.

Method Detail

getPropertyValue

public java.lang.Object getPropertyValue()

Description copied from class: ComponentWrapper

Gets the value of the property as currently set in the UI Component e.g. for a String property in a text field this returns the text currently set in the JTextField.

Specified by:

getPropertyValue in class ComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

setValidationStatus

public void setValidationStatus(java.util.Collection<ValidationException> ves,
                                oracle.ideimpl.db.validate.DBValidationHandler handler)

Description copied from class: ComponentWrapper

Sets the validation status of the wrapped property value. If appropriate this should highlight the component(s) containing the invalid value(s) to indicate where the problem is to the user.

By default this applys the status highlight to the default validation component.

Overrides:

setValidationStatus in class ComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

Parameters:

ves - what is wrong with the value (can be null or empty to signify that the value is valid).

handler - the calling handler.

See Also:

ComponentWrapper.getDefaultValidationComponent()

setPropertyValueImpl

protected void setPropertyValueImpl(java.lang.Object value)

Description copied from class: oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper

Implementation of AsynchronousDocumentComponentWrapper.setPropertyValue(java.lang.Object) which is called with a guarantee that the DocumentListener won't be active.

Specified by:

setPropertyValueImpl in class oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

Parameters:

value - the property value to set in the UI

initialiseComponent

protected void initialiseComponent()

Description copied from class: ComponentWrapper

If any setup of the Component is needed after the provider/object are known override this method and implement there.

Overrides:

initialiseComponent in class ComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

getDocument

protected javax.swing.text.Document getDocument()

Description copied from class: oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper

Gets the default Document that this wrapper will listen to.

Specified by:

getDocument in class oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

Returns:

the Document to listen to, can be null to not initialise the DocumentListener.

initialiseComponentListener

protected void initialiseComponentListener()

Description copied from class: oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper

Initialises a listener to listen to focus changes to any Component returned by AsynchronousComponentWrapper.getFocusComponents(). The listener calls ComponentWrapper.fireChangeEvent() when focus is lost, if AsynchronousComponentWrapper.markDirty() has been called.

Implementing classes MUST call this superclass representation if they want the asynchronous functionality

In addition to the focus listeners, the Document returned by AsynchronousDocumentComponentWrapper.getDocument() will be passed to AsynchronousDocumentComponentWrapper.addDocumentListener(Document) ensuring that changes made while the component has focus will call AsynchronousComponentWrapper.markDirty().

Overrides:

initialiseComponentListener in class oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

setActiveImpl

protected void setActiveImpl(boolean active)

Description copied from class: ComponentWrapper

Called when a ComponentWrapper is activated/deactivated - typically onEntry/onExit of the owning panel. Subclasses should use this method to add/remove object/provider listeners etc.

Overrides:

setActiveImpl in class oracle.ideimpl.db.components.AsynchronousDocumentComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

getFocusComponents

public java.awt.Component[] getFocusComponents()

Description copied from class: oracle.ideimpl.db.components.AsynchronousComponentWrapper

The UI components whose focus events the component wrapper should listen to (and inform the owning panel of). Typically, this is the component being wrapped by this wrapper. With component wrappers whose components are really panels with further components inside, this method should be overridden to specify the correct components.

Overrides:

getFocusComponents in class oracle.ideimpl.db.components.AsynchronousComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

Returns:

the components whose focus events are important for this component wrapper. Defaults to the wrapped component.

getDefaultFocusComponent

public java.awt.Component getDefaultFocusComponent()

Description copied from class: ComponentWrapper

Gets the particular Component that is the focus of the property value. This is used when requesting focus for the property, and also used by the validation layer to know which Component should be highlighted as invalid.

By default this returns the active component.

Overrides:

getDefaultFocusComponent in class oracle.ideimpl.db.components.AsynchronousComponentWrapper<oracle.ideimpl.db.controls.IdPanel>

Returns:

the focusable component that represents the actual property value.

setupObjectChooser

protected void setupObjectChooser(DBObjectChooser chooser)

Perform any addition configuration of the object chooser before it has the DBObjectProvider and set (i.e. before it has been initialised). By default this does nothing, subclasses can override as necessary to add filters etc to the chooser.

Parameters:

chooser - the "object" chooser for this wrapper.

setupParentChooser

protected void setupParentChooser(DBObjectChooser chooser)

Perform any addition configuration of the parent object chooser before it has the DBObjectProvider set (i.e. before it has been initialised). By default this does nothing, subclasses can override as necessary to add filters etc to the chooser.

Parameters:

chooser - the "parent" chooser for this wrapper.

isEditable

protected boolean isEditable()

Tests whether the chooser(s) should be editable.

Returns:

true by default, override as required.

isIncludeContextObject

protected boolean isIncludeContextObject()

Tests whether the chooser should include the context object we are editing (assuming it matches the types listed by the chooser).

Returns:

true by default, override as required.

isFixedSchema

protected boolean isFixedSchema()

Tests whether the schema is fixed, and therefore no schema combo should be displayed regardless of the property information.

Returns:

false by default, override as required.

getDefaultSchema

protected Schema getDefaultSchema()

Gets the default schema to use in all the choosers.

Returns:

the schema of the updated object by default

isShowAddButton

protected boolean isShowAddButton()

Tests whether the chooser should include an "add" button for creating (and selecting) new objects.

Returns:

false by default, override as appropriate

isShowEditButton

protected boolean isShowEditButton()

Tests whether the chooser should include an "edit" button for editing the currently selected object

Returns:

true by default, unless the property is "schema". Override as appropriate

isShowDBLinkButton

protected boolean isShowDBLinkButton()

Tests whether the schema chooser (if there is one) should include the dblink button for selecting via a database link.

Returns:

false by default, override as appropriate

initialiseNewObject

protected void initialiseNewObject(SystemObject obj)

If the add button is included, this method will be called on any new object prior to it displaying in the create dialog.

Parameters:

obj - the new object about to be created

createObjectChooser

protected DBObjectChooser createObjectChooser(DBObjectChooser parent,
                                              java.lang.String... types)

Allow subclasses to override the construction of the DBObjectChooser

Parameters:

parent -

types -

Returns:

getSchemaChooser

protected final DBObjectChooser getSchemaChooser()

Returns the DBObjectChooser used to select the Schema of the referenced object. Can be null.

getParentChooser

protected final DBObjectChooser getParentChooser()

Returns the DBObjectChooser used to select the parent of the referenced object. Can be null.

getObjectChooser

protected final DBObjectChooser getObjectChooser()

Returns the DBObjectChooser used to select the referenced object.