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

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.apps.fnd.applcore.dt.patterns.piLayout.gui.BaseGuiPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, SearchableContainer

Direct Known Subclasses:

TableGuiPanel, TreeGuiPanel, TreeTableGuiPanel

public abstract class BaseGuiPanel
extends javax.swing.JPanel
implements SearchableContainer

Class that acts as a Gui Panel for use in the table custom gui component in the property inspector.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JTabbedPane

_tPane

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BaseGuiPanel()
Base Constructor.

Method Summary

protected void	addCommonXMLEFKeys() Add common XMLEF keys for create/edit/delete/duplicate patterns.
protected void	addTab(UpdatableTabPanel panel, java.lang.String tabLabel) Add a tab.
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.
protected java.util.List<CustomGuiField>	getCreateButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext, oracle.bali.inspector.PropertyModel model) Get a list of the create buttons.
protected java.util.List<CustomGuiField>	getDeleteButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext, oracle.bali.inspector.PropertyModel model) Get a list of the delete buttons.
protected java.util.List<CustomGuiField>	getDuplicateButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext, oracle.bali.inspector.PropertyModel model) Get a list of the duplicate buttons.
protected java.util.List<CustomGuiField>	getEditButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext, oracle.bali.inspector.PropertyModel model) Get a list of the edit buttons.
oracle.bali.xml.metadata.XmlKey	getKey(java.lang.String key) Get an XML key for the named property.
static java.util.Map<java.lang.String,oracle.bali.xml.metadata.XmlKey>	getKeys() Get the keys for this custom PI gui.
protected void	populateTabbedPane() Populate the tabbed pane with tabs setup using #addTab.
protected abstract void	putKey(java.lang.String attName) Private helper method to populate a key in the Map without too much bulk in code text.
protected void	setupLayout() Set the layout of the panel.
void	updateUI(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext, oracle.bali.inspector.PropertyModel model, org.w3c.dom.Element elem) Update the ui after a model change.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

_tPane

protected javax.swing.JTabbedPane _tPane

Constructor Detail

BaseGuiPanel

public BaseGuiPanel()

Base Constructor.

Method Detail

setupLayout

protected void setupLayout()

Set the layout of the panel.

getCreateButtons

protected java.util.List<CustomGuiField> getCreateButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext,
                                                          oracle.bali.inspector.PropertyModel model)

Get a list of the create buttons.

Parameters:

xmlContext - xmlContext

model - property model

Returns:

list of gui fields.

getDuplicateButtons

protected java.util.List<CustomGuiField> getDuplicateButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext,
                                                             oracle.bali.inspector.PropertyModel model)

Get a list of the duplicate buttons.

Parameters:

xmlContext - xmlContext

model - property model

Returns:

list of gui fields.

getDeleteButtons

protected java.util.List<CustomGuiField> getDeleteButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext,
                                                          oracle.bali.inspector.PropertyModel model)

Get a list of the delete buttons.

Parameters:

xmlContext - xmlContext

model - property model

Returns:

list of gui fields.

getEditButtons

protected java.util.List<CustomGuiField> getEditButtons(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext,
                                                        oracle.bali.inspector.PropertyModel model)

Get a list of the edit buttons.

Parameters:

xmlContext - xmlContext

model - property model

Returns:

list of gui fields.

populateTabbedPane

protected void populateTabbedPane()

Populate the tabbed pane with tabs setup using #addTab.

addCommonXMLEFKeys

protected void addCommonXMLEFKeys()

Add common XMLEF keys for create/edit/delete/duplicate patterns.

addTab

protected void addTab(UpdatableTabPanel panel,
                      java.lang.String tabLabel)

Add a tab.

Parameters:

panel - panel to add to tab.

tabLabel - what to call it.

updateUI

public void updateUI(oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext,
                     oracle.bali.inspector.PropertyModel model,
                     org.w3c.dom.Element elem)

Update the ui after a model change.

Parameters:

xmlContext - environmental access

model - up-to-date PropertyModel

elem - element to take properties from.

getKey

public oracle.bali.xml.metadata.XmlKey getKey(java.lang.String key)

Get an XML key for the named property.

Parameters:

key - name, local to this component.

Returns:

xmlKey

putKey

protected abstract void putKey(java.lang.String attName)

Private helper method to populate a key in the Map without too much bulk in code text. Subclasses should over-ride to setup the correct XMLEF names.

Parameters:

attName - attribute name

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:

• If a label was previously found in this component, its highlight should be cleared (see PropertyLabel.clearHighlight).
• If the searchText length is zero, return false. If there was a previously found label, its highlight should be cleared before returning.
• Iterate the contained labels either forward or backward. If a prev invocation of findText found a match, skip the iterated items until the previous match is reached. Once the previous match is reached, it is probably a good time to null out the saved reference to the previous match. If searchRepeat is false, start looking for a match at this point. If searchRepeat is true, start looking for a match on the next iteration.
• If a property label containing the specified searchText is found, the Searchable component should make sure the label is visible and highlighted. Using PropertyText.findLabel will ensure that the matching text in the label is highlighted. Ensuring that the label is actually visible is implementation dependent, but will likely involve calling scrollRectToVisible using the label's bounds. The Searchable component should also remember the matched label for the next invocation.

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.

getKeys

public static java.util.Map<java.lang.String,oracle.bali.xml.metadata.XmlKey> getKeys()

Get the keys for this custom PI gui.

Returns:

map of keys.