Package de.cau.cs.kieler.klighd.ui.viewers

Class PiccoloViewerUI

java.lang.Object

de.cau.cs.kieler.klighd.viewers.AbstractViewer

de.cau.cs.kieler.klighd.piccolo.viewer.PiccoloViewer

de.cau.cs.kieler.klighd.ui.viewers.PiccoloViewerUI

All Implemented Interfaces:

IDiagramOutlinePage.Provider, ILayoutRecorder, IViewer

public class PiccoloViewerUI
extends PiccoloViewer

UI stuff such as the text input mechanism and registry of actions are extracted from the PiccoloViewer to this class to optimize dependencies. PiccoloViewerUi instance will be generated by the PiccoloViewerProvider.

Author:

chsch, ckru

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PiccoloViewerUI.LabelTextWidgetListener	SWT event Listener implementation that is dedicated to the creation and propagation of KlighdTextSelections after corresponding mouse and key events notified to the employed label text widget. Note: This class may be subclassed.
static class	PiccoloViewerUI.Provider	The required corresponding provider class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The identifier of this viewer type as specified in the extension.

Constructor Summary

Constructors

Constructor	Description
PiccoloViewerUI(ContextViewer parentViewer, org.eclipse.swt.widgets.Composite parent)	Creates a Piccolo2D viewer with default style.
PiccoloViewerUI(ContextViewer parentViewer, org.eclipse.swt.widgets.Composite parent, int style)	Creates a Piccolo2D viewer with given style.

Method Summary

Modifier and Type	Method	Description
protected void	addLabelTextWidget(ContextViewer parentViewer)	Adds a text widget to the viewer that can be used to select and edit texts.
protected void	attachLabelTextWidgetEventListener(org.eclipse.swt.custom.StyledText textLabelWidget)	Extension hook method registering an SWT event Listener on the employed textLabelWidget.
protected PiccoloOutlinePage	createDiagramOutlinePage()
protected org.eclipse.swt.custom.StyledText	getLabelTextWidget()	Getter providing the employed StyledText SWT widget, e.g.
protected void	updateSelection(IKlighdSelection selection)	Asynchronously executes the super method #updateSelection(IKlighdSelection) in order to let the calling method terminate quickly and do not block any display modifications.

Methods inherited from class de.cau.cs.kieler.klighd.piccolo.viewer.PiccoloViewer

centerOn, clip, clip, collapse, expand, getClip, getContextViewer, getControl, getDiagramOutlinePage, getRepresentation, getScale, getViewContext, getZoomLevel, hide, installEventHanders, installToolTip, isDisplayed, isExpanded, isMagnificationLensVisible, isVisible, notifyViewChangeListeners, panDiagramToTopLeftCorner, panToTopLeftCorner, reveal, scale, setModel, show, startRecording, stopRecording, stopRecording, stopRecording, toggleExpansion, zoom, zoomToFocus, zoomToLevel

Methods inherited from class de.cau.cs.kieler.klighd.viewers.AbstractViewer

addViewChangeListener, addViewChangeListener, centerOn, clip, clip, collapse, expand, getDiagramSelection, getScale, getSelection, getViewChangeListeners, getVisibleDiagramElements, getVisibleDiagramNodes, hide, isDisplayed, isExpanded, isVisible, notifyViewChangeListeners, panToTopLeftCorner, removeViewChangeListener, resetSelectionTo, resetSelectionTo, resetSelectionTo, resetSelectionToDiagramElements, resetSelectionToSemanticElements, reveal, scale, setModel, setModel, show, toggleExpansion, toggleSelectionOf, toggleSelectionOf, toggleSelectionOf, toggleSelectionOfDiagramElements, toggleSelectionOfSemanticElements, zoomToFocus

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cau.cs.kieler.klighd.IViewer

addViewChangedListener, removeViewChangedEventListener

Field Details

ID

public static final String ID

The identifier of this viewer type as specified in the extension.

See Also:

• Constant Field Values

Constructor Details

PiccoloViewerUI

public PiccoloViewerUI(ContextViewer parentViewer,
 org.eclipse.swt.widgets.Composite parent)

Creates a Piccolo2D viewer with default style.

Parameters:

parentViewer - the parent ContextViewer

parent - the parent composite

PiccoloViewerUI

public PiccoloViewerUI(ContextViewer parentViewer,
 org.eclipse.swt.widgets.Composite parent,
 int style)

Creates a Piccolo2D viewer with given style.

Parameters:

parentViewer - the parent ContextViewer

parent - the parent composite

style - the style attributes

Method Details

getLabelTextWidget

protected org.eclipse.swt.custom.StyledText getLabelTextWidget()

Getter providing the employed StyledText SWT widget, e.g. for installing additional event Listeners.

Returns:

the employed StyledText widget.

addLabelTextWidget

protected void addLabelTextWidget(ContextViewer parentViewer)

Adds a text widget to the viewer that can be used to select and edit texts.

Parameters:

parentViewer - the viewer to which to add the text widget

attachLabelTextWidgetEventListener

protected void attachLabelTextWidgetEventListener(org.eclipse.swt.custom.StyledText textLabelWidget)

Extension hook method registering an SWT event Listener on the employed textLabelWidget.

Parameters:

textLabelWidget - the employed instance of StyledText

updateSelection

protected void updateSelection(IKlighdSelection selection)

Asynchronously executes the super method #updateSelection(IKlighdSelection) in order to let the calling method terminate quickly and do not block any display modifications.

Overrides:

updateSelection in class AbstractViewer

Parameters:

selection - the new IKlighdSelection to be propagated to the selection service.

createDiagramOutlinePage

protected PiccoloOutlinePage createDiagramOutlinePage()

Overrides:

createDiagramOutlinePage in class PiccoloViewer