com.vp.plugin

Interface ViewManager

public interface ViewManager

Manages 'GUI' related functions. For example: Getting the root component of application. Showing message dialog on application. Also manages 'Display (human readable) value' for model elements. For example: Getting icon of model element.

Method Summary

Modifier and Type	Method and Description
void	clearMessages(java.lang.String id)
BPMNIconRetriever	createBPMNIconRetriever() Get the BPMNIconRetriever.
javax.swing.JFileChooser	createJFileChooser()
java.awt.Dimension	getDescaledDimension(java.awt.Dimension aDimension)
double	getDescaledDouble(double aDoubleValue)
float	getDescaledFloat(float aFloatValue)
float	getDescaledFontSize(float aFontSize)
java.awt.Font	getDescaledFontSize(java.awt.Font aFont)
int	getDescaledInt(int aIntValue)
java.awt.Rectangle	getDescaledRectangle(java.awt.Rectangle aBounds)
javax.swing.ImageIcon	getDiagramCollectionIconByDiagramType(java.lang.String diagramType, boolean expanded) Get icon by diagram type for Diagram Collection.
java.lang.String	getDisplayDiagramType(java.lang.String diagramType) Get the Display Text of the diagram type.
java.lang.String	getDisplayDiagramTypeWithoutTranslateToUserLanguage(java.lang.String diagramType) Get the Display Text of the diagram type.
java.lang.String	getDisplayModelType(java.lang.String modelType) Get the Display Text of the model type.
java.lang.String	getDisplayModelType(java.lang.String modelType, boolean uniqueTypeName) Get the Display Text of the model type.
java.lang.String	getDisplayModelTypeWithoutTranslateToUserLanguage(java.lang.String modelType) Get the Display Text of the model type.
java.lang.String	getDisplayModelTypeWithoutTranslateToUserLanguage(java.lang.String modelType, boolean uniqueTypeName) Get the Display Text of the model type.
java.lang.String	getDisplayName(IModelElement aModelElement, IDiagramElement aDiagramElement)
java.lang.String	getDisplayName(IProject aProject, IModelElement aModelElement, IDiagramElement aDiagramElement)
java.io.InputStream	getDocumentationImageInputStream(IProject project, java.lang.String path) Get the image input stream of a project (used for dependent projects)
java.io.InputStream	getDocumentationImageInputStream(java.lang.String path) Get the image input stream that can be used in description (documentation).
java.lang.String[]	getDocumentationImagePaths() Get the image paths can be used in description (documentation).
java.lang.String[]	getDocumentationImagePaths(IProject project) Get the image paths of a project (used for dependent projects)
javax.swing.ImageIcon	getIconByDiagramType(java.lang.String diagramType) Get icon by diagram type of a diagram.
javax.swing.ImageIcon	getIconByModel(IModelElement modelElement) Get icon by a model element.
javax.swing.ImageIcon	getIconByModelType(java.lang.String modelType) Get icon by model type of a model element.
javax.swing.ImageIcon	getIconByShapeType(java.lang.String shapeType) Get icon by shape type of a diagram element.
java.lang.String	getIntPropertyDisplayValue(IDiagramProperty property)
java.lang.String	getIntPropertyDisplayValue(IModelProperty property)
java.awt.Component	getRootFrame() Get the root component of this application.
java.awt.BasicStroke	getScaledBasicStroke(java.awt.BasicStroke aBasicStroke)
java.awt.Dimension	getScaledDimension(java.awt.Dimension aDimension)
double	getScaledDouble(double aDoubleValue)
float	getScaledFloat(float aFloatValue)
float	getScaledFontSize(float aFontSize)
java.awt.Font	getScaledFontSize(java.awt.Font aFont)
int	getScaledInt(int aIntValue)
java.awt.Rectangle	getScaledRectangle(java.awt.Rectangle aBounds)
java.lang.Object[]	getSelectedObjectsFromClassRepository() Get the selected objects (IProject, IModelElement) from Class Repository
java.lang.Object[]	getSelectedObjectsFromDiagramNavigator() Get the selected objects (IProject, IDiagramCategory, IDiagramCollection, IDiagramUIModel, IDiagramElement, IModelElement) from Diagram Navigator
java.lang.Object[]	getSelectedObjectsFromLogicalView() Get the selected objects (ILogicalView, ILogicalViewContainer, ILogicalViewElement) from Logical View
java.lang.Object[]	getSelectedObjectsFromModelExplorer() Get the selected objects (IProject, IModelElement, IDiagramUIModel) from Model Explorer
void	openSpec(IModelElement model, java.awt.Component component)
void	removeMessagePaneComponent(java.lang.String id)
int	showConfirmDialog(java.awt.Component component, java.lang.Object msg)
int	showConfirmDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType)
int	showConfirmDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, int messageType)
int	showConfirmDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon)
void	showDialog(IDialogHandler dialogHandler) Show the dialog based on the IDialogHandler.
void	showDialog(IDialogHandler dialogHandler, java.awt.Component base) Show the dialog based on the IDialogHandler.
java.lang.String	showInputDialog(java.awt.Component component, java.lang.Object msg)
java.lang.String	showInputDialog(java.awt.Component component, java.lang.Object msg, java.lang.Object initialSelectedValue)
java.lang.String	showInputDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType)
java.lang.Object	showInputDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int messageType, javax.swing.Icon icon, java.lang.Object[] selectionValues, java.lang.Object initialSelectedValue)
java.lang.String	showInputDialog(java.lang.Object msg)
java.lang.String	showInputDialog(java.lang.Object msg, java.lang.Object initialSelectedValue)
int	showInternalConfirmDialog(java.awt.Component component, java.lang.Object msg)
int	showInternalConfirmDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType)
int	showInternalConfirmDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, int messageType)
int	showInternalConfirmDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon)
java.lang.String	showInternalInputDialog(java.awt.Component component, java.lang.Object msg)
java.lang.String	showInternalInputDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType)
java.lang.Object	showInternalInputDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, javax.swing.Icon icon, java.lang.Object[] selectionValues, java.lang.Object initialSelectedValue)
void	showInternalMessageDialog(java.awt.Component component, java.lang.Object msg)
void	showInternalMessageDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int messageType)
void	showInternalMessageDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int messageType, javax.swing.Icon icon)
int	showInternalOptionDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon, java.lang.Object[] selectionValues, java.lang.Object initialSelectedValue)
void	showMessage(java.lang.String msg)
void	showMessage(java.lang.String msg, java.lang.String id)
void	showMessageDialog(java.awt.Component component, java.lang.Object msg) Show message dialog.
void	showMessageDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int msgType) Show message dialog.
void	showMessageDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int msgType, javax.swing.Icon icon) Show message dialog.
void	showMessagePaneComponent(java.lang.String id)
void	showMessagePaneComponent(java.lang.String id, java.lang.String title, java.awt.Component messageComponent)
int	showOptionDialog(java.awt.Component component, java.lang.Object msg, java.lang.String title, int optionType, int msgType, javax.swing.Icon icon, java.lang.Object[] options, java.lang.Object initialValue)
java.lang.String	translateToUserLanguage(java.lang.String text) Translate the text to user language.

Method Detail

getRootFrame

java.awt.Component getRootFrame()

Get the root component of this application.

Returns:

the root component

showDialog

void showDialog(IDialogHandler dialogHandler)

Show the dialog based on the IDialogHandler.

Parameters:

dialogHandler - the handler of the dialog

showDialog

void showDialog(IDialogHandler dialogHandler,
                java.awt.Component base)

Show the dialog based on the IDialogHandler.

Parameters:

dialogHandler - the handler of the dialog

base - the parent component for showing the dialog. If it is Null, ViewManager.getRootFrame() will be the parent component of the dialog.

createJFileChooser

javax.swing.JFileChooser createJFileChooser()

showConfirmDialog

int showConfirmDialog(java.awt.Component component,
                      java.lang.Object msg)

showConfirmDialog

int showConfirmDialog(java.awt.Component component,
                      java.lang.Object msg,
                      java.lang.String title,
                      int optionType)

showConfirmDialog

int showConfirmDialog(java.awt.Component component,
                      java.lang.Object msg,
                      java.lang.String title,
                      int optionType,
                      int messageType)

showConfirmDialog

int showConfirmDialog(java.awt.Component component,
                      java.lang.Object msg,
                      java.lang.String title,
                      int optionType,
                      int messageType,
                      javax.swing.Icon icon)

showInputDialog

java.lang.String showInputDialog(java.lang.Object msg)

showInputDialog

java.lang.String showInputDialog(java.lang.Object msg,
                                 java.lang.Object initialSelectedValue)

showInputDialog

java.lang.String showInputDialog(java.awt.Component component,
                                 java.lang.Object msg)

showInputDialog

java.lang.String showInputDialog(java.awt.Component component,
                                 java.lang.Object msg,
                                 java.lang.Object initialSelectedValue)

showInputDialog

java.lang.Object showInputDialog(java.awt.Component component,
                                 java.lang.Object msg,
                                 java.lang.String title,
                                 int messageType,
                                 javax.swing.Icon icon,
                                 java.lang.Object[] selectionValues,
                                 java.lang.Object initialSelectedValue)

showInputDialog

java.lang.String showInputDialog(java.awt.Component component,
                                 java.lang.Object msg,
                                 java.lang.String title,
                                 int optionType)

showInternalConfirmDialog

int showInternalConfirmDialog(java.awt.Component component,
                              java.lang.Object msg)

showInternalConfirmDialog

int showInternalConfirmDialog(java.awt.Component component,
                              java.lang.Object msg,
                              java.lang.String title,
                              int optionType)

showInternalConfirmDialog

int showInternalConfirmDialog(java.awt.Component component,
                              java.lang.Object msg,
                              java.lang.String title,
                              int optionType,
                              int messageType)

showInternalConfirmDialog

int showInternalConfirmDialog(java.awt.Component component,
                              java.lang.Object msg,
                              java.lang.String title,
                              int optionType,
                              int messageType,
                              javax.swing.Icon icon)

showInternalInputDialog

java.lang.String showInternalInputDialog(java.awt.Component component,
                                         java.lang.Object msg)

showInternalInputDialog

java.lang.String showInternalInputDialog(java.awt.Component component,
                                         java.lang.Object msg,
                                         java.lang.String title,
                                         int optionType)

showInternalInputDialog

java.lang.Object showInternalInputDialog(java.awt.Component component,
                                         java.lang.Object msg,
                                         java.lang.String title,
                                         int optionType,
                                         javax.swing.Icon icon,
                                         java.lang.Object[] selectionValues,
                                         java.lang.Object initialSelectedValue)

showInternalMessageDialog

void showInternalMessageDialog(java.awt.Component component,
                               java.lang.Object msg)

showInternalMessageDialog

void showInternalMessageDialog(java.awt.Component component,
                               java.lang.Object msg,
                               java.lang.String title,
                               int messageType)

showInternalMessageDialog

void showInternalMessageDialog(java.awt.Component component,
                               java.lang.Object msg,
                               java.lang.String title,
                               int messageType,
                               javax.swing.Icon icon)

showInternalOptionDialog

int showInternalOptionDialog(java.awt.Component component,
                             java.lang.Object msg,
                             java.lang.String title,
                             int optionType,
                             int messageType,
                             javax.swing.Icon icon,
                             java.lang.Object[] selectionValues,
                             java.lang.Object initialSelectedValue)

showMessageDialog

void showMessageDialog(java.awt.Component component,
                       java.lang.Object msg)

Show message dialog. Normally, same as javax.swing.JOptionPane.showMessageDialog(...) However, if the application is running in SDE, which is not a Swing application, javax.swing.JOptionPane may not work properly. So, we recommend you use ViewManager instead of JOptionPane.

Parameters:

component - parent component of the dialog. If NULL, ViewManager.getRootComponent() will be used.

msg - the message object of the message dialog

showMessageDialog

void showMessageDialog(java.awt.Component component,
                       java.lang.Object msg,
                       java.lang.String title,
                       int msgType)

Show message dialog. Normally, same as javax.swing.JOptionPane.showMessageDialog(...) However, if the application is running in SDE, which is not a Swing application, javax.swing.JOptionPane may not work properly. So, we recommend you use ViewManager instead of JOptionPane.

Parameters:

component - parent component of the dialog. If NULL, ViewManager.getRootComponent() will be used.

msg - the message object of the message dialog

title - title of the message dialog

msgType - message type of the message dialog

showMessageDialog

void showMessageDialog(java.awt.Component component,
                       java.lang.Object msg,
                       java.lang.String title,
                       int msgType,
                       javax.swing.Icon icon)

Show message dialog. Normally, same as javax.swing.JOptionPane.showMessageDialog(...) However, if the application is running in SDE, which is not a Swing application, javax.swing.JOptionPane may not work properly. So, we recommend you use ViewManager instead of JOptionPane.

Parameters:

component - parent component of the dialog. If NULL, ViewManager.getRootComponent() will be used.

msg - the message object of the message dialog

title - title of the message dialog

msgType - message type of the message dialog

icon - icon of the message dialog

showOptionDialog

int showOptionDialog(java.awt.Component component,
                     java.lang.Object msg,
                     java.lang.String title,
                     int optionType,
                     int msgType,
                     javax.swing.Icon icon,
                     java.lang.Object[] options,
                     java.lang.Object initialValue)

showMessagePaneComponent

void showMessagePaneComponent(java.lang.String id)

showMessagePaneComponent

void showMessagePaneComponent(java.lang.String id,
                              java.lang.String title,
                              java.awt.Component messageComponent)

removeMessagePaneComponent

void removeMessagePaneComponent(java.lang.String id)

showMessage

void showMessage(java.lang.String msg)

showMessage

void showMessage(java.lang.String msg,
                 java.lang.String id)

clearMessages

void clearMessages(java.lang.String id)

getDisplayModelType

java.lang.String getDisplayModelType(java.lang.String modelType)

Get the Display Text of the model type. e.g. "UseCase" will return "Use Case". and the Display Text will be translated to user language automatically. uniqueTypeName will be FALSE.

Parameters:

modelType - the model type will be translated

Returns:

the Display Text of the model type

See Also:

getDisplayModelType(String, boolean), getDisplayModelTypeWithoutTranslateToUserLanguage(String), getDisplayModelTypeWithoutTranslateToUserLanguage(String, boolean)

getDisplayModelType

java.lang.String getDisplayModelType(java.lang.String modelType,
                                     boolean uniqueTypeName)

Get the Display Text of the model type. e.g. "UseCase" will return "Use Case". and the Display Text will be translated to user language automatically. uniqueTypeName will be FALSE.

Parameters:

modelType - the model type will be translated

uniqueTypeName - determine does the display name will be unique in different model types. e.g. Object Diagram's Link and Communication Diagram's Link will return different Display Name: "Link (Object)" and "Link (Communication)"

Returns:

the Display Text of the model type

See Also:

getDisplayModelTypeWithoutTranslateToUserLanguage(String, boolean)

getDisplayDiagramType

java.lang.String getDisplayDiagramType(java.lang.String diagramType)

Get the Display Text of the diagram type. e.g. "UseCaseDiagram" will return "Use Case Diagram". and the Display Text will be translated to user language automatically.

Parameters:

diagramType - the diagram type will be translated

Returns:

the Display Text of the diagram type

See Also:

getDisplayDiagramTypeWithoutTranslateToUserLanguage(String)

translateToUserLanguage

java.lang.String translateToUserLanguage(java.lang.String text)

Translate the text to user language. Not all text can be translated. Depends on what is supported in {VPSuite Installation}/UserLanguage folder.

Returns:

aText the text to be translated.

getDisplayModelTypeWithoutTranslateToUserLanguage

java.lang.String getDisplayModelTypeWithoutTranslateToUserLanguage(java.lang.String modelType)

Get the Display Text of the model type. e.g. "UseCase" will return "Use Case".

Parameters:

modelType - the model type will be translated

Returns:

the Display Text of the model type

See Also:

getDisplayModelTypeWithoutTranslateToUserLanguage(String, boolean), getDisplayModelType(String, boolean)

getDisplayModelTypeWithoutTranslateToUserLanguage

java.lang.String getDisplayModelTypeWithoutTranslateToUserLanguage(java.lang.String modelType,
                                                                   boolean uniqueTypeName)

Get the Display Text of the model type. e.g. "UseCase" will return "Use Case".

Parameters:

modelType - the model type will be translated

uniqueTypeName - determine does the display name will be unique in different model types. e.g. Object Diagram's Link and Communication Diagram's Link will return different Display Name: "Link (Object)" and "Link (Communication)"

Returns:

the Display Text of the model type

See Also:

getDisplayModelType(String, boolean)

getDisplayDiagramTypeWithoutTranslateToUserLanguage

java.lang.String getDisplayDiagramTypeWithoutTranslateToUserLanguage(java.lang.String diagramType)

Get the Display Text of the diagram type. e.g. "UseCaseDiagram" will return "Use Case Diagram".

Parameters:

diagramType - the diagram type will be translated

Returns:

the Display Text of the diagram type

See Also:

getDisplayDiagramType(String)

getDisplayName

java.lang.String getDisplayName(IModelElement aModelElement,
                                IDiagramElement aDiagramElement)

getDisplayName

java.lang.String getDisplayName(IProject aProject,
                                IModelElement aModelElement,
                                IDiagramElement aDiagramElement)

getIntPropertyDisplayValue

java.lang.String getIntPropertyDisplayValue(IModelProperty property)

getIntPropertyDisplayValue

java.lang.String getIntPropertyDisplayValue(IDiagramProperty property)

getIconByModelType

javax.swing.ImageIcon getIconByModelType(java.lang.String modelType)

Get icon by model type of a model element.

Parameters:

modelType - model type of a IModelElement

Returns:

icon of the model element

getIconByModel

javax.swing.ImageIcon getIconByModel(IModelElement modelElement)

Get icon by a model element. (Such as IOperation will show different icon on different visibility)

Parameters:

modelElement -

Returns:

icon of the model element

getIconByShapeType

javax.swing.ImageIcon getIconByShapeType(java.lang.String shapeType)

Get icon by shape type of a diagram element.

Parameters:

shapeType - shape type of a IDiagramElement

Returns:

icon of the diagram element

getIconByDiagramType

javax.swing.ImageIcon getIconByDiagramType(java.lang.String diagramType)

Get icon by diagram type of a diagram.

Parameters:

diagramType - diagram type of a IDiagramUIModel

Returns:

icon of the diagram

getDiagramCollectionIconByDiagramType

javax.swing.ImageIcon getDiagramCollectionIconByDiagramType(java.lang.String diagramType,
                                                            boolean expanded)

Get icon by diagram type for Diagram Collection. Used to show the icon on a tree structure.

Parameters:

diagramType - diagram type of a IDiagramUIModel

expanded - the icon will be shown for a 'expanded' or a 'collapsed' tree node?

Returns:

icon of the diagram collection

createBPMNIconRetriever

BPMNIconRetriever createBPMNIconRetriever()

Get the BPMNIconRetriever.

Returns:

the icon retriever used to get icon for BPMN model elements

getDocumentationImagePaths

java.lang.String[] getDocumentationImagePaths()

Get the image paths can be used in description (documentation).

Returns:

image paths

See Also:

ProjectManager.addHtmlDocumentationImage(File), ProjectManager.addHtmlDocumentationImage(InputStream)

getDocumentationImagePaths

java.lang.String[] getDocumentationImagePaths(IProject project)

Get the image paths of a project (used for dependent projects)

See Also:

getDocumentationImagePaths()

getDocumentationImageInputStream

java.io.InputStream getDocumentationImageInputStream(java.lang.String path)
                                              throws java.lang.Exception

Get the image input stream that can be used in description (documentation).

Parameters:

path - Image Path

Returns:

input stream

Throws:

java.lang.Exception

See Also:

getDocumentationImagePaths(), ProjectManager.addHtmlDocumentationImage(File), ProjectManager.addHtmlDocumentationImage(InputStream)

getDocumentationImageInputStream

java.io.InputStream getDocumentationImageInputStream(IProject project,
                                                     java.lang.String path)
                                              throws java.lang.Exception

Get the image input stream of a project (used for dependent projects)

Throws:

java.lang.Exception

See Also:

getDocumentationImageInputStream(String)

openSpec

void openSpec(IModelElement model,
              java.awt.Component component)

getSelectedObjectsFromDiagramNavigator

java.lang.Object[] getSelectedObjectsFromDiagramNavigator()

Get the selected objects (IProject, IDiagramCategory, IDiagramCollection, IDiagramUIModel, IDiagramElement, IModelElement) from Diagram Navigator

Returns:

array of IProject, IDiagramCategory, IDiagramCollection, IDiagramUIModel, IDiagramElement, IModelElement

getSelectedObjectsFromModelExplorer

java.lang.Object[] getSelectedObjectsFromModelExplorer()

Get the selected objects (IProject, IModelElement, IDiagramUIModel) from Model Explorer

Returns:

array of IProject, IModelElement, IDiagramUIModel

getSelectedObjectsFromClassRepository

java.lang.Object[] getSelectedObjectsFromClassRepository()

Get the selected objects (IProject, IModelElement) from Class Repository

Returns:

array of IProject, IModelElement

getSelectedObjectsFromLogicalView

java.lang.Object[] getSelectedObjectsFromLogicalView()

Get the selected objects (ILogicalView, ILogicalViewContainer, ILogicalViewElement) from Logical View

Returns:

array of ILogicalView, ILogcalViewContainer, ILogicalViewElement

getScaledInt

int getScaledInt(int aIntValue)

getDescaledInt

int getDescaledInt(int aIntValue)

getScaledFloat

float getScaledFloat(float aFloatValue)

getDescaledFloat

float getDescaledFloat(float aFloatValue)

getScaledDouble

double getScaledDouble(double aDoubleValue)

getDescaledDouble

double getDescaledDouble(double aDoubleValue)

getScaledFontSize

java.awt.Font getScaledFontSize(java.awt.Font aFont)

getDescaledFontSize

java.awt.Font getDescaledFontSize(java.awt.Font aFont)

getScaledFontSize

float getScaledFontSize(float aFontSize)

getDescaledFontSize

float getDescaledFontSize(float aFontSize)

getScaledDimension

java.awt.Dimension getScaledDimension(java.awt.Dimension aDimension)

getDescaledDimension

java.awt.Dimension getDescaledDimension(java.awt.Dimension aDimension)

getScaledRectangle

java.awt.Rectangle getScaledRectangle(java.awt.Rectangle aBounds)

getDescaledRectangle

java.awt.Rectangle getDescaledRectangle(java.awt.Rectangle aBounds)

getScaledBasicStroke

java.awt.BasicStroke getScaledBasicStroke(java.awt.BasicStroke aBasicStroke)