oracle.jdeveloper.vcs.changelist
Class ChangeList

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.jdeveloper.vcs.changelist.ChangeList

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

AsynchronousChangeList, ChangeSetChangeList

public class ChangeList
extends javax.swing.JPanel

The ChangeList is a UI component showing a list of "changed" files under a version control system. The version control system can specify valid states to display in the ChangeList, fire events to indicate that the change list needs to be updated, and configure many other aspects of the appearance and behavior of the list. It is possible to create a ChangeList which is not associated with an event queue instance or a status cache. In order to do this, a subclass must call initializeModel() sometime before the model is needed, and override the createEventQueue() method to return null.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	BUSY_PROPERTY property string for changes to busy state (add a property change listener to be notified)
static java.lang.String	CHANGELIST_COUNT_PROPERTY
static java.lang.String	COMMENTS_VISIBLE_PROPERTY property string for changes to comment visibility (add a property change listener to be notified)

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ChangeList()
Construct the change list.

ChangeList(java.lang.Object modeId)
Construct the change list.

Method Summary

protected void	addContextMenuListeners(ContextMenu contextMenu)
void	addMouseListener(java.awt.event.MouseListener ml) Add a mouse listener to the change list.
protected void	addRefreshToolbarAction(ChangeListWindow window, Toolbar toolbar)
void	addSelectionListener(javax.swing.event.ChangeListener listener) Add a listener that will be notified when the selection changes.
protected void	addToolbarActions(ChangeListWindow window, Toolbar toolbar)
protected void	clearOptions()
protected void	configureContext(Context context)
protected ChangeListCategorizer	createCategorizer()
protected ChangeListWindow.ScopeFilter	createCategoryScopeFilter(java.lang.String category)
protected DisplayProperty[]	createDisplayProperties()
protected ChangeListEventQueue	createEventQueue()
protected MutableVersionOperationModel	createModel() Create the model used by the ChangeList
protected void	defaultOptionsOnInitialInsert()
protected java.lang.String	getBusyStatusMessage()
java.util.Map<VCSHashURL,java.lang.String>	getCategoryCache()
int	getCount() Get a count of the current number of items in the list.
Element[]	getElements() Get all elements in the change list.
ChangeListEventQueue	getEventQueue()
java.lang.Object[]	getFilterStatuses()
URLFilter	getItemURLFilter()
protected javax.swing.Icon	getModeIcon()
protected java.lang.Object	getModeId()
protected MutableVersionOperationModel	getModel() Get the version operation model in use by the changelist.
protected java.lang.String	getModeLabel()
protected java.lang.String	getModeLongLabel()
protected java.lang.Object	getModelValue(java.net.URL url, DisplayProperty displayProperty)
VCSOptionsCustomizer	getOptionsCustomizer() Get the options customizer.
VCSOverlayItemProducer	getOverlayItemProducer()
VCSStatusCache	getOverlayStatusCache()
protected java.lang.String[]	getPreferencesPath()
protected ProgressTrackedTask	getProgressTask()
URLFilter	getScopeFilter()
Element[]	getSelection() Get the selection.
VCSURLBasedCache	getStatusCache() Get the status cache
protected java.lang.String	getStatusMessage(int count) Deprecated.
protected java.lang.String	getTabToggleKey()
protected BaseVersionOperationPanel	getVersionOperationPanel()
protected java.lang.String	getWindowId()
protected void	initializeChangeList()
protected void	initializeEventQueue(ChangeListEventQueue eventQueue)
protected void	initializeModel()
protected void	initializeVersionOperationPanel(BaseVersionOperationPanel vop)
protected void	insertProperties(int firstItem, int lastItem) Called after items have been inserted into the change list.
protected void	installModel(MutableVersionOperationModel model)
boolean	isBusy() Get whether the change list is busy processing updates.
boolean	isEmpty() Returns true if there are no items in the change list.
boolean	isExcludeDirectories()
boolean	isFocusInOptions()
boolean	isItemAtPosition(java.awt.Point p)
boolean	isOptionsVisible() Get whether the options component is visible.
protected boolean	isProgressTracked()
protected boolean	isStarted() Get whether the change list has started tracking.
protected void	layoutPanel(BaseVersionOperationPanel vop)
void	refilter(VCSStatus[] filterStatuses) Deprecated. replaced by refilter(oracle.jdeveloper.vcs.spi.VCSStatus[])
void	refresh() Completely refresh all files displayed in the change list.
protected void	removeContextMenuListeners(ContextMenu contextMenu)
void	removeMouseListener(java.awt.event.MouseListener ml) Remove a previously added mouse listener from the change list.
void	removeSelectionListener(javax.swing.event.ChangeListener listener) Remove a selection listener
void	selectAll() Select All items.
protected void	setBorderLook(int vopLookConstant)
void	setBusy(boolean isBusy) Set whether the change list is busy processing updates.
protected void	setCategoryCache(java.util.Map<VCSHashURL,java.lang.String> categoryCache)
protected void	setCategoryCacheImpl(java.util.Map<VCSHashURL,java.lang.String> categoryCache)
void	setExcludeDirectories(boolean excludeDirectories)
void	setFilterStatuses(VCSStatus[] filterStatuses)
void	setItemURLFilter(URLFilter urlFilter)
void	setOptionsCustomizer(VCSOptionsCustomizer c) Set a customizer that can be used for entering options.
void	setOptionsVisible(boolean isVisible) Set whether the options component is visible.
void	setOverlayItemProducer(VCSOverlayItemProducer overlayItemProducer)
void	setOverlayStatusCache(VCSStatusCache statusCache)
protected void	setProgressTask(ProgressTrackedTask progressTask)
void	setScopeFilter(URLFilter scopeFilter)
void	setStatusCache(ChangeListStatusCache statusCache) Set the status cache to use.
void	setStatusCache(VCSStatusCache statusCache) Set the status cache to use.
protected void	setStatusCache(VCSURLBasedCache statusCache)
void	setVisibleStatuses(ChangeListStatus[] statuses) Set the statuses that will be displayed in this change list.
void	setVisibleStatuses(VCSStatus[] statuses) Set the statuses that will be displayed in this change list.
void	start() Start tracking changes.
protected void	startImpl() Implementation for the start() method.
void	stop() Stop tracking changes and free up resources.
protected void	stopImpl() Implementation for the stop() method.
protected void	updateCategoryCache()
protected void	updateProperties(int firstItem, int lastItem) Called after items have been updated in the change list.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CHANGELIST_COUNT_PROPERTY

public static final java.lang.String CHANGELIST_COUNT_PROPERTY

See Also:

Constant Field Values

COMMENTS_VISIBLE_PROPERTY

public static final java.lang.String COMMENTS_VISIBLE_PROPERTY

property string for changes to comment visibility (add a property change listener to be notified)

See Also:

Constant Field Values

BUSY_PROPERTY

public static final java.lang.String BUSY_PROPERTY

property string for changes to busy state (add a property change listener to be notified)

See Also:

Constant Field Values

Constructor Detail

ChangeList

public ChangeList()

Construct the change list.

ChangeList

public ChangeList(java.lang.Object modeId)

Construct the change list.

Method Detail

initializeVersionOperationPanel

protected final void initializeVersionOperationPanel(BaseVersionOperationPanel vop)

layoutPanel

protected void layoutPanel(BaseVersionOperationPanel vop)

setExcludeDirectories

public void setExcludeDirectories(boolean excludeDirectories)

isExcludeDirectories

public boolean isExcludeDirectories()

getModeId

protected java.lang.Object getModeId()

getModeIcon

protected javax.swing.Icon getModeIcon()

getModeLabel

protected java.lang.String getModeLabel()

getModeLongLabel

protected java.lang.String getModeLongLabel()

getWindowId

protected final java.lang.String getWindowId()

initializeChangeList

protected void initializeChangeList()

addToolbarActions

protected void addToolbarActions(ChangeListWindow window,
                                 Toolbar toolbar)

createDisplayProperties

protected DisplayProperty[] createDisplayProperties()

getModelValue

protected java.lang.Object getModelValue(java.net.URL url,
                                         DisplayProperty displayProperty)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getStatusMessage

protected java.lang.String getStatusMessage(int count)

Deprecated.

Parameters:

count -

Returns:

getBusyStatusMessage

protected java.lang.String getBusyStatusMessage()

addContextMenuListeners

protected void addContextMenuListeners(ContextMenu contextMenu)

removeContextMenuListeners

protected void removeContextMenuListeners(ContextMenu contextMenu)

setProgressTask

protected void setProgressTask(ProgressTrackedTask progressTask)

getProgressTask

protected ProgressTrackedTask getProgressTask()

isProgressTracked

protected boolean isProgressTracked()

setItemURLFilter

public void setItemURLFilter(URLFilter urlFilter)

getItemURLFilter

public URLFilter getItemURLFilter()

setOverlayStatusCache

public void setOverlayStatusCache(VCSStatusCache statusCache)

setOverlayItemProducer

public void setOverlayItemProducer(VCSOverlayItemProducer overlayItemProducer)

getOverlayStatusCache

public VCSStatusCache getOverlayStatusCache()

getOverlayItemProducer

public VCSOverlayItemProducer getOverlayItemProducer()

getEventQueue

public ChangeListEventQueue getEventQueue()

isFocusInOptions

public boolean isFocusInOptions()

isItemAtPosition

public boolean isItemAtPosition(java.awt.Point p)

addMouseListener

public void addMouseListener(java.awt.event.MouseListener ml)

Add a mouse listener to the change list.

Overrides:

addMouseListener in class java.awt.Component

Parameters:

ml - the mouse listener

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener ml)

Remove a previously added mouse listener from the change list.

Overrides:

removeMouseListener in class java.awt.Component

Parameters:

ml - the mouse listener.

getSelection

public Element[] getSelection()

Get the selection.

Returns:

an array of selected items.

configureContext

protected void configureContext(Context context)

getElements

public final Element[] getElements()

Get all elements in the change list.

Returns:

an array of elements.

isEmpty

public final boolean isEmpty()

Returns true if there are no items in the change list.

Returns:

true if there are no items

getCount

public final int getCount()

Get a count of the current number of items in the list.

Returns:

the number of items in the list.

addSelectionListener

public void addSelectionListener(javax.swing.event.ChangeListener listener)

Add a listener that will be notified when the selection changes.

Parameters:

listener - a listener

removeSelectionListener

public void removeSelectionListener(javax.swing.event.ChangeListener listener)

Remove a selection listener

Parameters:

listener - listener to remove

selectAll

public void selectAll()

Select All items.

setBorderLook

protected void setBorderLook(int vopLookConstant)

setOptionsCustomizer

public void setOptionsCustomizer(VCSOptionsCustomizer c)

Set a customizer that can be used for entering options. The component is displayed above the main list of files. Any existing component will be removed.

Parameters:

c - an options customizer

getOptionsCustomizer

public final VCSOptionsCustomizer getOptionsCustomizer()

Get the options customizer.

Returns:

the options customizer.

setOptionsVisible

public void setOptionsVisible(boolean isVisible)

Set whether the options component is visible.

Parameters:

isVisible - if true, the options component will be displayed, if false it will be hidden.

isOptionsVisible

public boolean isOptionsVisible()

Get whether the options component is visible.

Returns:

true if the options component is currently visible, false otherwise

setStatusCache

public final void setStatusCache(VCSStatusCache statusCache)

Set the status cache to use.

Parameters:

statusCache - the status cache to use.

setStatusCache

public final void setStatusCache(ChangeListStatusCache statusCache)

Set the status cache to use.

Parameters:

statusCache - the status cache to use.

setStatusCache

protected final void setStatusCache(VCSURLBasedCache statusCache)

initializeModel

protected final void initializeModel()

installModel

protected void installModel(MutableVersionOperationModel model)

createCategorizer

protected ChangeListCategorizer createCategorizer()

getStatusCache

public VCSURLBasedCache getStatusCache()

Get the status cache

Returns:

the status cache. May be null prior to calling setStatusCache().

setVisibleStatuses

public final void setVisibleStatuses(VCSStatus[] statuses)

Set the statuses that will be displayed in this change list. If the change list is currently tracking, it will be updated immediately after calling this method.

Parameters:

statuses - the statuses which will be visible in this change list.

setVisibleStatuses

public final void setVisibleStatuses(ChangeListStatus[] statuses)

Set the statuses that will be displayed in this change list. If the change list is currently tracking, it will be updated immediately after calling this method.

Parameters:

statuses - the statuses which will be visible in this change list.

refilter

public void refilter(VCSStatus[] filterStatuses)

Deprecated. replaced by refilter(oracle.jdeveloper.vcs.spi.VCSStatus[])

setFilterStatuses

public void setFilterStatuses(VCSStatus[] filterStatuses)

updateCategoryCache

protected final void updateCategoryCache()

getFilterStatuses

public java.lang.Object[] getFilterStatuses()

setScopeFilter

public void setScopeFilter(URLFilter scopeFilter)

getScopeFilter

public URLFilter getScopeFilter()

isBusy

public final boolean isBusy()

Get whether the change list is busy processing updates. You can attach a PropertyChangeListener to this panel and listen for changes to this property.

Returns:

true if the change list is updating.

setBusy

public final void setBusy(boolean isBusy)

Set whether the change list is busy processing updates. This is normally called by the ChangeListEventQueue to indicate that it's processing events. Fires a PropertyChangeEvent when the busy state changes.

Parameters:

isBusy - if true, the change list is processing updates.

isStarted

protected boolean isStarted()

Get whether the change list has started tracking.

Returns:

true if tracking has started.

stop

public final void stop()

Stop tracking changes and free up resources. The list will be cleared and will no longer update.

stopImpl

protected void stopImpl()

Implementation for the stop() method.

start

public final void start()

Start tracking changes. The list will initially populate based on files in any open projects, and will start tracking events in the IDE and on the status cache.

startImpl

protected void startImpl()

Implementation for the start() method.

refresh

public void refresh()

Completely refresh all files displayed in the change list. All existing items will be removed, and the list will repopulate itself based on files in any open projects. This method is asynchronous - the refresh will happen at some point after calling this method.

createEventQueue

protected ChangeListEventQueue createEventQueue()

initializeEventQueue

protected void initializeEventQueue(ChangeListEventQueue eventQueue)

getModel

protected MutableVersionOperationModel getModel()

Get the version operation model in use by the changelist.

Returns:

the model. This may be null prior to calling setStatusCache().

createModel

protected MutableVersionOperationModel createModel()

Create the model used by the ChangeList

Returns:

the version operation model.

insertProperties

protected void insertProperties(int firstItem,
                                int lastItem)

Called after items have been inserted into the change list. Sets any properties in the model for the inserted items. Subclasses may override this to update additional properties. It's advisable to call super.insertProperties() to ensure any default properties are populated.

Parameters:

firstItem - the first item that was inserted

lastItem - the last item that was inserted

updateProperties

protected void updateProperties(int firstItem,
                                int lastItem)

Called after items have been updated in the change list. Sets any properties in the model for updated items. Subclasses may override this to update additional properties. It's advisable to call super.insertProperties() to ensure any default properties are populated.

Parameters:

firstItem - the first item that was updated

lastItem - the last item that was updated

defaultOptionsOnInitialInsert

protected void defaultOptionsOnInitialInsert()

clearOptions

protected void clearOptions()

getTabToggleKey

protected java.lang.String getTabToggleKey()

getCategoryCache

public final java.util.Map<VCSHashURL,java.lang.String> getCategoryCache()

setCategoryCache

protected final void setCategoryCache(java.util.Map<VCSHashURL,java.lang.String> categoryCache)

setCategoryCacheImpl

protected void setCategoryCacheImpl(java.util.Map<VCSHashURL,java.lang.String> categoryCache)

createCategoryScopeFilter

protected ChangeListWindow.ScopeFilter createCategoryScopeFilter(java.lang.String category)

getPreferencesPath

protected java.lang.String[] getPreferencesPath()

addRefreshToolbarAction

protected void addRefreshToolbarAction(ChangeListWindow window,
                                       Toolbar toolbar)

getVersionOperationPanel

protected final BaseVersionOperationPanel getVersionOperationPanel()