public abstract class CustomGUIComponent
extends java.lang.Object
CustomComponent
is shown in a DisplayGroup
the UI for that component must be encapsulated in a CustomGUIComponent
subclass.Constructor and Description |
---|
CustomGUIComponent() |
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() |
public abstract GUIPanel getGUIPanel()
public javax.swing.JLabel getLabel()
public final void setCustomComponent(CustomComponent custComp)
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.custComp
- the CustomComponent
to be setpublic final CustomComponent getCustomComponent()
CustomComponent
that was set at initializationpublic boolean shouldApplyOnLostFocus()
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
.getGUIPanel()
, GUIPanel.getFocusableComponent()
public boolean hasContent()
true
.true
if this custom component has content, false
if it is empty.public abstract void onInitialize(oracle.bali.inspector.PropertyModel model)
model
- the property model to use to initialize the custom UI component.public void onUpdate(oracle.bali.inspector.PropertyModel model)
model
- the given model.public abstract void onApply(oracle.bali.inspector.PropertyModel model)
model
- the property model containing the changes made (if any).public static void setCustomGUIComponent(javax.swing.JComponent component, CustomGUIComponent guiComponent)
component
- the root JComponentguiComponent
- the CustomGUIComponent with component as its rootpublic static CustomGUIComponent getCustomGUIComponent(javax.swing.JComponent component)
component
- the potential root component