Class AbstractEditPartViewer
- java.lang.Object
-
- org.eclipse.gef.ui.parts.AbstractEditPartViewer
-
- All Implemented Interfaces:
EditPartViewer,ISelectionProvider
- Direct Known Subclasses:
GraphicalViewerImpl,TreeViewer
public abstract class AbstractEditPartViewer extends java.lang.Object implements EditPartViewer
The base implementation for EditPartViewer.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.eclipse.gef.EditPartViewer
EditPartViewer.Conditional
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.ListconstantSelectionThe unmodifiable list of selected editparts.protected EditPartfocusPartDeprecated.protected java.util.ListselectionThe raw list of selected editparts.protected java.util.ListselectionListenersDeprecated.
-
Constructor Summary
Constructors Constructor Description AbstractEditPartViewer()Constructs the viewer and callsinit().
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddDragSourceListener(TransferDragSourceListener listener)Provided for compatibility with existing code.voidaddDragSourceListener(TransferDragSourceListener listener)Adds aTransferDragSourceListenerto this viewer.voidaddDropTargetListener(TransferDropTargetListener listener)Provided for compatibility with existing code.voidaddDropTargetListener(TransferDropTargetListener listener)Adds aTransferDropTargetListenerto this viewer.voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)Adds a listener to be notified of viewer property changes.voidaddSelectionChangedListener(ISelectionChangedListener listener)voidappendSelection(EditPart editpart)Appends the specifiedEditPartto the viewer's selection.abstract ControlcreateControl(Composite parent)Optionally creates the defaultControlusing the default style.voiddeselect(EditPart editpart)Removes the specifiedEditPartfrom the current selection.voiddeselectAll()Deselects all EditParts.EditPartfindObjectAt(org.eclipse.draw2d.geometry.Point pt)Returnsnullor theEditPartassociated with the specified location.EditPartfindObjectAtExcluding(org.eclipse.draw2d.geometry.Point pt, java.util.Collection exclude)Returnsnullor theEditPartat the specified location, excluding the specified set.protected voidfireSelectionChanged()Fires selection changed to the registered listeners at the time called.voidflush()Flushes all pending updates to the Viewer.EditPartgetContents()Returns the contents of this Viewer.MenuManagergetContextMenu()Returnsnullor the MenuManager for this viewer.ControlgetControl()Returnsnullor the SWTControlfor this viewer.protected DelegatingDragAdaptergetDelegatingDragAdapter()Returnsnullor the DelegatingDragAdapater.protected DelegatingDropAdaptergetDelegatingDropAdapter()Returnsnullor the DelegatingDropAdapater.protected DragSourcegetDragSource()Returnsnullor the DragSource.protected DropTargetgetDropTarget()Returnsnullor the DropTarget.EditDomaingetEditDomain()Returns theEditDomainto which this viewer belongs.EditPartFactorygetEditPartFactory()Returns theEditPartFactoryfor this viewer.java.util.MapgetEditPartRegistry()Returns theMapfor registeringEditPartsby Keys.EditPartgetFocusEditPart()Returns the focusEditPart.KeyHandlergetKeyHandler()Returns theKeyHandlerfor this viewer.java.lang.ObjectgetProperty(java.lang.String key)Returns the value of the given property.ResourceManagergetResourceManager()Returnsnull, or the ResourceManager for this Viewer.RootEditPartgetRootEditPart()Returns theRootEditPart.java.util.ListgetSelectedEditParts()Returns an unmodifiableListcontaining zero or more selected editparts.ISelectiongetSelection()Returns an ISelection containing a list of one or more EditPart.SelectionManagergetSelectionManager()Returns the viewer's selection manager.java.util.MapgetVisualPartMap()Returns theMapfor associating visual parts with theirEditParts.protected voidhandleDispose(DisposeEvent e)Called if and when theControlis disposed.protected voidhookControl()Called once the control has been set.protected voidhookDragSource()Called whenever thedrag sourceis automatically created.protected voidhookDropTarget()Called whenever thedrop targetis automatically created.protected voidinit()Called from the constructor.protected java.util.ListprimGetSelectedEditParts()Returns the modifiable List of selected EditParts.protected voidrefreshDragSourceAdapter()Creates or disposes a DragSource as needed, and sets the supported transfer types.protected voidrefreshDropTargetAdapter()Creates or disposes a DropTarget as needed, and sets the supported transfer types.voidregisterAccessibleEditPart(AccessibleEditPart acc)Used for accessibility purposes.voidremoveDragSourceListener(TransferDragSourceListener listener)Deprecated.voidremoveDragSourceListener(TransferDragSourceListener listener)Removes the specified drag source listener.voidremoveDropTargetListener(TransferDropTargetListener listener)Deprecated.voidremoveDropTargetListener(TransferDropTargetListener listener)Removes the specified drop target listener.voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)removes the first instance of the specified property listener.voidremoveSelectionChangedListener(ISelectionChangedListener l)voidreveal(EditPart part)Reveals the given EditPart if it is not visible.voidselect(EditPart editpart)Replaces the current selection with the specifiedEditPart.voidsetContents(java.lang.Object contents)Creates anEditPartfor the provided model object using theEditPartFactory.voidsetContents(EditPart editpart)Sets the contents for this Viewer.voidsetContextMenu(MenuManager manager)Sets the contextMenuManagerfor this viewer.voidsetControl(Control control)Sets theControlfor this viewer.voidsetCursor(Cursor cursor)Sets the cursor for the viewer'sControl.protected voidsetDragSource(DragSource source)Sets the drag source.protected voidsetDropTarget(DropTarget target)Sets the drop target.voidsetEditDomain(EditDomain editdomain)Sets theEditDomainfor this viewer.voidsetEditPartFactory(EditPartFactory factory)Sets the EditPartFactory.voidsetFocus(EditPart part)Sets the focus EditPart.voidsetKeyHandler(KeyHandler handler)Sets theKeyHandler.voidsetProperty(java.lang.String key, java.lang.Object value)Sets a property on this viewer.voidsetRootEditPart(RootEditPart editpart)Sets the root of this viewer.voidsetRouteEventsToEditDomain(boolean value)Turns on/off the routing of events directly to the Editor.voidsetSelection(ISelection newSelection)Sets the selection to the given selection and fires selection changed.voidsetSelectionManager(SelectionManager model)Sets the selection manager for this viewer.protected voidunhookControl()Called when the control is being set tonull, but before it is null.voidunregisterAccessibleEditPart(AccessibleEditPart acc)Does nothing by default.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.gef.EditPartViewer
findObjectAtExcluding
-
-
-
-
Field Detail
-
selection
protected final java.util.List selection
The raw list of selected editparts.
-
constantSelection
protected final java.util.List constantSelection
The unmodifiable list of selected editparts.
-
selectionListeners
protected java.util.List selectionListeners
Deprecated.The list of selection listeners.
-
focusPart
protected EditPart focusPart
Deprecated.The editpart specifically set to have focus. Note that if this value isnull, the focus editpart is still implied to be the part with primary selection. Subclasses should call the accessor:getFocusEditPart()whenever possible.
-
-
Constructor Detail
-
AbstractEditPartViewer
public AbstractEditPartViewer()
Constructs the viewer and callsinit().
-
-
Method Detail
-
setSelectionManager
public void setSelectionManager(SelectionManager model)
Description copied from interface:EditPartViewerSets the selection manager for this viewer.- Specified by:
setSelectionManagerin interfaceEditPartViewer- Parameters:
model- the new selection manager- See Also:
EditPartViewer.setSelectionManager(SelectionManager)
-
addDragSourceListener
public void addDragSourceListener(TransferDragSourceListener listener)
Description copied from interface:EditPartViewerProvided for compatibility with existing code.- Specified by:
addDragSourceListenerin interfaceEditPartViewer- Parameters:
listener- a drag source listener- See Also:
EditPartViewer.addDragSourceListener(org.eclipse.gef.dnd.TransferDragSourceListener)
-
addDragSourceListener
public void addDragSourceListener(TransferDragSourceListener listener)
Description copied from interface:EditPartViewerAdds aTransferDragSourceListenerto this viewer. This has the side-effect of creating aDragSourceon the viewer's Control. A Control can only have a single DragSource. Clients must not create their own DragSource when using this method.- Specified by:
addDragSourceListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.addDragSourceListener(TransferDragSourceListener)
-
addDropTargetListener
public void addDropTargetListener(TransferDropTargetListener listener)
Description copied from interface:EditPartViewerProvided for compatibility with existing code.- Specified by:
addDropTargetListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.addDropTargetListener(org.eclipse.gef.dnd.TransferDropTargetListener)
-
addDropTargetListener
public void addDropTargetListener(TransferDropTargetListener listener)
Description copied from interface:EditPartViewerAdds aTransferDropTargetListenerto this viewer. This has the side-effect of creating aDropTargeton the viewer's Control. A Control can only have a single DropTarget. Clients must not create their own DropTarget when using this method.- Specified by:
addDropTargetListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.addDropTargetListener(TransferDropTargetListener)
-
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface:EditPartViewerAdds a listener to be notified of viewer property changes.- Specified by:
addPropertyChangeListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.addPropertyChangeListener(PropertyChangeListener)
-
addSelectionChangedListener
public void addSelectionChangedListener(ISelectionChangedListener listener)
- Specified by:
addSelectionChangedListenerin interfaceISelectionProvider- See Also:
ISelectionProvider.addSelectionChangedListener(ISelectionChangedListener)
-
appendSelection
public void appendSelection(EditPart editpart)
Description copied from interface:EditPartViewerAppends the specifiedEditPartto the viewer's selection. The EditPart becomes the new primary selection. Fires selection changed to allISelectionChangedListeners.- Specified by:
appendSelectionin interfaceEditPartViewer- Parameters:
editpart- the EditPart to append- See Also:
EditPartViewer.appendSelection(EditPart)
-
createControl
public abstract Control createControl(Composite parent)
Description copied from interface:EditPartViewerOptionally creates the defaultControlusing the default style. The Control can also be created externally and then set into the Viewer.- Specified by:
createControlin interfaceEditPartViewer- Parameters:
parent- the parent in which create the SWTControl- Returns:
- the created Control for convenience
- See Also:
EditPartViewer.createControl(Composite)
-
deselect
public void deselect(EditPart editpart)
Description copied from interface:EditPartViewerRemoves the specifiedEditPartfrom the current selection. If the selection becomes empty, the viewer'scontentsbecomes the current selected part. The last EditPart in the new selection is madeprimary.Fires selection changed to
ISelectionChangedListeners.- Specified by:
deselectin interfaceEditPartViewer- Parameters:
editpart- theEditPartto deselect- See Also:
EditPartViewer.deselect(EditPart)
-
deselectAll
public void deselectAll()
Description copied from interface:EditPartViewerDeselects all EditParts. The viewer'scontentsbecomes the current selection. Fires selection changed toISelectionChangedListeners.- Specified by:
deselectAllin interfaceEditPartViewer- See Also:
EditPartViewer.deselectAll()
-
handleDispose
protected void handleDispose(DisposeEvent e)
Called if and when theControlis disposed. Subclasses may extend this method to perform additional cleanup.- Parameters:
e- the disposeevent
-
findObjectAt
public final EditPart findObjectAt(org.eclipse.draw2d.geometry.Point pt)
Description copied from interface:EditPartViewerReturnsnullor theEditPartassociated with the specified location. The location is relative to the client area of the Viewer'sControl. An EditPart is not directly visible. It is targeted using its visual part which it registered using thevisual part map. What constitutes a visual part is viewer-specific. Examples include Figures and TreeItems.- Specified by:
findObjectAtin interfaceEditPartViewer- Parameters:
pt- The location- Returns:
nullor an EditPart- See Also:
EditPartViewer.findObjectAt(Point)
-
findObjectAtExcluding
public final EditPart findObjectAtExcluding(org.eclipse.draw2d.geometry.Point pt, java.util.Collection exclude)
Description copied from interface:EditPartViewerReturnsnullor theEditPartat the specified location, excluding the specified set. This method behaves similarly toEditPartViewer.findObjectAt(Point).- Specified by:
findObjectAtExcludingin interfaceEditPartViewer- Parameters:
pt- The mouse locationexclude- The set of EditParts to be excluded- Returns:
nullor an EditPart- See Also:
EditPartViewer.findObjectAtExcluding(Point, Collection)
-
fireSelectionChanged
protected void fireSelectionChanged()
Fires selection changed to the registered listeners at the time called.
-
flush
public void flush()
Description copied from interface:EditPartViewerFlushes all pending updates to the Viewer.- Specified by:
flushin interfaceEditPartViewer- See Also:
EditPartViewer.flush()
-
getContextMenu
public MenuManager getContextMenu()
Description copied from interface:EditPartViewerReturnsnullor the MenuManager for this viewer. The menu manager is set usingEditPartViewer.setContextMenu(MenuManager).- Specified by:
getContextMenuin interfaceEditPartViewer- Returns:
nullor a MenuManager- See Also:
EditPartViewer.getContextMenu()
-
getContents
public EditPart getContents()
Description copied from interface:EditPartViewerReturns the contents of this Viewer. The contents is the EditPart associated with the top-level model object. It is considered to be "The Diagram". If the user has nothing selected, the contents is implicitly the selected object.The Root of the Viewer is different. By constrast, the root is never selected or targeted, and does not correspond to something in the model.
- Specified by:
getContentsin interfaceEditPartViewer- Returns:
- the contents
EditPart - See Also:
EditPartViewer.getContents()
-
getControl
public Control getControl()
Description copied from interface:EditPartViewerReturnsnullor the SWTControlfor this viewer. The control is either set explicitly or can be created by the viewer.- Specified by:
getControlin interfaceEditPartViewer- Returns:
- the SWT
Control - See Also:
EditPartViewer.getControl()
-
getDelegatingDragAdapter
protected DelegatingDragAdapter getDelegatingDragAdapter()
Returnsnullor the DelegatingDragAdapater. The adapter is created automatically whenaddDragSourceListener(TransferDragSourceListener)is called.- Returns:
nullor the adapter
-
getDelegatingDropAdapter
protected DelegatingDropAdapter getDelegatingDropAdapter()
Returnsnullor the DelegatingDropAdapater. The adapter is created automatically whenaddDropTargetListener(TransferDropTargetListener)is called.- Returns:
nullor the adapter
-
getDragSource
protected DragSource getDragSource()
Returnsnullor the DragSource. The drag source is created automatically whenaddDragSourceListener(TransferDragSourceListener)is called.- Returns:
nullor the drag source
-
getDropTarget
protected DropTarget getDropTarget()
Returnsnullor the DropTarget. The drop target is created automatically whenaddDropTargetListener(TransferDropTargetListener)is called.- Returns:
nullor the drop target
-
getEditDomain
public EditDomain getEditDomain()
Description copied from interface:EditPartViewerReturns theEditDomainto which this viewer belongs.- Specified by:
getEditDomainin interfaceEditPartViewer- Returns:
- the viewer's EditDomain
- See Also:
EditPartViewer.getEditDomain()
-
getEditPartFactory
public EditPartFactory getEditPartFactory()
Description copied from interface:EditPartViewerReturns theEditPartFactoryfor this viewer. The EditPartFactory is used to create the contents EditPart whenEditPartViewer.setContents(Object)is called. It is made available so that other EditParts can use it to create their children or connection editparts.- Specified by:
getEditPartFactoryin interfaceEditPartViewer- Returns:
- EditPartFactory
- See Also:
EditPartViewer.getEditPartFactory()
-
getEditPartRegistry
public java.util.Map getEditPartRegistry()
Description copied from interface:EditPartViewerReturns theMapfor registeringEditPartsby Keys. EditParts may register themselves using any method, and may register themselves with multiple keys. The purpose of such registration is to allow an EditPart to be found by other EditParts, or by listeners of domain notifiers. By default, EditParts are registered by their model.Some models use a "domain" notification system, in which all changes are dispatched to a single listener. Such a listener might use this map to lookup editparts for a given model, and then ask the editpart to update.
- Specified by:
getEditPartRegistryin interfaceEditPartViewer- Returns:
- the registry map
- See Also:
EditPartViewer.getEditPartRegistry()
-
getFocusEditPart
public EditPart getFocusEditPart()
Description copied from interface:EditPartViewerReturns the focusEditPart. Focus refers to keyboard focus. This is the same concept as focus in a native Tree or Table. The User can change focus using the keyboard without affecting the currently selected objects. Never returnsnull.- Specified by:
getFocusEditPartin interfaceEditPartViewer- Returns:
- the focus
EditPart - See Also:
EditPartViewer.getFocusEditPart()
-
getKeyHandler
public KeyHandler getKeyHandler()
Description copied from interface:EditPartViewerReturns theKeyHandlerfor this viewer. The KeyHandler is sent KeyEvents by the currently activeTool. This is important, because only the current tool knows if it is in a state in which keys should be ignored, such as during a drag. By default, only theSelectionToolforwards keysrokes. It does not do so during a drag.- Specified by:
getKeyHandlerin interfaceEditPartViewer- Returns:
nullor a KeyHandler- See Also:
EditPartViewer.getKeyHandler()
-
getProperty
public java.lang.Object getProperty(java.lang.String key)
Description copied from interface:EditPartViewerReturns the value of the given property. Returnsnullif the property has not been set, or has been set to null.- Specified by:
getPropertyin interfaceEditPartViewer- Parameters:
key- the property's key- Returns:
- the given properties value or
null. - See Also:
EditPartViewer.getProperty(String)
-
getResourceManager
public ResourceManager getResourceManager()
Description copied from interface:EditPartViewerReturnsnull, or the ResourceManager for this Viewer. Once a viewer has a Control, clients may access the viewer's resource manager. Any resources constructed using this manager, but not freed, will be freed when the viewer's control is disposed. This does not mean that clients should be lazy about deallocating resources. If a resource is no longer needed but the viewer is still in use, the client must deallocate the resource.Typical usage is by EditParts contained inside the viewer. EditParts which are removed from the viewer should free their resources during
EditPart.removeNotify(). When the viewer is disposed,removeNotify()is not called, but the viewer's resource manager will be disposed anyway.The viewer's default resource manager is linked to JFace's
global shared resources.- Specified by:
getResourceManagerin interfaceEditPartViewer- Returns:
- the ResourceManager associated with this viewer
- See Also:
EditPartViewer.getResourceManager()
-
getRootEditPart
public RootEditPart getRootEditPart()
Description copied from interface:EditPartViewerReturns theRootEditPart. The RootEditPart is a special EditPart that serves as the parent to the contents editpart. The root is never selected. The root does not correspond to anything in the model. The User does not interact with the root.The RootEditPart has a single child: the
contents.By defining the concept of "root", GEF allows the application's "real" EditParts to be more homogeneous. For example, all non-root EditParts have a parent. Also, it allows applications to change the type of root being used without affecting their own editpart implementation hierarchy.
- Specified by:
getRootEditPartin interfaceEditPartViewer- Returns:
- the RootEditPart
- See Also:
EditPartViewer.getRootEditPart()
-
getSelectedEditParts
public java.util.List getSelectedEditParts()
Description copied from interface:EditPartViewerReturns an unmodifiableListcontaining zero or more selected editparts. This list may be empty. In contrast, the inherited methodISelectionProvider.getSelection()should not return an empty selection. When no editparts are selected, generally the contents editpart is considered to be selected. This list can be modified indirectly by calling other methods on the viewer.- Specified by:
getSelectedEditPartsin interfaceEditPartViewer- Returns:
- a list containing zero or more editparts
- See Also:
EditPartViewer.getSelectedEditParts()
-
getSelection
public ISelection getSelection()
Returns an ISelection containing a list of one or more EditPart. WhenevergetSelectedEditParts()returns an empty list, the contents editpart (getContents()) is returned as the current selection.- Specified by:
getSelectionin interfaceEditPartViewer- Specified by:
getSelectionin interfaceISelectionProvider- See Also:
ISelectionProvider.getSelection()
-
getSelectionManager
public SelectionManager getSelectionManager()
Description copied from interface:EditPartViewerReturns the viewer's selection manager. The selection manager has complete control over the viewer's representation of selection. It provides theISelectionfor the viewer, and manages all changes to the current selection.- Specified by:
getSelectionManagerin interfaceEditPartViewer- Returns:
- the selection manager
- See Also:
EditPartViewer.getSelectionManager()
-
getVisualPartMap
public java.util.Map getVisualPartMap()
Description copied from interface:EditPartViewerReturns theMapfor associating visual parts with theirEditParts. This map is used for hit-testing. Hit testing is performed by first determining which visual part is hit, and then mapping that part to anEditPart. What consistutes a visual part is viewer-specific. Examples includeFiguresandTreeItems.- Specified by:
getVisualPartMapin interfaceEditPartViewer- Returns:
- the visual part map
- See Also:
EditPartViewer.getVisualPartMap()
-
hookControl
protected void hookControl()
Called once the control has been set.- See Also:
unhookControl()
-
hookDragSource
protected void hookDragSource()
Called whenever thedrag sourceis automatically created.
-
hookDropTarget
protected void hookDropTarget()
Called whenever thedrop targetis automatically created.
-
init
protected void init()
Called from the constructor. Subclasses may extend this method.
-
primGetSelectedEditParts
protected java.util.List primGetSelectedEditParts()
Returns the modifiable List of selected EditParts.- Returns:
- the internal list of selected editparts
-
refreshDragSourceAdapter
protected void refreshDragSourceAdapter()
Creates or disposes a DragSource as needed, and sets the supported transfer types. Clients should not need to call or override this method.
-
refreshDropTargetAdapter
protected void refreshDropTargetAdapter()
Creates or disposes a DropTarget as needed, and sets the supported transfer types. Clients should not need to call or override this method.
-
registerAccessibleEditPart
public void registerAccessibleEditPart(AccessibleEditPart acc)
Description copied from interface:EditPartViewerUsed for accessibility purposes.- Specified by:
registerAccessibleEditPartin interfaceEditPartViewer- Parameters:
acc- the AccessibleEditPart- See Also:
EditPartViewer.registerAccessibleEditPart(AccessibleEditPart)
-
removeDragSourceListener
public void removeDragSourceListener(TransferDragSourceListener listener)
Deprecated.Description copied from interface:EditPartViewerRemoves the specified drag source listener. If all listeners are removed, the DragSource that was created will be disposed.- Specified by:
removeDragSourceListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.removeDragSourceListener(org.eclipse.gef.dnd.TransferDragSourceListener)
-
removeDragSourceListener
public void removeDragSourceListener(TransferDragSourceListener listener)
Description copied from interface:EditPartViewerRemoves the specified drag source listener. If all listeners are removed, the DragSource that was created will be disposed.- Specified by:
removeDragSourceListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.removeDragSourceListener(TransferDragSourceListener)
-
removeDropTargetListener
public void removeDropTargetListener(TransferDropTargetListener listener)
Deprecated.Description copied from interface:EditPartViewerRemoves the specified drop target listener. If all listeners are removed, the DropTarget that was created will be disposed.- Specified by:
removeDropTargetListenerin interfaceEditPartViewer- See Also:
EditPartViewer.removeDropTargetListener(org.eclipse.gef.dnd.TransferDropTargetListener)
-
removeDropTargetListener
public void removeDropTargetListener(TransferDropTargetListener listener)
Description copied from interface:EditPartViewerRemoves the specified drop target listener. If all listeners are removed, the DropTarget that was created will be disposed.- Specified by:
removeDropTargetListenerin interfaceEditPartViewer- Parameters:
listener- the listener- See Also:
EditPartViewer.removeDropTargetListener(TransferDropTargetListener)
-
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface:EditPartViewerremoves the first instance of the specified property listener.- Specified by:
removePropertyChangeListenerin interfaceEditPartViewer- Parameters:
listener- the listener to remove- See Also:
EditPartViewer.removePropertyChangeListener(PropertyChangeListener)
-
removeSelectionChangedListener
public void removeSelectionChangedListener(ISelectionChangedListener l)
- Specified by:
removeSelectionChangedListenerin interfaceISelectionProvider- See Also:
ISelectionProvider.removeSelectionChangedListener(ISelectionChangedListener)
-
reveal
public void reveal(EditPart part)
Description copied from interface:EditPartViewerReveals the given EditPart if it is not visible.- Specified by:
revealin interfaceEditPartViewer- Parameters:
part- the EditPart to reveal- See Also:
EditPartViewer.reveal(EditPart)
-
select
public void select(EditPart editpart)
Description copied from interface:EditPartViewerReplaces the current selection with the specifiedEditPart. That part becomes the primary selection. Fires selection changed toISelectionChangedListeners.- Specified by:
selectin interfaceEditPartViewer- Parameters:
editpart- the new selection- See Also:
EditPartViewer.select(EditPart)
-
setContextMenu
public void setContextMenu(MenuManager manager)
Description copied from interface:EditPartViewerSets the contextMenuManagerfor this viewer. The MenuManager will be asked to create a Menu, which will be used as the context menu for this viewer's Control.- Specified by:
setContextMenuin interfaceEditPartViewer- Parameters:
manager- theContextMenuProvider- See Also:
EditPartViewer.setContextMenu(MenuManager)
-
setContents
public void setContents(EditPart editpart)
Description copied from interface:EditPartViewerSets the contents for this Viewer. The contents can also be set usingEditPartViewer.setContents(Object).- Specified by:
setContentsin interfaceEditPartViewer- Parameters:
editpart- the contents- See Also:
EditPartViewer.setContents(EditPart)
-
setContents
public void setContents(java.lang.Object contents)
Description copied from interface:EditPartViewerCreates anEditPartfor the provided model object using theEditPartFactory. That EditPart is then added to theRootEditPart, and becomes the viewer's contents editpart.- Specified by:
setContentsin interfaceEditPartViewer- Parameters:
contents- the contents model object- See Also:
EditPartViewer.setContents(Object)
-
setControl
public void setControl(Control control)
Description copied from interface:EditPartViewerSets theControlfor this viewer. The viewer's control is also set automatically ifEditPartViewer.createControl(Composite)is called.- Specified by:
setControlin interfaceEditPartViewer- Parameters:
control- the Control- See Also:
EditPartViewer.setControl(Control)
-
setCursor
public void setCursor(Cursor cursor)
Description copied from interface:EditPartViewerSets the cursor for the viewer'sControl. This method should only be called byTools.nullcan be used to indicate that the default cursor should be restored.- Specified by:
setCursorin interfaceEditPartViewer- Parameters:
cursor-nullor a Cursor- See Also:
EditPartViewer.setCursor(Cursor)
-
setDragSource
protected void setDragSource(DragSource source)
Sets the drag source. Called fromrefreshDragSourceAdapter().- Parameters:
source-nullor a drag source
-
setDropTarget
protected void setDropTarget(DropTarget target)
Sets the drop target. Called fromrefreshDropTargetAdapter().- Parameters:
target- dropTargetnullor a drop target
-
setEditDomain
public void setEditDomain(EditDomain editdomain)
Description copied from interface:EditPartViewerSets theEditDomainfor this viewer. The Viewer will route all mouse and keyboard events to the EditDomain.- Specified by:
setEditDomainin interfaceEditPartViewer- Parameters:
editdomain- The EditDomain- See Also:
EditPartViewer.setEditDomain(EditDomain)
-
setEditPartFactory
public void setEditPartFactory(EditPartFactory factory)
Description copied from interface:EditPartViewerSets the EditPartFactory.- Specified by:
setEditPartFactoryin interfaceEditPartViewer- Parameters:
factory- the factory- See Also:
EditPartViewer.setEditPartFactory(org.eclipse.gef.EditPartFactory)
-
setFocus
public void setFocus(EditPart part)
Description copied from interface:EditPartViewerSets the focus EditPart.- Specified by:
setFocusin interfaceEditPartViewer- Parameters:
part- the FocusPart.- See Also:
EditPartViewer.setFocus(EditPart)
-
setKeyHandler
public void setKeyHandler(KeyHandler handler)
Description copied from interface:EditPartViewerSets theKeyHandler.- Specified by:
setKeyHandlerin interfaceEditPartViewer- Parameters:
handler- the KeyHandler- See Also:
EditPartViewer.setKeyHandler(KeyHandler)
-
setProperty
public void setProperty(java.lang.String key, java.lang.Object value)Description copied from interface:EditPartViewerSets a property on this viewer. A viewer property is an arbitrary key-value pair that can be observed viaEditPartViewer.addPropertyChangeListener(PropertyChangeListener). Anullvalue will remove the property from the viewer.- Specified by:
setPropertyin interfaceEditPartViewer- Parameters:
key- a unique string identifying the propertyvalue- the properties new value ornullto remove- See Also:
EditPartViewer.setProperty(String, Object)
-
setRootEditPart
public void setRootEditPart(RootEditPart editpart)
Description copied from interface:EditPartViewerSets the root of this viewer. The root should not be confused with the contents.- Specified by:
setRootEditPartin interfaceEditPartViewer- Parameters:
editpart- the RootEditPart- See Also:
EditPartViewer.setRootEditPart(RootEditPart)
-
setRouteEventsToEditDomain
public void setRouteEventsToEditDomain(boolean value)
Description copied from interface:EditPartViewerTurns on/off the routing of events directly to the Editor. If supported by the viewer implementation, all Events should be routed to theEditDomainrather than handled in the default way.- Specified by:
setRouteEventsToEditDomainin interfaceEditPartViewer- Parameters:
value- true if the viewer should route events to the EditDomain- See Also:
EditPartViewer.setRouteEventsToEditDomain(boolean)
-
setSelection
public void setSelection(ISelection newSelection)
Sets the selection to the given selection and fires selection changed. The ISelection should be anIStructuredSelectionor it will be ignored.- Specified by:
setSelectionin interfaceISelectionProvider- See Also:
ISelectionProvider.setSelection(ISelection)
-
unhookControl
protected void unhookControl()
Called when the control is being set tonull, but before it is null.
-
unregisterAccessibleEditPart
public void unregisterAccessibleEditPart(AccessibleEditPart acc)
Does nothing by default. Subclasses needing to add accessibility support should override this method.- Specified by:
unregisterAccessibleEditPartin interfaceEditPartViewer- Parameters:
acc- the accessible part- See Also:
EditPartViewer.unregisterAccessibleEditPart(AccessibleEditPart)
-
-