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

E13403-08

oracle.ide.view
Class ViewDecorator

java.lang.Object
  extended by oracle.ide.view.View
      extended by oracle.ide.view.ViewDecorator
All Implemented Interfaces:
ControllerProvider, Helpable
Direct Known Subclasses:
DockableView

public class ViewDecorator
extends View

Base decorator object for View implementations.


Field Summary
 
Fields inherited from class oracle.ide.view.View
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Constructor Summary
protected ViewDecorator(View decorated)
          Creates a ViewDecorator.
 
Method Summary
 void activate()
           
 void close()
           
 void deactivate()
          Cleans up after this view stops being the active view.
 Context getContext(java.util.EventObject event)
           
 ContextMenu getContextMenu()
           
 Controller getController()
          Get the Controller associated with this view.
 java.awt.Component getGUI()
           
 HelpInfo getHelpInfo()
           
protected  Element[] getSelectionFromUI()
          This method retrieve's the selection in this View directly from the UI.
 Toolbar getToolbar()
          Get the toolbar associated with this view.
 View getViewWithoutDecoration()
          Returns the View without any decorators.
 boolean isVisible()
           
 void loadLayout(PropertyAccess p)
           
protected  java.lang.String newId()
          Generates a unique view ID.
 void saveLayout(PropertyAccess p)
           
protected  void setOwner(View owner)
           
 void setToolbarVisible(boolean visible)
           
 void show()
          Shows the view if hidden.
 void updateTitle(java.lang.Object obj)
          Called when the view needs to update its title based on the specified object.
 void updateVisibleActions(UpdateMessage updateMessage)
          Called when the IDE or an extension requests that the View updates the enabled state of any actions that are visible on screen.
 
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
 

Constructor Detail

ViewDecorator

protected ViewDecorator(View decorated)
Creates a ViewDecorator. If the specified parameter is null, then ViewDecorator just behaves exactly like View (i.e. no decoration).

Parameters:
decorated - the View to decorate
Method Detail

getViewWithoutDecoration

public View getViewWithoutDecoration()
Description copied from class: View
Returns the View without any decorators.

Overrides:
getViewWithoutDecoration in class View

activate

public void activate()
Overrides:
activate in class View

deactivate

public void deactivate()
Description copied from class: View
Cleans up after this view stops being the active view.

Overrides:
deactivate in class View

close

public void close()
Overrides:
close in class View

getContext

public Context getContext(java.util.EventObject event)
Overrides:
getContext in class View
Parameters:
event - event associated with the context.
Returns:
the current view context for the given event.

getContextMenu

public ContextMenu getContextMenu()
Overrides:
getContextMenu in class View
Returns:
the ContextMenu, if any.

getController

public Controller getController()
Description copied from interface: ControllerProvider
Get the Controller associated with this view.

Specified by:
getController in interface ControllerProvider
Overrides:
getController in class View
Returns:
the Controller associated with this view.

getGUI

public java.awt.Component getGUI()
Specified by:
getGUI in class View
Returns:
the root graphical user interface component.

getHelpInfo

public HelpInfo getHelpInfo()
Specified by:
getHelpInfo in interface Helpable
Overrides:
getHelpInfo in class View

getSelectionFromUI

protected Element[] getSelectionFromUI()
Description copied from class: View
This method retrieve's the selection in this View directly from the UI. Callers must invoke this method on the Swing/AWT event dispatch thread, and implementations can assume that calls are on the Swing/AWT event dispatch thread.

Overrides:
getSelectionFromUI in class View
Returns:
the selection from the UI.

getToolbar

public Toolbar getToolbar()
Description copied from class: View
Get the toolbar associated with this view.

Overrides:
getToolbar in class View

isVisible

public boolean isVisible()
Overrides:
isVisible in class View

loadLayout

public void loadLayout(PropertyAccess p)
Overrides:
loadLayout in class View

newId

protected java.lang.String newId()
Description copied from class: View
Generates a unique view ID. The default view ID is UnknownView{N}, where {N} is a unique integer value. Subclasses should override this method to return a more meaningful view ID.

Overrides:
newId in class View

saveLayout

public void saveLayout(PropertyAccess p)
Overrides:
saveLayout in class View

setOwner

protected void setOwner(View owner)
Overrides:
setOwner in class View

setToolbarVisible

public void setToolbarVisible(boolean visible)
Overrides:
setToolbarVisible in class View

show

public void show()
Description copied from class: View
Shows the view if hidden. Raises the view to the top if covered by other windows.

Overrides:
show in class View

updateTitle

public void updateTitle(java.lang.Object obj)
Description copied from class: View
Called when the view needs to update its title based on the specified object.

Overrides:
updateTitle in class View
Parameters:
obj - the specified object.

updateVisibleActions

public void updateVisibleActions(UpdateMessage updateMessage)
Description copied from class: View
Called when the IDE or an extension requests that the View updates the enabled state of any actions that are visible on screen. Typically this will involve updating actions that are in visible toolbars. If a View contains or manages other nested instances of View, the outer call to updateVisibleActions should propagate inward to call the updateVisibleActions of all visible, nested Views.

Overrides:
updateVisibleActions in class View
Parameters:
updateMessage - information on what is triggering the update. Implementations may make use of this information to decide whether or not an update is necessary, since updating the enabled state of a toolbar button may be a lengthy operation. For example, buttons that control a remote debugger would involve network I/O and evaluating their updated state could be avoided if the updateMessage indicates that the source of the update is not relevant to the debugger.

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

E13403-08

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