|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.LayoutDataService
de.cau.cs.kieler.kiml.service.ExtensionLayoutDataService
de.cau.cs.kieler.kiml.ui.layout.EclipseLayoutDataService
public class EclipseLayoutDataService
A special layout data service for use in an Eclipse instance.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class de.cau.cs.kieler.kiml.LayoutDataService |
---|
LayoutDataService.Registry |
Field Summary | |
---|---|
static String |
ATTRIBUTE_CONFIG
name of the 'config' attribute in the extension points. |
static String |
ATTRIBUTE_PREVIEW
name of the 'preview' attribute in the extension points. |
static String |
ATTRIBUTE_VALUE
name of the 'value' attribute in the extension points. |
static String |
ELEMENT_BINDING
name of the 'binding' element in the 'layout info' extension point. |
static String |
ELEMENT_MANAGER
name of the 'manager' element in the 'layout managers' extension point. |
static String |
ELEMENT_OPTION
name of the 'option' element in the 'layout info' extension point. |
static String |
ELEMENT_SEMANTIC_OPTION
name of the 'semantic option' element in the 'layout info' extension point. |
static String |
EXTP_ID_LAYOUT_INFO
identifier of the extension point for layout info. |
static String |
EXTP_ID_LAYOUT_MANAGERS
identifier of the extension point for layout managers. |
static String |
PREF_OBLIQUE_ROUTE
preference identifier for oblique edge routing. |
static String |
PREF_REG_ELEMENTS
preference identifier for the list of registered diagram elements. |
Fields inherited from class de.cau.cs.kieler.kiml.LayoutDataService |
---|
DIAGRAM_TYPE_GENERAL |
Constructor Summary | |
---|---|
EclipseLayoutDataService()
|
Method Summary | |
---|---|
ICachedLayout |
cacheLayout(IWorkbenchPart workbenchPart,
EditPart editPart,
boolean animate,
boolean progressBar)
Performs layout on the given editor by choosing an appropriate layout manager instance and caches the layout result. |
protected LayoutAlgorithmData |
createLayoutAlgorithmData(IConfigurationElement element)
Create a layout algorithm data instance and configure it with platform-specific extensions. |
static void |
createLayoutServices()
Builds the layout services for the Eclipse platform. |
Object |
getDefault(String className,
String optionId)
Retrieves the default value for the given element class and option identifier from the extension point. |
IGraphicalFrameworkBridge |
getFrameworkBridge(EditPart editPart)
Retrieve an editing framework bridge for the given edit part using the most suitable layout manager. |
static EclipseLayoutDataService |
getInstance()
Returns the singleton instance as Eclipse layout services. |
ILayoutConfig |
getLayoutConfig(EditPart editPart)
Retrieve a layout configuration for the given edit part using the most suitable layout manager. |
ILayoutConfig |
getLayoutConfig(IWorkbenchPart workbenchPart)
Retrieve a layout configuration for the given editor using the most suitable layout manager. |
DiagramLayoutManager |
getManager(IWorkbenchPart workbenchPart,
EditPart editPart)
Returns the most suitable layout manager for the given editor and edit part. |
LayoutOptionData<?> |
getOptionData(LayoutAlgorithmData providerData,
String optionName)
Returns the layout option data that matches the given user-friendly name and is known by the given layout provider. |
static String |
getPreferenceName(String id1,
String id2)
Returns the preference name associated with the two identifiers. |
Set<String> |
getRegisteredElements()
Returns the set of registered diagram elements. |
DiagramLayoutManager |
layout(IWorkbenchPart workbenchPart,
EditPart editPart,
boolean animate,
boolean progressBar)
Performs layout on the given editor by choosing an appropriate layout manager instance. |
DiagramLayoutManager |
layout(IWorkbenchPart workbenchPart,
EditPart editPart,
boolean animate,
boolean progressBar,
boolean layoutAncestors)
Performs layout on the given editor by choosing an appropriate layout manager instance. |
void |
loadDefaultOptions()
Loads the default layout options from the extension point. |
static void |
readSupportPriorities(int[][] priorityData,
String[] layoutProviders,
String[] diagramTypes)
Fills the given table of priorities with data from the extension point. |
protected void |
reportError(CoreException exception)
Report an error that occurred while reading extensions. |
protected void |
reportError(String extensionPoint,
IConfigurationElement element,
String attribute,
Throwable exception)
Report an error that occurred while reading extensions. |
void |
storeOption(EditPart editPart,
LayoutOptionData<?> optionData,
String valueString,
boolean storeDomainModel)
Stores the layout option with given value for the edit part. |
void |
storeOption(String diagramType,
LayoutOptionData<?> optionData,
String valueString)
Stores the layout option with given value for the diagram type. |
void |
storePreferences()
Stores preferences for KIML. |
Methods inherited from class de.cau.cs.kieler.kiml.service.ExtensionLayoutDataService |
---|
createLayoutProvider, loadClass, loadLayoutProviderExtensions |
Methods inherited from class de.cau.cs.kieler.kiml.LayoutDataService |
---|
createLayoutServices, getAlgorithmData, getAlgorithmData, getCategoryName, getDiagramTypeName, getDiagramTypes, getInstanceOf, getMode, getOption, getOption, getOptionData, getOptionData, getOptionData, getOptions, getOptions, getRegistry, getSemanticConfigs, getTypeData, getTypeData, removeLayoutServices, removeLayoutServices, setMode, setMode |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String EXTP_ID_LAYOUT_INFO
public static final String EXTP_ID_LAYOUT_MANAGERS
public static final String ELEMENT_BINDING
public static final String ELEMENT_MANAGER
public static final String ELEMENT_OPTION
public static final String ELEMENT_SEMANTIC_OPTION
public static final String ATTRIBUTE_CONFIG
public static final String ATTRIBUTE_PREVIEW
public static final String ATTRIBUTE_VALUE
public static final String PREF_REG_ELEMENTS
public static final String PREF_OBLIQUE_ROUTE
Constructor Detail |
---|
public EclipseLayoutDataService()
Method Detail |
---|
public static void createLayoutServices()
public static EclipseLayoutDataService getInstance()
null
if the instance is not
of Eclipse layout servicespublic DiagramLayoutManager getManager(IWorkbenchPart workbenchPart, EditPart editPart)
workbenchPart
- the workbench part for which the layout manager should be
fetched, or null
editPart
- the edit part for which the layout manager should be
fetched, or null
public IGraphicalFrameworkBridge getFrameworkBridge(EditPart editPart)
editPart
- the edit part for which the bridge should be fetched
null
public ILayoutConfig getLayoutConfig(IWorkbenchPart workbenchPart)
workbenchPart
- the workbench part for which the configuration should be fetched
null
public ILayoutConfig getLayoutConfig(EditPart editPart)
editPart
- the edit part for which the configuration should be fetched
null
public DiagramLayoutManager layout(IWorkbenchPart workbenchPart, EditPart editPart, boolean animate, boolean progressBar)
workbenchPart
- the workbench part for which layout is performed, or null
if
the diagram is not part of an editoreditPart
- the parent edit part for which layout is performed, or null
if the whole diagram shall be layoutedanimate
- if true, Draw2D animation is activatedprogressBar
- if true, a progress bar is displayed
public ICachedLayout cacheLayout(IWorkbenchPart workbenchPart, EditPart editPart, boolean animate, boolean progressBar)
workbenchPart
- the workbench part for which layout is performed, or null
if
the diagram is not part of an editoreditPart
- the parent edit part for which layout is performed, or null
if the whole diagram shall be layoutedanimate
- if true, Draw2D animation is activatedprogressBar
- if true, a progress bar is displayed
public DiagramLayoutManager layout(IWorkbenchPart workbenchPart, EditPart editPart, boolean animate, boolean progressBar, boolean layoutAncestors)
workbenchPart
- the workbench part for which layout is performed, or null
if
the diagram is not part of an editoreditPart
- the parent edit part for which layout is performed, or null
if the whole diagram shall be layoutedanimate
- if true, Draw2D animation is activatedprogressBar
- if true, a progress bar is displayedlayoutAncestors
- if true, layout is not only performed for the selected edit
part, but also for its ancestors
public static String getPreferenceName(String id1, String id2)
id1
- first identifierid2
- second identifier
public static void readSupportPriorities(int[][] priorityData, String[] layoutProviders, String[] diagramTypes)
priorityData
- two dimensional array that is filled with datalayoutProviders
- array of layout provider identifiersdiagramTypes
- array of diagram type identifierspublic void storeOption(String diagramType, LayoutOptionData<?> optionData, String valueString)
diagramType
- a diagram type identifieroptionData
- a layout option datavalueString
- the value to store for the diagram type and optionpublic void storeOption(EditPart editPart, LayoutOptionData<?> optionData, String valueString, boolean storeDomainModel)
editPart
- an edit partoptionData
- a layout option datavalueString
- the value to store for the edit part and optionstoreDomainModel
- if true, the option is stored for the domain model element
associated with the edit part, else for the edit part itselfpublic void loadDefaultOptions()
public Object getDefault(String className, String optionId)
className
- name of a diagram element classoptionId
- layout option identifier
public LayoutOptionData<?> getOptionData(LayoutAlgorithmData providerData, String optionName)
providerData
- a layout provider dataoptionName
- user-friendly name of a layout option
protected void reportError(String extensionPoint, IConfigurationElement element, String attribute, Throwable exception)
reportError
in class ExtensionLayoutDataService
extensionPoint
- the identifier of the extension pointelement
- the configuration elementattribute
- the attribute that contains an invalid entryexception
- an optional exception that was caused by the invalid entryprotected void reportError(CoreException exception)
reportError
in class ExtensionLayoutDataService
exception
- a core exception holding a status with further informationprotected LayoutAlgorithmData createLayoutAlgorithmData(IConfigurationElement element)
createLayoutAlgorithmData
in class ExtensionLayoutDataService
element
- a configuration element to use for configuration
public void storePreferences()
public Set<String> getRegisteredElements()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |