Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.5)

E22562-01

oracle.apps.fnd.applcore.dt.patterns.piLayout.gui
Class BaseGuiComponent

java.lang.Object
  extended by oracle.ide.inspector.layout.CustomGUIComponent
      extended by oracle.apps.fnd.applcore.dt.patterns.piLayout.gui.BaseGuiComponent
All Implemented Interfaces:
SearchableContainer
Direct Known Subclasses:
TableGuiComponent, TreeGuiComponent, TreeTableGuiComponent

public abstract class BaseGuiComponent
extends CustomGUIComponent
implements SearchableContainer

Base Custom Gui Component, extended by applicationsTable, applicationsTree and applicationsTreeTable.

Author:
David Groves <david.groves@oracle.com>

Constructor Summary
BaseGuiComponent()
           
 
Method Summary
protected abstract  BaseGuiPanel createGuiPanel(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext, oracle.bali.inspector.PropertyModel model)
          Create the specific Gui Panel to be shown in the custom Gui.
 boolean findText(java.lang.String searchText, boolean searchForward, boolean searchRepeat)
          Find the specified searchText by searching forward or backward through the property labels of the Searchable component.
 GUIPanel getGUIPanel()
          Get custom graphical user interface.
 javax.swing.JLabel getLabel()
          Get an optional label.
protected abstract  oracle.bali.xml.metadata.XmlKey getRepresentativePropertyKey()
          Gets the XmlKey of a property that will be in the property model for the element that the PI's target.
 void onApply(oracle.bali.inspector.PropertyModel propertyModel)
          Called to apply changes made to the custom UI component property values.
 void onInitialize(oracle.bali.inspector.PropertyModel model)
          Method called to inialize 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.
 
Methods inherited from class oracle.ide.inspector.layout.CustomGUIComponent
getCustomGUIComponent, hasContent, setCustomGUIComponent, shouldApplyOnLostFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseGuiComponent

public BaseGuiComponent()
Method Detail

onInitialize

public void onInitialize(oracle.bali.inspector.PropertyModel model)
Method called to inialize the custom UI component with property values.

Specified by:
onInitialize in class CustomGUIComponent
Parameters:
model - the PropertyModel used to access property values.

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.

Overrides:
onUpdate in class CustomGUIComponent
Parameters:
model - the given model.

getLabel

public javax.swing.JLabel getLabel()
Get an optional label.

Overrides:
getLabel in class CustomGUIComponent
Returns:
a label to use to align a custom component with the rest of properties (optional).

getGUIPanel

public GUIPanel getGUIPanel()
Get custom graphical user interface.

Specified by:
getGUIPanel in class CustomGUIComponent
Returns:
the custom graphical user interface.

getRepresentativePropertyKey

protected abstract oracle.bali.xml.metadata.XmlKey getRepresentativePropertyKey()
Gets the XmlKey of a property that will be in the property model for the element that the PI's target. Used to find the XmlContext/Node since the whole PropertyModel might have stuff from multiple XmlContexts and Nodes.


createGuiPanel

protected abstract BaseGuiPanel createGuiPanel(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext,
                                               oracle.bali.inspector.PropertyModel model)
Create the specific Gui Panel to be shown in the custom Gui.

Parameters:
xmlContext - context
model - XMLEF property model.
Returns:
a BaseGuiPanel.

onApply

public void onApply(oracle.bali.inspector.PropertyModel propertyModel)
Called to apply changes made to the custom UI component property values.

Specified by:
onApply in class CustomGUIComponent
Parameters:
propertyModel - the property model containing the changes made (if any).

findText

public boolean findText(java.lang.String searchText,
                        boolean searchForward,
                        boolean searchRepeat)
Find the specified searchText by searching forward or backward through the property labels of the Searchable component.

An implementation of this method should perform the following steps:

Specified by:
findText in interface SearchableContainer
Parameters:
searchText - the text to be found.
searchForward - the direction of the search.
searchRepeat - repeat the search starting beyond the last match location (if any)
Returns:
true if a property label containing the searchText could be found.

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.5)

E22562-01

Copyright © 2011 Oracle. All Rights Reserved.