oracle.ide.docking

Class DrawerWindow

java.lang.Object

oracle.ide.view.View

oracle.ide.view.ViewDecorator

oracle.ide.docking.DockableView

oracle.ide.docking.DockableWindow

oracle.ide.docking.DrawerWindow

All Implemented Interfaces:

ControllerProvider, Dockable, Helpable

public class DrawerWindow
extends DockableWindow

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSE_ACTION_ID
static int	DROP_DOWN_ACTION_ID
static int	FLOAT_ACTION_ID
static int	MAXIMIZE_ACTION_ID
static int	MINIMIZE_ACTION_ID
static int	MOVE_ACTION_ID
static int	RESTORE_ACTION_ID
static int	SIZE_ACTION_ID

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.docking.Dockable

DEFAULT_VISIBILITY_MINIMIZED, DEFAULT_VISIBILITY_RAISED, DEFAULT_VISIBILITY_VISIBLE, TYPE_DISCARDABLE, TYPE_FORGETTABLE, TYPE_GLOBAL_VISIBLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE

Constructor Summary

Constructors

Constructor and Description
DrawerWindow(java.lang.String viewId, View decorated, Controller controller, DrawerWindowConfig config)
DrawerWindow(java.lang.String viewId, View decorated, DrawerWindowConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accessibleDrawer()
void	activate(View view, boolean whetherToActivate) Activates/Deactivates given View (Drawer)
void	addCloseableDrawer(DockableWindow view, int index)
void	addDelegateControllers(Controller... delegates) Adds the given controllers as "delegate controllers." The controller of this instance will handle an event or an update only if the "delegate controllers" were not able to do so.
void	addDrawer(DockableWindow view)
void	addDrawer(DockableWindow view, float weight)
void	addDrawer(DockableWindow view, int index)
void	addDrawer(View view, DrawerConfig config)
void	addDrawerListener(DrawerListener listener)
void	addDrawerThatCanHideHandle(DockableWindow view)
void	clientVisible(java.lang.Object view, boolean visible, int flags)
void	closeAllExpandedDrawers()
java.util.List<java.lang.Integer>	drawerDockableStatuses(java.lang.Object view)
java.util.List<View>	drawerViews()
void	expand(View view)
void	expand(View view, double ratio)
boolean	expanded(View view)
void	expandFirstDrawer()
void	expandOneDrawerAtATime()
Controller	getController() Get the Controller associated with this view.
java.awt.Component	getGUI()
HelpInfo	getHelpInfo()
java.awt.Component	getMinimizerTray()
javax.swing.Icon	getTabIcon() Gets the icon to display in a tab along side the name.
java.lang.String	getTabName() Gets the name to display in a tab.
java.lang.String	getTitleName() Gets title to display in a title bar.
Toolbar	getToolbar() Get the toolbar associated with this view.
void	hide(View view)
void	hideHandleIfOnlyOneDrawerShown()
void	loadLayout(PropertyAccess p) reloads the layout information of this dockable.
void	minimize(View view)
void	removeDrawerListener(DrawerListener listener)
void	removeIfPresent(View view)
void	restore(View view)
void	saveLayout(PropertyAccess p) Saves the layout information of this dockable.
void	show(View view)
boolean	showing(View view)
void	togglePanelsWithAnimation(java.util.List<View> toExpand, java.util.List<View> toCollapse)
void	togglePanelsWithoutAnimation(java.util.List<View> toExpand, java.util.List<View> toCollapse)
void	togglePanelsWithoutAnimation(View toExpand, View toCollapse)
void	topComponent(javax.swing.JComponent topComponent)
View	undecorateIfNecessary(DockableWindow dockable)
void	updateDrawerHandlesVisibility()
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.docking.DockableWindow

addTitleChangeListener, close, dockableHidden, dockableShown, fireTitleChangeListener, getCachedDockable, getDefaultVisibility, getHeaderComponents, getHostedComponent, getMenuTitle, getSite, getTabDropListener, getType, getUniqueName, isDrawer, isVisible, removeTitleChangeListener, setDockableVisible, setSite, setType, show, stateChange, 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, getDecorated, getSelectionFromUI, getViewWithoutDecoration, isDecorated, newId, setDecorated, setOwner, setToolbarVisible

Methods inherited from class oracle.ide.view.View

addViewListener, addViewSelectionListener, addViewStateListener, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getId, getSelection, 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

Field Detail

DROP_DOWN_ACTION_ID

public static final int DROP_DOWN_ACTION_ID

RESTORE_ACTION_ID

public static final int RESTORE_ACTION_ID

MOVE_ACTION_ID

public static final int MOVE_ACTION_ID

SIZE_ACTION_ID

public static final int SIZE_ACTION_ID

FLOAT_ACTION_ID

public static final int FLOAT_ACTION_ID

MINIMIZE_ACTION_ID

public static final int MINIMIZE_ACTION_ID

MAXIMIZE_ACTION_ID

public static final int MAXIMIZE_ACTION_ID

CLOSE_ACTION_ID

public static final int CLOSE_ACTION_ID

Constructor Detail

DrawerWindow

public DrawerWindow(java.lang.String viewId,
            View decorated,
            DrawerWindowConfig config)

DrawerWindow

public DrawerWindow(java.lang.String viewId,
            View decorated,
            Controller controller,
            DrawerWindowConfig config)

Method Detail

addDrawerListener

public final void addDrawerListener(DrawerListener listener)

removeDrawerListener

public final void removeDrawerListener(DrawerListener listener)

expandOneDrawerAtATime

public void expandOneDrawerAtATime()

hideHandleIfOnlyOneDrawerShown

public void hideHandleIfOnlyOneDrawerShown()

topComponent

public void topComponent(javax.swing.JComponent topComponent)

getToolbar

public Toolbar getToolbar()

Description copied from class: View

Get the toolbar associated with this view.

Overrides:

getToolbar in class ViewDecorator

getHelpInfo

public HelpInfo getHelpInfo()

Specified by:

getHelpInfo in interface Helpable

Overrides:

getHelpInfo in class ViewDecorator

addDrawer

public void addDrawer(View view,
             DrawerConfig config)

addDrawer

public void addDrawer(DockableWindow view)

addDrawer

public void addDrawer(DockableWindow view,
             float weight)

addDrawerThatCanHideHandle

public void addDrawerThatCanHideHandle(DockableWindow view)

addCloseableDrawer

public void addCloseableDrawer(DockableWindow view,
                      int index)

addDrawer

public void addDrawer(DockableWindow view,
             int index)

updateDrawerHandlesVisibility

public void updateDrawerHandlesVisibility()

addDelegateControllers

public void addDelegateControllers(Controller... delegates)

Adds the given controllers as "delegate controllers." The controller of this instance will handle an event or an update only if the "delegate controllers" were not able to do so.

Parameters:

delegates - the "delegate controllers" to add.

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 ViewDecorator

Returns:

the Controller associated with this view.

getGUI

public java.awt.Component getGUI()

Overrides:

getGUI in class ViewDecorator

Returns:

the root graphical user interface component.

getTabName

public java.lang.String getTabName()

Description copied from interface: Dockable

Gets the name to display in a tab.

Specified by:

getTabName in interface Dockable

Overrides:

getTabName in class View

Returns:

the name to display in a tab.

See Also:

Dockable.getTabIcon()

getTabIcon

public javax.swing.Icon getTabIcon()

Description copied from class: DockableWindow

Gets the icon to display in a tab along side the name.

Specified by:

getTabIcon in interface Dockable

Overrides:

getTabIcon in class DockableWindow

Returns:

the the icon to display in a tab.

See Also:

View.getTabName()

getTitleName

public java.lang.String getTitleName()

Description copied from interface: Dockable

Gets title to display in a title bar.

Returns:

the title to display in a title bar.

See Also:

Dockable.getTabIcon()

minimize

public void minimize(View view)

expandFirstDrawer

public void expandFirstDrawer()

expand

public void expand(View view)

expand

public void expand(View view,
          double ratio)

expanded

public boolean expanded(View view)

activate

public void activate(View view,
            boolean whetherToActivate)

Activates/Deactivates given View (Drawer)

Parameters:

view -

whetherToActivate - Boolean.False deactivates View (Drawer), Boolean.TRUE activates View (Drawer)

removeIfPresent

public void removeIfPresent(View view)

restore

public void restore(View view)

getMinimizerTray

public java.awt.Component getMinimizerTray()

showing

public boolean showing(View view)

show

public void show(View view)

hide

public void hide(View view)

undecorateIfNecessary

public View undecorateIfNecessary(DockableWindow dockable)

togglePanelsWithAnimation

public void togglePanelsWithAnimation(java.util.List<View> toExpand,
                             java.util.List<View> toCollapse)

togglePanelsWithoutAnimation

public void togglePanelsWithoutAnimation(View toExpand,
                                View toCollapse)

togglePanelsWithoutAnimation

public void togglePanelsWithoutAnimation(java.util.List<View> toExpand,
                                java.util.List<View> toCollapse)

accessibleDrawer

public boolean accessibleDrawer()

drawerDockableStatuses

public java.util.List<java.lang.Integer> drawerDockableStatuses(java.lang.Object view)

clientVisible

public void clientVisible(java.lang.Object view,
                 boolean visible,
                 int flags)

saveLayout

public void saveLayout(PropertyAccess p)

Description copied from interface: Dockable

Saves the layout information of this dockable.

Specified by:

saveLayout in interface Dockable

Overrides:

saveLayout in class ViewDecorator

Parameters:

p - the storage object

loadLayout

public void loadLayout(PropertyAccess p)

Description copied from interface: Dockable

reloads the layout information of this dockable.

Specified by:

loadLayout in interface Dockable

Overrides:

loadLayout in class ViewDecorator

Parameters:

p - the storage object

drawerViews

public java.util.List<View> drawerViews()

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 ViewDecorator

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.

closeAllExpandedDrawers

public void closeAllExpandedDrawers()