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

E13403-05

oracle.ide.docking
Class DockableView

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

public abstract class DockableView
extends ViewDecorator
implements Dockable

This interface is the bridge between the Dockable interface docking system and the View interface. Addin writers should extend DockableWindow, and not implement this interface directly.

See Also:
Docking Package Summary

Field Summary
static int CLOSED
          stateChange constant.
static int HIDDEN
          stateChange constant.
static int SHOWN
          stateChange constant.
 
Fields inherited from class oracle.ide.view.View
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
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 DockableView()
           
protected DockableView(View decorated)
           
 
Method Summary
 void afterAutoExpanding()
          Called after this dockable is displayed "auto-expanded."
 void afterRestoringFromAutoExpansion(int orientation, java.awt.Dimension autoExpandedWindowSize, boolean userResized)
          Called after this dockable is restored from being displayed "auto-expanded."
 void beforeAutoExpanding()
          Called before this dockable is going to be displayed "auto-expanded."
 java.awt.Dimension getAutoExpansionPreferredSize(int orientation)
          
 java.awt.Dimension getAutoExpansionSize(int orientation, javax.swing.JPanel dockedTitledPanel)
          
 boolean isAutoExpandable()
          
 boolean isAutoExpandableEnabled()
          
 void setAutoExpandable(boolean autoExpandable)
          Enables/disables "auto-expansion" in this dockable.
 void setAutoExpandableEnabled(boolean autoExpandableEnabled)
          Enables or disables the "auto-expand" feature in this dockable.
abstract  void setDockableVisible(boolean bVisible)
          Shows/hides the dockable.
abstract  void setType(int type)
          Set the dockable type.
 
Methods inherited from class oracle.ide.view.ViewDecorator
activate, close, deactivate, getContext, getContextMenu, getController, getGUI, getHelpInfo, getSelectionFromUI, getToolbar, getViewWithoutDecoration, isVisible, loadLayout, newId, saveLayout, setOwner, setToolbarVisible, show, updateTitle, 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
addTitleChangeListener, getDefaultVisibility, getHostedComponent, getMenuTitle, getSite, getTabDropListener, getTabIcon, getTabName, getTitleName, getType, getUniqueName, loadLayout, removeTitleChangeListener, saveLayout, setSite
 

Field Detail

SHOWN

public static final int SHOWN
stateChange constant.

Used when the UI is made visible or accessible.
Accessible means it is tabbed with other dockable windows. In this case, the SHOWN stateChange will be sent although the JComponent.isVisible() == false.

SHOWN will be used when a layout is loaded as well as when the API is used.

See Also:
Constant Field Values

HIDDEN

public static final int HIDDEN
stateChange constant.

HIDDEN is the counterpart of SHOWN
It will be called when the user pressed the 'X' button, and when the layout changes (even if the dockable is visible in both layouts)

See Also:
Constant Field Values

CLOSED

public static final int CLOSED
stateChange constant.

CLOSED is sent to Dockable that return TYPE_DISCARDABLE on getType().
CLOSED is sent when the close button is pressed after HIDDEN only if the dockable is alone in a window or tabbed only with other discardable windows.

See Also:
Constant Field Values
Constructor Detail

DockableView

protected DockableView()

DockableView

protected DockableView(View decorated)
Method Detail

setDockableVisible

public abstract void setDockableVisible(boolean bVisible)
Shows/hides the dockable. This should be called in place of setVisible


setType

public abstract void setType(int type)
Set the dockable type.


isAutoExpandable

public final boolean isAutoExpandable()

Specified by:
isAutoExpandable in interface Dockable
Returns:
true if this dockable can be auto-expanded. Auto-expansion is the ability to be automatically expanded when the user hovers over a hot spot (usually the dockable's tab or the whole dockable if it is fully visible). This effect is similar to the expansion shown when a dockable is minimized and a user hover over the minimized dockable.

setAutoExpandable

public final void setAutoExpandable(boolean autoExpandable)
Enables/disables "auto-expansion" in this dockable.

Specified by:
setAutoExpandable in interface Dockable
Parameters:
autoExpandable - the new value for "auto-expansion".
See Also:
Dockable.isAutoExpandable()

isAutoExpandableEnabled

public final boolean isAutoExpandableEnabled()

Specified by:
isAutoExpandableEnabled in interface Dockable
Returns:
true if this dockable is "auto-expandable" and if the "auto-expand" feature is enabled.
See Also:
Dockable.isAutoExpandable()

setAutoExpandableEnabled

public final void setAutoExpandableEnabled(boolean autoExpandableEnabled)
Enables or disables the "auto-expand" feature in this dockable. This method has effect only if Dockable.isAutoExpandable() is true

Specified by:
setAutoExpandableEnabled in interface Dockable
Parameters:
autoExpandableEnabled - the new value to enable/disable the "auto-expand" feature in this dockable.

beforeAutoExpanding

public void beforeAutoExpanding()
Called before this dockable is going to be displayed "auto-expanded."

Specified by:
beforeAutoExpanding in interface Dockable

afterAutoExpanding

public void afterAutoExpanding()
Called after this dockable is displayed "auto-expanded."

Specified by:
afterAutoExpanding in interface Dockable

afterRestoringFromAutoExpansion

public void afterRestoringFromAutoExpansion(int orientation,
                                            java.awt.Dimension autoExpandedWindowSize,
                                            boolean userResized)
Called after this dockable is restored from being displayed "auto-expanded."

Specified by:
afterRestoringFromAutoExpansion in interface Dockable
Parameters:
orientation - the orientation of this dockable
See Also:
IdeConstants.WEST, IdeConstants.EAST, IdeConstants.NORTH, IdeConstants.SOUTH

getAutoExpansionSize

public java.awt.Dimension getAutoExpansionSize(int orientation,
                                               javax.swing.JPanel dockedTitledPanel)

Specified by:
getAutoExpansionSize in interface Dockable
Parameters:
orientation - the orientation of this dockable
dockedTitledPanel - the titled panel holding the dockable to be shown "auto-expanded"
Returns:
the size of this dockable when shown in "auto-expansion" mode.
See Also:
IdeConstants.WEST, IdeConstants.EAST, IdeConstants.NORTH, IdeConstants.SOUTH

getAutoExpansionPreferredSize

public java.awt.Dimension getAutoExpansionPreferredSize(int orientation)

Specified by:
getAutoExpansionPreferredSize in interface Dockable
Parameters:
orientation - the orientation of this dockable
Returns:
the user's preferred size of this dockable when in "auto-expansion" mode.
See Also:
IdeConstants.WEST, IdeConstants.EAST, IdeConstants.NORTH, IdeConstants.SOUTH

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

E13403-05

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