org.eclipse.hyades.uml2sd.ui.view
Class SDView

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.ui.part.WorkbenchPart
          org.eclipse.ui.part.ViewPart
              org.eclipse.hyades.uml2sd.ui.view.SDView

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class SDView

extends org.eclipse.ui.part.ViewPart

Field Summary

protected OpenReportAction	_exportAction
protected static java.lang.String	ACTION_NEXTPAGE
protected static java.lang.String	ACTION_PREVPAGE
protected static java.lang.String	FIND_REPLACE
protected org.eclipse.jface.action.Action	findForKeyBinding
protected org.eclipse.jface.action.Action	goToMessageForKeyBinding
protected FilterInternalMessages	internalFilterButton
protected NextPage	nextPageButton
protected PrevPage	prevPageButton
protected IExtendedFilterProvider	sdExFilterProvider
protected IExtendedFindProvider	sdExFindProvider
protected ISDExtendedActionBarProvider	sdExtendedActionBarProvider
protected ISDFilterProvider	sdFilterProvider
protected ISDFindProvider	sdFindProvider
protected ISDInternalMesFilterProvider	sdIntFilterProvider
protected ISDPagingProvider	sdPagingProvider
protected ISDPropertiesProvider	sdPropertiesProvider
protected SDWidget	sdWidget
protected TimeCompressionBar	timeCompressionBar

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

SDView()

Method Summary

protected void	createCoolbarContent() Creates the coolBar icon depending on the actions supported by the Sequence Diagram provider - Navigation buttons are displayed if ISDPovider.HasPaging return true - Navigation buttons are enabled depending on the value return by ISDPovider.HasNext and HasPrev
protected void	createMenuGroup()
void	createPartControl(org.eclipse.swt.widgets.Composite c)
void	ensureVisibleSync(GraphNode sm) Ensure an object is visible from an other thread than the one executing the main loop
java.lang.Object	getAdapter(java.lang.Class _adapter)
IExtendedFilterProvider	getExtendedFilterProvider()
IExtendedFindProvider	getExtendedFindProvider()
Frame	getFrame() Returns the current Frame (the sequence diagram container)
ISDInternalMesFilterProvider	getInternalMessageFilterProvider()
org.eclipse.jface.action.MenuManager	getMenuManager() Returns the context menu manager
ISDExtendedActionBarProvider	getSDExtendedActionBarProvider() Returns the current extended action bar provider for the view
ISDFilterProvider	getSDFilterProvider() Returns the current filter provider for the view
ISDGraphNodeSupporter	getSDFindProvider() Returns the current find provider for the view
ISDPagingProvider	getSDPagingProvider() Returns the current page provider for the view
ISDPropertiesProvider	getSDPropertiesProvider() Returns the current extended action bar provider for the view
SDWidget	getSDWidget()
TimeCompressionBar	getTimeCompressionBar() Return the time compression bar widget
void	resetProviders()
void	setCollapsingProvider(ISDCollapseProvider provider) Register the given provider to support Drag and Drop collapsing.
void	setEnableAction(java.lang.String actionName, boolean state)
void	setEnableCommand(java.lang.String id, boolean value) Activate or desactivate the short key command given in parameter (see plugin.xml)
void	setExtendedFilterProvider(IExtendedFilterProvider provider)
void	setExtendedFindProvider(IExtendedFindProvider provider)
void	setFocus()
void	setFrame(Frame frame) The frame to render (the sequence diagram)
protected void	setFrame(Frame frame, boolean resetPosition) The frame to render (the sequence diagram)
void	setFrameAndEnsureVisible(Frame frame, GraphNode sm) Set the frame and ensure an object is visible
void	setFrameAndEnsureVisible(Frame frame, int x, int y) Set the frame and ensure an object is visible
void	setFrameAndEnsureVisibleSync(Frame frame, GraphNode sm) Set the frame and ensure an object is visible from an other thread than the one executing the main loop
void	setFrameAndEnsureVisibleSync(Frame frame, int x, int y) Set the frame and ensure an object is visible from an other thread than the one executing the main loop
void	setFrameSync(Frame frame) Set the frame from an other thread than the one executing the main loop
void	setInternalMessageFilterProvider(ISDInternalMesFilterProvider provider)
void	setSDExtendedActionBarProvider(ISDExtendedActionBarProvider provider) Set the extended action bar provider for the opened sequence diagram viewer This allow to add programmatically actions in the coolbar and/or in the dropdown menu
void	setSDFilterProvider(ISDFilterProvider provider) Set the filter provider for the opened sequence diagram viewer If the provider is not set, the filter menu item will not be available in the viewer A filter provider is called back when the user perform a filter action
void	setSDFindProvider(ISDFindProvider provider) Set the find provider for the opened sequence diagram viewer If the provider is not set, the find menu item will not be available in the viewer A find provider is called back when the user perform a find action The find provider is reponsible to move the sequence diagram to the GraphNode which match the find criteria as well as to highlight the GraphNode
void	setSDPagingProvider(ISDPagingProvider provider) Set the page provider for the opened sequence diagram viewer If the sequence diagram provided (see setFrame) need to be split in many parts, a paging provider must be provided in order to handle page change requested by the user Set a page provider will create the next and prev page buttons in the viewer coolBar
void	setSDPropertiesProvider(ISDPropertiesProvider provider) Set the properties view provider for the opened sequence diagram viewer
void	toggleWaitCursorSync(boolean wait_) Toggle between default and wait cursors from an other thread than the one executing the main loop
void	updateCoolBar() Updates the view coolbar buttons state according to the value return by: - ISDExtendedActionBarProvider.hasNextPage() - ISDExtendedActionBarProvider.hasPrevPage()
protected void	updatePagesMenuItem(org.eclipse.ui.IActionBars bar) Enables or disables the Pages... menu item, depending on the number of pages

Methods inherited from class org.eclipse.ui.part.ViewPart

checkSite, getViewSite, init, init, saveState, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Field Detail

ACTION_PREVPAGE

protected static final java.lang.String ACTION_PREVPAGE

See Also:

Constant Field Values

ACTION_NEXTPAGE

protected static final java.lang.String ACTION_NEXTPAGE

See Also:

Constant Field Values

FIND_REPLACE

protected static final java.lang.String FIND_REPLACE

See Also:

Constant Field Values

sdWidget

protected SDWidget sdWidget

timeCompressionBar

protected TimeCompressionBar timeCompressionBar

sdFindProvider

protected ISDFindProvider sdFindProvider

sdPagingProvider

protected ISDPagingProvider sdPagingProvider

sdFilterProvider

protected ISDFilterProvider sdFilterProvider

sdExFilterProvider

protected IExtendedFilterProvider sdExFilterProvider

sdExFindProvider

protected IExtendedFindProvider sdExFindProvider

sdIntFilterProvider

protected ISDInternalMesFilterProvider sdIntFilterProvider

sdExtendedActionBarProvider

protected ISDExtendedActionBarProvider sdExtendedActionBarProvider

sdPropertiesProvider

protected ISDPropertiesProvider sdPropertiesProvider

nextPageButton

protected NextPage nextPageButton

prevPageButton

protected PrevPage prevPageButton

internalFilterButton

protected FilterInternalMessages internalFilterButton

goToMessageForKeyBinding

protected org.eclipse.jface.action.Action goToMessageForKeyBinding

findForKeyBinding

protected org.eclipse.jface.action.Action findForKeyBinding

_exportAction

protected OpenReportAction _exportAction

Constructor Detail

SDView

public SDView()

Method Detail

getSDWidget

public SDWidget getSDWidget()

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite c)

setFocus

public void setFocus()

setSDFindProvider

public void setSDFindProvider(ISDFindProvider provider)

Set the find provider for the opened sequence diagram viewer
If the provider is not set, the find menu item will not be available in the viewer
A find provider is called back when the user perform a find action
The find provider is reponsible to move the sequence diagram to the GraphNode which match the find criteria as well as to highlight the GraphNode

Parameters:

provider - the search provider

setExtendedFindProvider

public void setExtendedFindProvider(IExtendedFindProvider provider)

getExtendedFindProvider

public IExtendedFindProvider getExtendedFindProvider()

resetProviders

public void resetProviders()

setSDFilterProvider

public void setSDFilterProvider(ISDFilterProvider provider)

Set the filter provider for the opened sequence diagram viewer
If the provider is not set, the filter menu item will not be available in the viewer
A filter provider is called back when the user perform a filter action

Parameters:

provider - the filter provider

setCollapsingProvider

public void setCollapsingProvider(ISDCollapseProvider provider)

Register the given provider to support Drag and Drop collapsing. This provider is responsible of updating the Frame.

Parameters:

provider - - the provider to register

setExtendedFilterProvider

public void setExtendedFilterProvider(IExtendedFilterProvider provider)

getExtendedFilterProvider

public IExtendedFilterProvider getExtendedFilterProvider()

setInternalMessageFilterProvider

public void setInternalMessageFilterProvider(ISDInternalMesFilterProvider provider)

getInternalMessageFilterProvider

public ISDInternalMesFilterProvider getInternalMessageFilterProvider()

setSDPagingProvider

public void setSDPagingProvider(ISDPagingProvider provider)

Set the page provider for the opened sequence diagram viewer
If the sequence diagram provided (see setFrame) need to be split in many parts, a paging provider must be provided in order to handle page change requested by the user
Set a page provider will create the next and prev page buttons in the viewer coolBar

Parameters:

provider - the paging provider

getSDPagingProvider

public ISDPagingProvider getSDPagingProvider()

Returns the current page provider for the view

Returns:

the paging provider

getSDFindProvider

public ISDGraphNodeSupporter getSDFindProvider()

Returns the current find provider for the view

Returns:

the find provider

getSDFilterProvider

public ISDFilterProvider getSDFilterProvider()

Returns the current filter provider for the view

Returns:

the filter provider

setSDExtendedActionBarProvider

public void setSDExtendedActionBarProvider(ISDExtendedActionBarProvider provider)

Set the extended action bar provider for the opened sequence diagram viewer
This allow to add programmatically actions in the coolbar and/or in the dropdown menu

Parameters:

provider - the search provider

getSDExtendedActionBarProvider

public ISDExtendedActionBarProvider getSDExtendedActionBarProvider()

Returns the current extended action bar provider for the view

Returns:

the extended action bar provider

setSDPropertiesProvider

public void setSDPropertiesProvider(ISDPropertiesProvider provider)

Set the properties view provider for the opened sequence diagram viewer

Parameters:

provider - the properties provider

getSDPropertiesProvider

public ISDPropertiesProvider getSDPropertiesProvider()

Returns the current extended action bar provider for the view

Returns:

the extended action bar provider

getMenuManager

public org.eclipse.jface.action.MenuManager getMenuManager()

Returns the context menu manager

Returns:

the menu manager

setEnableAction

public void setEnableAction(java.lang.String actionName,
                            boolean state)

createCoolbarContent

protected void createCoolbarContent()

Creates the coolBar icon depending on the actions supported by the Sequence Diagram provider
- Navigation buttons are displayed if ISDPovider.HasPaging return true
- Navigation buttons are enabled depending on the value return by ISDPovider.HasNext and HasPrev

See Also:

Action support definition, setSDFilterProvider(ISDFilterProvider), setSDFindProvider(ISDFindProvider), setSDPagingProvider(ISDPagingProvider)

updateCoolBar

public void updateCoolBar()

Updates the view coolbar buttons state according to the value return by: - ISDExtendedActionBarProvider.hasNextPage()
- ISDExtendedActionBarProvider.hasPrevPage()

updatePagesMenuItem

protected void updatePagesMenuItem(org.eclipse.ui.IActionBars bar)

Enables or disables the Pages... menu item, depending on the number of pages

Parameters:

bar - the bar containing the action

setFrame

public void setFrame(Frame frame)

The frame to render (the sequence diagram)

Parameters:

frame - the frame to display

setFrame

protected void setFrame(Frame frame,
                        boolean resetPosition)

The frame to render (the sequence diagram)

Parameters:

frame - the frame to display

setEnableCommand

public void setEnableCommand(java.lang.String id,
                             boolean value)

Activate or desactivate the short key command given in parameter (see plugin.xml)

Parameters:

id - the command id defined in the plugin.xml

value - the state value

setFrameSync

public void setFrameSync(Frame frame)

Set the frame from an other thread than the one executing the main loop

Parameters:

frame -

ensureVisibleSync

public void ensureVisibleSync(GraphNode sm)

Ensure an object is visible from an other thread than the one executing the main loop

Parameters:

sm -

setFrameAndEnsureVisibleSync

public void setFrameAndEnsureVisibleSync(Frame frame,
                                         GraphNode sm)

Set the frame and ensure an object is visible from an other thread than the one executing the main loop

Parameters:

sm -

setFrameAndEnsureVisible

public void setFrameAndEnsureVisible(Frame frame,
                                     GraphNode sm)

Set the frame and ensure an object is visible

Parameters:

sm -

setFrameAndEnsureVisibleSync

public void setFrameAndEnsureVisibleSync(Frame frame,
                                         int x,
                                         int y)

Set the frame and ensure an object is visible from an other thread than the one executing the main loop

setFrameAndEnsureVisible

public void setFrameAndEnsureVisible(Frame frame,
                                     int x,
                                     int y)

Set the frame and ensure an object is visible

toggleWaitCursorSync

public void toggleWaitCursorSync(boolean wait_)

Toggle between default and wait cursors from an other thread than the one executing the main loop

getTimeCompressionBar

public TimeCompressionBar getTimeCompressionBar()

Return the time compression bar widget

Returns:

the time compression bar

getFrame

public Frame getFrame()

Returns the current Frame (the sequence diagram container)

Returns:

the frame

createMenuGroup

protected void createMenuGroup()

getAdapter

public java.lang.Object getAdapter(java.lang.Class _adapter)