|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gmf.runtime.diagram.ui.resources.editor.util.EditorUtil
public class EditorUtil
Diagram Utility Class for Editor.
Constructor Summary | |
---|---|
EditorUtil()
|
Method Summary | |
---|---|
static IFile |
createNewDiagramFile(DiagramFileCreator diagramFileCreator,
IPath containerFullPath,
java.lang.String fileName,
java.io.InputStream initialContents,
java.lang.String kind,
Shell shell,
IProgressMonitor progressMonitor,
PreferencesHint preferencesHint)
Creates a new diagram file resource in the selected container and with the selected name. |
static IPath |
getDefaultDiagramPath(java.util.List elements,
java.lang.String diagramKind)
Gets the default diagram path for a new diagram that will contain the elements in elements . |
static java.io.InputStream |
getInitialContents()
Method getInitialContents. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EditorUtil()
Method Detail |
---|
public static IFile createNewDiagramFile(DiagramFileCreator diagramFileCreator, IPath containerFullPath, java.lang.String fileName, java.io.InputStream initialContents, java.lang.String kind, Shell shell, IProgressMonitor progressMonitor, PreferencesHint preferencesHint)
In normal usage, this method is invoked after the user has pressed Finish on the wizard; the enablement of the Finish button implies that all controls on on this page currently contain valid values.
Note that this page caches the new file once it has been successfully created; subsequent invocations of this method will answer the same file resource without attempting to create it again.
This method should be called within a workspace modify operation since it creates resources.
preferencesHint
- The preference hint that is to be used to find the appropriate
preference store from which to retrieve diagram preference
values. The preference hint is mapped to a preference store in
the preference registry <@link DiagramPreferencesRegistry>.
null
if the file was
not createdpublic static IPath getDefaultDiagramPath(java.util.List elements, java.lang.String diagramKind)
elements
. Returns null
if
there is no IVizUIHandler to handle the visualization, or there is a
handler, but it has no default diagram path for the elements.
elements
- the list of elements being visualized on a new class diagramdiagramKind
- the kind of diagram we want to create
elements
. Returns null
if there is no IVizUIHandler to handle the visualization, or
there is a handler, but it has no default diagram path for the
elements.public static java.io.InputStream getInitialContents()
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.