oracle.ide.inspector.layout

Class CustomGUIComponent

java.lang.Object

oracle.ide.inspector.layout.CustomGUIComponent

public abstract class CustomGUIComponent
extends java.lang.Object

When a CustomComponent is shown in a DisplayGroup the UI for that component must be encapsulated in a CustomGUIComponent subclass.

Constructor Summary

Constructors

Constructor and Description
CustomGUIComponent()

Method Summary

Modifier and Type	Method and Description
CustomComponent	getCustomComponent()
static CustomGUIComponent	getCustomGUIComponent(javax.swing.JComponent component) Retrieve the CustomGUIComponent for which the specified JComponent is the root component.
abstract GUIPanel	getGUIPanel()
javax.swing.JLabel	getLabel()
boolean	hasContent() Indicates whether this custom component is displaying any property.
abstract void	onApply(oracle.bali.inspector.PropertyModel model) Called to apply changes made to the custom UI component property values.
abstract void	onInitialize(oracle.bali.inspector.PropertyModel model) Called to initialize the custom UI component with property values.
void	onUpdate(oracle.bali.inspector.PropertyModel model) Called to update the GUI component with the given model, without redrawing GUI components or updating the model.
void	setCustomComponent(CustomComponent custComp) Set the CustomComponent for this CustomGUIComponent.
static void	setCustomGUIComponent(javax.swing.JComponent component, CustomGUIComponent guiComponent) Set the specified JComponent to be the root component of the specified CustomGUIComponent.
boolean	shouldApplyOnLostFocus()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomGUIComponent

public CustomGUIComponent()

Method Detail

getGUIPanel

public abstract GUIPanel getGUIPanel()

Returns:

the custom graphical user interface.

getLabel

public javax.swing.JLabel getLabel()

Returns:

a label to use to align a custom component with the rest of properties (optional).

setCustomComponent

public final void setCustomComponent(CustomComponent custComp)

Set the CustomComponent for this CustomGUIComponent. This method is called by the framework as part of the initialization of the CustomGUIComponent. This method should not be called by clients or subclasses. The CustomComponent may be accessed using the getCustomComponent() method.

Parameters:

custComp - the CustomComponent to be set

getCustomComponent

public final CustomComponent getCustomComponent()

Returns:

the CustomComponent that was set at initialization

shouldApplyOnLostFocus

public boolean shouldApplyOnLostFocus()

Returns:

whether if the method onApply should be called if the custom component loses focus. This flag is used only if the GUIPanel returns a JComponent from the the method GUIPanel.getFocusableComponent(). The default value is true.

See Also:

getGUIPanel(), GUIPanel.getFocusableComponent()

hasContent

public boolean hasContent()

Indicates whether this custom component is displaying any property. The default value is true.

Returns:

true if this custom component has content, false if it is empty.

onInitialize

public abstract void onInitialize(oracle.bali.inspector.PropertyModel model)

Called to initialize the custom UI component with property values.

Parameters:

model - the property model to use to initialize the custom UI component.

onUpdate

public void onUpdate(oracle.bali.inspector.PropertyModel model)

Called to update the GUI component with the given model, without redrawing GUI components or updating the model.

Parameters:

model - the given model.

onApply

public abstract void onApply(oracle.bali.inspector.PropertyModel model)

Called to apply changes made to the custom UI component property values.

Parameters:

model - the property model containing the changes made (if any).

setCustomGUIComponent

public static void setCustomGUIComponent(javax.swing.JComponent component,
                                         CustomGUIComponent guiComponent)

Set the specified JComponent to be the root component of the specified CustomGUIComponent.

Parameters:

component - the root JComponent

guiComponent - the CustomGUIComponent with component as its root

getCustomGUIComponent

public static CustomGUIComponent getCustomGUIComponent(javax.swing.JComponent component)

Retrieve the CustomGUIComponent for which the specified JComponent is the root component.

Parameters:

component - the potential root component

Returns:

a CustomGUIComponent, or null if the specified JComponent was not a CustomGUIComponent root.