diff options
Diffstat (limited to 'visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/Visualizer.java')
| -rwxr-xr-x | visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/Visualizer.java | 99 |
1 files changed, 40 insertions, 59 deletions
diff --git a/visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/Visualizer.java b/visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/Visualizer.java index 605f35b50fb..d7e820eaca3 100755 --- a/visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/Visualizer.java +++ b/visualizer/org.eclipse.cdt.visualizer.ui/src/org/eclipse/cdt/visualizer/ui/Visualizer.java @@ -24,7 +24,6 @@ import org.eclipse.jface.viewers.SelectionChangedEvent; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; - // --------------------------------------------------------------------------- // Visualizer // --------------------------------------------------------------------------- @@ -32,11 +31,9 @@ import org.eclipse.swt.widgets.Control; /** * Base class for IVisualizer implementations. */ -abstract public class Visualizer - implements IVisualizer, ISelectionProvider, ISelectionChangedListener -{ +abstract public class Visualizer implements IVisualizer, ISelectionProvider, ISelectionChangedListener { // --- members --- - + /** Visualizer's non-localized name. */ protected String m_name; @@ -48,22 +45,21 @@ abstract public class Visualizer /** The parent view control. */ protected IVisualizerViewer m_viewer; - + /** The visualizer control. */ protected Control m_control; - + /** Externally visible selection manager. */ protected SelectionManager m_selectionManager; - - + // --- constructors/destructors --- - + /** Constructor. */ public Visualizer() { // TODO: internationalize these strings. this("visualizer", "Visualizer", "Displays graphic representation of selection."); } - + /** Constructor. */ public Visualizer(String name, String displayName, String description) { setName(name); @@ -71,7 +67,7 @@ abstract public class Visualizer setDescription(description); m_selectionManager = new SelectionManager(this, "Visualizer selection manager"); } - + /** Dispose method. */ public void dispose() { m_name = null; @@ -85,31 +81,28 @@ abstract public class Visualizer } } - // --- init methods --- - + /** Invoked when visualizer is created, to permit any initialization. * Intended to be overridden. Default implementation does nothing. */ - public void initializeVisualizer() - { + public void initializeVisualizer() { } - + /** Invoked when visualizer is disposed, to permit any cleanup. * Intended to be overridden. Default implementation calls dispose(). */ - public void disposeVisualizer() - { + public void disposeVisualizer() { dispose(); } - - + // --- accessors --- /** Sets non-localized name. */ public void setName(String name) { m_name = name; } + /** Gets non-localized name. */ public String getName() { return m_name; @@ -119,6 +112,7 @@ abstract public class Visualizer public void setDisplayName(String displayName) { m_displayName = displayName; } + /** Gets localized display name. */ public String getDisplayName() { return m_displayName; @@ -128,12 +122,12 @@ abstract public class Visualizer public void setDescription(String description) { m_description = description; } + /** Gets localized description string. */ public String getDescription() { return m_description; } - // --- viewer management --- /** Sets viewer we're associated with. */ @@ -145,27 +139,25 @@ abstract public class Visualizer public IVisualizerViewer getViewer() { return m_viewer; } - // --- visualizer selection management --- - + /** Invoked when visualizer has been selected. */ public void visualizerSelected() { }; - + /** Invoked when another visualizer has been selected, hiding this one. */ public void visualizerDeselected() { }; - // --- control management --- - + /** Creates and returns visualizer's UI control on specified parent control. */ abstract public Control createControl(Composite parent); /** Invoked when visualizer control should be disposed. */ abstract public void disposeControl(); - + /** * Sets visualizer control. * Intended to be called from createControl(); @@ -181,7 +173,6 @@ abstract public class Visualizer return m_control; } - // --- menu/toolbar management --- /** Invoked by VisualizerViewer when toolbar needs to be populated. */ @@ -192,39 +183,34 @@ abstract public class Visualizer public void populateMenu(IMenuManager menuManager) { } - // --- context menu handling --- - + /** Invoked by VisualizerViewer when context menu needs to be populated. */ public void populateContextMenu(IMenuManager menuManager) { } - // --- workbench selection management --- - /** - * Tests whether if the IVisualizer can display the selection - * (or something reachable from it). - */ - public int handlesSelection(ISelection selection) - { + /** + * Tests whether if the IVisualizer can display the selection + * (or something reachable from it). + */ + public int handlesSelection(ISelection selection) { // Default implementation doesn't know how to display anything. return 0; } - /** - * Invoked by VisualizerViewer when workbench selection changes. - */ - public void workbenchSelectionChanged(ISelection selection) - { + /** + * Invoked by VisualizerViewer when workbench selection changes. + */ + public void workbenchSelectionChanged(ISelection selection) { // Default implementation does nothing. } - // --- ISelectionProvider implementation --- - + // Delegate to selection manager. - + /** Adds external listener for selection change events. */ public void addSelectionChangedListener(ISelectionChangedListener listener) { m_selectionManager.addSelectionChangedListener(listener); @@ -234,37 +220,32 @@ abstract public class Visualizer public void removeSelectionChangedListener(ISelectionChangedListener listener) { m_selectionManager.removeSelectionChangedListener(listener); } - + /** Raises selection changed event. */ public void raiseSelectionChangedEvent() { m_selectionManager.raiseSelectionChangedEvent(); } - + /** Gets current externally-visible selection. */ - public ISelection getSelection() - { + public ISelection getSelection() { return m_selectionManager.getSelection(); } - + /** Sets externally-visible selection. */ - public void setSelection(ISelection selection) - { + public void setSelection(ISelection selection) { m_selectionManager.setSelection(selection); } /** Sets externally-visible selection. */ - public void setSelection(ISelection selection, boolean raiseEvent) - { + public void setSelection(ISelection selection, boolean raiseEvent) { m_selectionManager.setSelection(selection, raiseEvent); } /** Returns true if we currently have a non-empty selection. */ - public boolean hasSelection() - { + public boolean hasSelection() { return m_selectionManager.hasSelection(); } - - + // --- ISelectionChangedListener implementation --- /** |