oracle.jdeveloper.vcs.changelist
Class ChangeListWindow

java.lang.Object
  oracle.ide.view.View
      oracle.ide.view.ViewDecorator
          oracle.ide.docking.DockableView
              oracle.ide.docking.DockableWindow
                  oracle.jdeveloper.vcs.changelist.ChangeListWindow

All Implemented Interfaces:

ControllerProvider, Dockable, Helpable

public class ChangeListWindow
extends DockableWindow

A dockable view containing a ChangeList instance.

Nested Class Summary

static class

ChangeListWindow.ScopeFilter

Field Summary

static int	COPY_FILE_LIST_CMD_ID Command ID for the copy file list command.
static float	CTX_GROUP_CLIPBOARD Group for clipboard operations.
static float	CTX_GROUP_CONFLICTS float constant for the separator group in the context menu that should contain conflict-solving operations
static float	CTX_GROUP_DIFF float constant for the separator group in the context menu that should contain compare commands
static float	CTX_GROUP_GENERAL float constant for the separator group in the context menu that should contain operations that do not apply to the selection, but are general for the window.
static float	CTX_GROUP_OPERATIONS float constant for the separator group in the context menu that should contain operations (e.g.
static float	CTX_GROUP_SELECT_IN_NAV float constant for the "Select in Navigator" group.
static int	OPEN_CMD_ID Command ID for the open command.
static int	PREFERENCES_CMD_ID Command ID for the preference command.
static int	SET_COMMENTS_CMD_ID Command ID for the set comments command.
static int	SET_SCOPE_CMD_ID Command ID for the set scope command.
static int	TOGGLE_COMMENTS_CMD_ID Command ID for the toggle comments command.

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

protected	ChangeListWindow(ChangeList[] changeLists, java.lang.String windowID)
	ChangeListWindow(ChangeList changeList, java.lang.String windowID) Construct the change list window

Method Summary

protected void	addCommentsToolbarAction(Toolbar toolbar)
protected void	addContextMenuListeners(ContextMenu contextMenu) Add listeners to the context menu.
protected void	addRefreshToolbarAction(Toolbar toolbar)
protected void	addToolbarActions(Toolbar toolbar) Add actions to the toolbar.
protected void	addToolbarToPanel(javax.swing.JPanel panel, Toolbar toolbar)
protected boolean	authenticate()
protected ChangeList	createChangeList(java.lang.Object modeId)
protected ChangeList[]	createChangeLists() Deprecated.
protected Controller	createController() Create and return the controller
protected java.lang.String	createDisplayPersistenceKey(ChangeList changeList)
protected java.lang.String	createDisplayPersistenceKey(java.lang.Object modeId)
IdeAction	createLocalAction(int cmdId)
protected void	deinitialize() Called when the dockable is closed.
protected void	delayedInitialization()
void	dockableShown(DockableEvent event) Called when the dockable is made visible.
void	doSetScope()
protected java.lang.String	getBusyStatusMessage() Gets the message to display in a cell of the IDE's status bar while the change list is in the middle of an update.
protected java.lang.String	getBusyStatusMessage(ChangeList changeList) Gets the message to display in a cell of the IDE's status bar while the change list is in the middle of an update.
protected java.lang.String	getBusyStatusMessage(java.lang.Object modeId)
ChangeList	getChangeList() Get the ChangeList being displayed in this window.
protected ChangeList	getChangeList(java.lang.Object modeId)
Context	getContext(java.util.EventObject eo) Get an IDE context for the specified event object.
ChangeList	getContextChangeList() Gets the change list for the current context.
ContextMenu	getContextMenu() Get the changelist's context menu.
java.lang.String[]	getContextPreferencesPath()
Controller	getController() Get the controller.
java.awt.Component	getGUI() Get the user interface for the change list.
HelpInfo	getHelpInfo() Gets the help information for the view.
protected IdeAction	getLocalAction(int cmdId) Create a local action with the specified command ID, and remember it so that it can be disposed when this view is closed.
protected java.lang.Object	getModeId()
protected java.lang.String	getModePersistenceKey()
protected java.lang.Object	getModePersistenceObject(java.lang.String value)
protected java.lang.String	getModePersistenceValue(java.lang.Object modeId)
protected java.lang.String	getPersistenceKey(ChangeList changeList)
protected java.lang.String[]	getPreferencesPath()
protected java.lang.String	getScopePersistenceKey()
protected Element[]	getSelectionFromUI() This method retrieve's the selection in this View directly from the UI.
java.lang.String	getSystemId()
javax.swing.Icon	getTabIcon() Get the icon for the changelist tab
java.lang.String	getTabName() Get the name for the changelist tab.
protected java.lang.String	getTabToggleKey(ChangeList changeList)
java.lang.String	getTitleName() Get the title of the change list.
Toolbar	getToolbar() Get the changelist dockable's toolbar.
static Context	handleContext(Context context)
protected void	initialize()
boolean	isActive()
boolean	isChangeListVisible(ChangeList changeList)
protected void	layoutPanel(javax.swing.JPanel panel) Performs layout of panel components, including the change list.
protected void	postDeinitialization()
protected void	preferencesChanged()
void	prefsChanged()
void	refresh()
protected void	removeContextMenuListeners(ContextMenu contextMenu) Removes listeners from the context menu.
protected void	removeToolbarFromPanel(javax.swing.JPanel panel, Toolbar toolbar)
void	requestFocusInChangeList()
void	requestFocusInComments()
protected void	setCommentsVisible(boolean commentsVisible)
protected void	setEllipsisVisible(IdeAction localAction, boolean visible)
protected void	setModeId(java.lang.Object modeId)
void	setOptionsVisible(boolean optionsVisible)
void	setSystemId(java.lang.String vcsId)
void	stateChange(int newState) This method gets called when a panel is shown, hidden, or closed.
protected void	updateBusyTickerVisible()
protected void	updateEllipsisItems()
protected void	updateStatusMessage()
protected void	updateVisibleToolbarActions(Toolbar toolbar)

Methods inherited from class oracle.ide.docking.DockableWindow

addTitleChangeListener, close, dockableHidden, fireTitleChangeListener, getCachedDockable, getDefaultVisibility, getHostedComponent, getMenuTitle, getSite, getTabDropListener, 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, getDecorated, getViewWithoutDecoration, isDecorated, loadLayout, newId, saveLayout, setDecorated, setOwner, setToolbarVisible, updateVisibleActions

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

Methods inherited from interface oracle.ide.docking.Dockable

loadLayout, saveLayout

Field Detail

TOGGLE_COMMENTS_CMD_ID

public static final int TOGGLE_COMMENTS_CMD_ID

Command ID for the toggle comments command.

COPY_FILE_LIST_CMD_ID

public static final int COPY_FILE_LIST_CMD_ID

Command ID for the copy file list command.

OPEN_CMD_ID

public static final int OPEN_CMD_ID

Command ID for the open command.

PREFERENCES_CMD_ID

public static final int PREFERENCES_CMD_ID

Command ID for the preference command.

SET_SCOPE_CMD_ID

public static final int SET_SCOPE_CMD_ID

Command ID for the set scope command.

SET_COMMENTS_CMD_ID

public static final int SET_COMMENTS_CMD_ID

Command ID for the set comments command.

CTX_GROUP_CONFLICTS

public static final float CTX_GROUP_CONFLICTS

float constant for the separator group in the context menu that should contain conflict-solving operations

See Also:

Constant Field Values

CTX_GROUP_OPERATIONS

public static final float CTX_GROUP_OPERATIONS

float constant for the separator group in the context menu that should contain operations (e.g. check in)

See Also:

Constant Field Values

CTX_GROUP_CLIPBOARD

public static final float CTX_GROUP_CLIPBOARD

Group for clipboard operations. Only used by the context menu in the comments area.

See Also:

Constant Field Values

CTX_GROUP_DIFF

public static final float CTX_GROUP_DIFF

float constant for the separator group in the context menu that should contain compare commands

See Also:

Constant Field Values

CTX_GROUP_GENERAL

public static final float CTX_GROUP_GENERAL

float constant for the separator group in the context menu that should contain operations that do not apply to the selection, but are general for the window.

See Also:

Constant Field Values

CTX_GROUP_SELECT_IN_NAV

public static final float CTX_GROUP_SELECT_IN_NAV

float constant for the "Select in Navigator" group. By convention, this is always at the end of the context menu.

See Also:

Constant Field Values

Constructor Detail

ChangeListWindow

public ChangeListWindow(ChangeList changeList,
                        java.lang.String windowID)

Construct the change list window

Parameters:

changeList - the change list.

ChangeListWindow

protected ChangeListWindow(ChangeList[] changeLists,
                           java.lang.String windowID)

Method Detail

setSystemId

public final void setSystemId(java.lang.String vcsId)

getSystemId

public final java.lang.String getSystemId()

getContextPreferencesPath

public final java.lang.String[] getContextPreferencesPath()

getPreferencesPath

protected java.lang.String[] getPreferencesPath()

getTabToggleKey

protected java.lang.String getTabToggleKey(ChangeList changeList)

isChangeListVisible

public boolean isChangeListVisible(ChangeList changeList)

createChangeLists

@Deprecated
protected ChangeList[] createChangeLists()

Deprecated.

Returns:

createLocalAction

public IdeAction createLocalAction(int cmdId)

prefsChanged

public void prefsChanged()

updateEllipsisItems

protected void updateEllipsisItems()

preferencesChanged

protected void preferencesChanged()

getModePersistenceKey

protected java.lang.String getModePersistenceKey()

getScopePersistenceKey

protected java.lang.String getScopePersistenceKey()

createDisplayPersistenceKey

protected java.lang.String createDisplayPersistenceKey(ChangeList changeList)

createDisplayPersistenceKey

protected java.lang.String createDisplayPersistenceKey(java.lang.Object modeId)

getChangeList

protected ChangeList getChangeList(java.lang.Object modeId)

getModePersistenceValue

protected java.lang.String getModePersistenceValue(java.lang.Object modeId)

getModePersistenceObject

protected java.lang.Object getModePersistenceObject(java.lang.String value)

createChangeList

protected ChangeList createChangeList(java.lang.Object modeId)

getModeId

protected java.lang.Object getModeId()

setModeId

protected void setModeId(java.lang.Object modeId)

updateBusyTickerVisible

protected void updateBusyTickerVisible()

layoutPanel

protected void layoutPanel(javax.swing.JPanel panel)

Performs layout of panel components, including the change list.

createController

protected Controller createController()

Create and return the controller

Returns:

a Controller instance.

getChangeList

public ChangeList getChangeList()

Get the ChangeList being displayed in this window.

Returns:

a ChangeList instance.

getContextChangeList

public ChangeList getContextChangeList()

Gets the change list for the current context.

Returns:

the context change list.

setEllipsisVisible

protected void setEllipsisVisible(IdeAction localAction,
                                  boolean visible)

getLocalAction

protected IdeAction getLocalAction(int cmdId)

Create a local action with the specified command ID, and remember it so that it can be disposed when this view is closed. If a local action has already been created for the specified cmdId, the existing action is returned.

Parameters:

cmdId - the command id to get a local action for.

Returns:

an IdeAction.

getHelpInfo

public HelpInfo getHelpInfo()

Gets the help information for the view.

Specified by:

getHelpInfo in interface Helpable

Overrides:

getHelpInfo in class ViewDecorator

getTabIcon

public javax.swing.Icon getTabIcon()

Get the icon for the changelist tab

Specified by:

getTabIcon in interface Dockable

Overrides:

getTabIcon in class DockableWindow

Returns:

the icon

See Also:

View.getTabName()

getTabName

public java.lang.String getTabName()

Get the name for the changelist tab. This just returns the same as getTitleName().

Specified by:

getTabName in interface Dockable

Overrides:

getTabName in class View

Returns:

the name of the tab

See Also:

Dockable.getTabIcon()

getTitleName

public java.lang.String getTitleName()

Get the title of the change list.

Returns:

the title of the change list

See Also:

Dockable.getTabIcon()

getController

public final Controller getController()

Get the controller. Subclasses should override {#createController()} if they want to return a custom controller

Specified by:

getController in interface ControllerProvider

Overrides:

getController in class ViewDecorator

Returns:

a controller for this view

getGUI

public java.awt.Component getGUI()

Get the user interface for the change list. This method is present due to the contract of oracle.ide.addin.View. If you need to obtain the actual ChangeList instance, call {#getChangeList()} instead.

Overrides:

getGUI in class ViewDecorator

Returns:

the changelist component.

getContext

public final Context getContext(java.util.EventObject eo)

Get an IDE context for the specified event object. The returned context will indicate the elements which are selected in the change list.

This method must only be called from the AWT event dispatch thread.

Overrides:

getContext in class ViewDecorator

Parameters:

eo - an event object that triggered the request to get the context

Returns:

a context object.

handleContext

public static final Context handleContext(Context context)

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 ViewDecorator

Returns:

the selection from the UI.

isActive

public boolean isActive()

dockableShown

public final void dockableShown(DockableEvent event)

Called when the dockable is made visible. Installs listeners and starts tracking changes.

Overrides:

dockableShown in class DockableWindow

Parameters:

event - the event that caused the dockable to become visible.

authenticate

protected boolean authenticate()

refresh

public void refresh()

addToolbarToPanel

protected void addToolbarToPanel(javax.swing.JPanel panel,
                                 Toolbar toolbar)

removeToolbarFromPanel

protected void removeToolbarFromPanel(javax.swing.JPanel panel,
                                      Toolbar toolbar)

getPersistenceKey

protected java.lang.String getPersistenceKey(ChangeList changeList)

stateChange

public void stateChange(int newState)

Description copied from class: DockableWindow

This method gets called when a panel is shown, hidden, or closed. The value passed in indicates precisely what happened. This method is really only intended as a convenience method for implementations of DockableListener which need to communicate to their dockable a state change.

Overrides:

stateChange in class DockableWindow

Parameters:

newState - The new state indicating whether the panel was shown, hidden or closed.

initialize

protected void initialize()

deinitialize

protected void deinitialize()

Called when the dockable is closed. Stops tracking changes, disposes objects and stops listening to events.

delayedInitialization

protected void delayedInitialization()

postDeinitialization

protected void postDeinitialization()

getToolbar

public final Toolbar getToolbar()

Get the changelist dockable's toolbar. If you want to install new items into the toolbar, override the {#addToolbarActions(Toolbar)} method.

Overrides:

getToolbar in class ViewDecorator

Returns:

the toolbar instance in use by this view.

getContextMenu

public final ContextMenu getContextMenu()

Get the changelist's context menu. If you want to install new items into the context menu, add a listener to it and install your items when it is popping up. A good way to do this is by overriding the {#addContextMenuListeners( ContextMenu )} method and adding your listener in the implementation. This ensures that listeners are added at the latest possible moment.

Overrides:

getContextMenu in class ViewDecorator

Returns:

the context menu of this view.

addContextMenuListeners

protected void addContextMenuListeners(ContextMenu contextMenu)

Add listeners to the context menu. Subclasses can override this.

Parameters:

contextMenu - the context menu to listen to.

removeContextMenuListeners

protected void removeContextMenuListeners(ContextMenu contextMenu)

Removes listeners from the context menu. Subclasses should override this if additional listeners were added by overriding addContextMenuListeners.

Parameters:

contextMenu - the menu to remove listeners from.

addToolbarActions

protected void addToolbarActions(Toolbar toolbar)

Add actions to the toolbar.

Parameters:

toolbar - toolbar to add actions to.

updateVisibleToolbarActions

protected void updateVisibleToolbarActions(Toolbar toolbar)

addCommentsToolbarAction

protected void addCommentsToolbarAction(Toolbar toolbar)

addRefreshToolbarAction

protected void addRefreshToolbarAction(Toolbar toolbar)

setOptionsVisible

public final void setOptionsVisible(boolean optionsVisible)

setCommentsVisible

protected void setCommentsVisible(boolean commentsVisible)

requestFocusInChangeList

public void requestFocusInChangeList()

requestFocusInComments

public void requestFocusInComments()

getBusyStatusMessage

protected java.lang.String getBusyStatusMessage()

Gets the message to display in a cell of the IDE's status bar while the change list is in the middle of an update.

Returns:

a "busy" message to display while the change list is updating.

getBusyStatusMessage

protected java.lang.String getBusyStatusMessage(ChangeList changeList)

Gets the message to display in a cell of the IDE's status bar while the change list is in the middle of an update.

Parameters:

changeList - the change list to which the status mesasge is relevant.

Returns:

a "busy" message to display while the change list is updating.

getBusyStatusMessage

protected java.lang.String getBusyStatusMessage(java.lang.Object modeId)

updateStatusMessage

protected void updateStatusMessage()

doSetScope

public final void doSetScope()