Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

oracle.ide.inspector
Class InspectorWindow

java.lang.Object
  extended by oracle.ide.view.View
      extended by oracle.ide.view.ViewDecorator
          extended by oracle.ide.docking.DockableView
              extended by oracle.ide.docking.DockableWindow
                  extended by oracle.ide.view.AbstractPinnable
                      extended by oracle.ide.inspector.InspectorWindow
All Implemented Interfaces:
java.util.EventListener, ControllerProvider, Dockable, Helpable, PropertyDisplay, Observer, Pinnable, ViewSelectionListener

public abstract class InspectorWindow
extends AbstractPinnable
implements PropertyDisplay

The InspectorWindow is a View consisting of a Toolbar area, a main body area and a status area. The main body area will contain at least one PropertyPage of type PropertyInspector which displays a list of property-value pairs for the selected object(s) of the active View. When applicable, the InspectorWindow will also display any additional PropertyPage pages that apply to the selection.

See Also:
PropertyInspector

Field Summary
static java.lang.String INSPECTOR_WINDOW_ID
          Id tag used for identifying an InspectorWidow in a ViewId.
static java.lang.String LAYOUT_SHOW_INSPECTOR
          Shows the inspector if a property named LAYOUT_SHOW_INSPECTOR is true.
 
Fields inherited from class oracle.ide.view.AbstractPinnable
_node, forceUpdate, isToolbarVisible, toolbar, TOOLBAR_ITEM, TOOLBAR_ITEM_COUNT
 
Fields inherited from class oracle.ide.docking.DockableView
CLOSED, HIDDEN, SHOWN
 
Fields inherited from class oracle.ide.view.View
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Fields inherited from interface oracle.ide.view.Pinnable
PIN_NONE, PIN_OBJECT, PIN_VIEW
 
Fields inherited from interface oracle.ide.docking.Dockable
DEFAULT_VISIBILITY_MINIMIZED, DEFAULT_VISIBILITY_RAISED, DEFAULT_VISIBILITY_VISIBLE, TYPE_DISCARDABLE, TYPE_GLOBAL_VISIBLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE
 
Constructor Summary
protected InspectorWindow(java.lang.String viewId)
           
 
Method Summary
 int dockableOrientation()
           
protected static boolean enableListMode()
           
protected  boolean equalPropertyModel(oracle.bali.inspector.PropertyModel propertyModel)
           
abstract  java.awt.Component[] getAdditionalTabPages()
          Get any additional GUI pages associated with the selected object or null.
abstract  java.beans.Customizer getCustomizer()
          Get any Customizer associated associated with the selected object or null.
abstract  oracle.bali.inspector.PropertyInspector getPropertyInspector()
          Get the single PropertyInspector InspectorPage assured to exist for any selected object.
abstract  boolean isStatusVisible()
          Determine whether or not the status area is currently set to visible.
abstract  void setStatus(java.lang.String text)
          Display a text message on the status area.
abstract  void setStatusVisible(boolean visible)
          Set the visibility of the status area.
 void showPropertyDescription(java.lang.String description)
           
 void updateHelp(HelpInfo helpInfo)
           
 
Methods inherited from class oracle.ide.view.AbstractPinnable
activeViewChanged, clear, getPinnedView, getPinState, getToolbar, isSingleton, isViewSupported, objectClosed, objectRenamed, persistPinTarget, restorePinTarget, setContext, setPinnedView, setPinState, setToolbarVisible, stateChange, update, viewSelectionChanged, viewSelectionChanged
 
Methods inherited from class oracle.ide.docking.DockableWindow
addTitleChangeListener, close, dockableHidden, dockableShown, fireTitleChangeListener, getCachedDockable, getDefaultVisibility, getHostedComponent, getMenuTitle, getSite, getTabDropListener, getTabIcon, getType, getUniqueName, isVisible, removeTitleChangeListener, setDockableVisible, setSite, setType, show, updateTitle
 
Methods inherited from class oracle.ide.docking.DockableView
afterAutoExpanding, afterRestoringFromAutoExpansion, beforeAutoExpanding, getAutoExpansionPreferredSize, getAutoExpansionSize, isAutoExpandable, isAutoExpandableEnabled, setAutoExpandable, setAutoExpandableEnabled
 
Methods inherited from class oracle.ide.view.ViewDecorator
activate, deactivate, getContext, getContextMenu, getController, getGUI, getHelpInfo, getSelectionFromUI, getViewWithoutDecoration, loadLayout, newId, saveLayout, setOwner, updateVisibleActions
 
Methods inherited from class oracle.ide.view.View
addViewListener, addViewSelectionListener, addViewStateListener, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getId, getSelection, getTabName, loadManifestToolbar, loadManifestToolbar, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, scheduleUpdateSelection, setId, toString, updateSelection, updateSelectionImpl, updateToolbarActions, updateVisibleActions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.ide.docking.Dockable
getTabName, getTitleName, loadLayout, saveLayout
 

Field Detail

INSPECTOR_WINDOW_ID

public static final java.lang.String INSPECTOR_WINDOW_ID
Id tag used for identifying an InspectorWidow in a ViewId.

See Also:
Constant Field Values

LAYOUT_SHOW_INSPECTOR

public static final java.lang.String LAYOUT_SHOW_INSPECTOR
Shows the inspector if a property named LAYOUT_SHOW_INSPECTOR is true.

See Also:
Constant Field Values
Constructor Detail

InspectorWindow

protected InspectorWindow(java.lang.String viewId)
Method Detail

enableListMode

protected static final boolean enableListMode()

equalPropertyModel

protected final boolean equalPropertyModel(oracle.bali.inspector.PropertyModel propertyModel)

getPropertyInspector

public abstract oracle.bali.inspector.PropertyInspector getPropertyInspector()
Get the single PropertyInspector InspectorPage assured to exist for any selected object.

Returns:
a PropertyInspector.

dockableOrientation

public int dockableOrientation()

getCustomizer

public abstract java.beans.Customizer getCustomizer()
Get any Customizer associated associated with the selected object or null. If the MultiInspectable whose IdePropertyModel is being displayed represents more than one Inspectable this method will return null.

Returns:
a Customizer if applicable.

getAdditionalTabPages

public abstract java.awt.Component[] getAdditionalTabPages()
Get any additional GUI pages associated with the selected object or null. If the MultiInspectable whose IdePropertyModel is being displayed represents more than one Inspectable this method will return null.

Returns:
an array of Component for display if applicable.

isStatusVisible

public abstract boolean isStatusVisible()
Determine whether or not the status area is currently set to visible.

Returns:
true if the status area has not been hidden.

setStatusVisible

public abstract void setStatusVisible(boolean visible)
Set the visibility of the status area.

Parameters:
visible - true to display the status area, false to hide it.

showPropertyDescription

public void showPropertyDescription(java.lang.String description)
Specified by:
showPropertyDescription in interface PropertyDisplay

updateHelp

public void updateHelp(HelpInfo helpInfo)
Specified by:
updateHelp in interface PropertyDisplay

setStatus

public abstract void setStatus(java.lang.String text)
Display a text message on the status area.

Parameters:
text - the message to display.

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

Copyright © 1997, 2010, Oracle. All rights reserved.