Generators

org.topcased.modeler.diagramconfigurator
Interface DiagramConfiguration

All Superinterfaces:
EObject, Notifier

public interface DiagramConfiguration
extends EObject

A representation of the model object 'Diagram Configuration'.

The following features are supported:

See Also:
DiagramconfiguratorPackage.getDiagramConfiguration()
** Generated **
Model:
annotation="http://www.topcased.org/documentation documentation='A DiagramConfiguration contains informations used to generate a Diagram'" annotation="http://www.eclipse.org/emf/2002/Ecore constraints='Prefix Package PartsPrefixUnicity ObjectsNameUnicity'"

Method Summary
 java.lang.String getBasePackage()
           
 java.lang.String getCopyrightText()
          Returns the value of the 'Copyright Text' attribute.
 org.eclipse.swt.graphics.Color getDefaultBackgroundColor()
          Returns the value of the 'Default Background Color' attribute.
 java.lang.String getDefaultBackgroundColorStringValue()
          Get the String value representing the DefaultBackgroundColor
 org.eclipse.swt.graphics.Font getDefaultFont()
          Returns the value of the 'Default Font' attribute.
 java.lang.String getDefaultFontStringValue()
          Get the String value representing the DefaultFont
 org.eclipse.swt.graphics.Color getDefaultForegroundColor()
          Returns the value of the 'Default Foreground Color' attribute.
 java.lang.String getDefaultForegroundColorStringValue()
          Get the String value representing the DefaultForegroundColor
 EditorConfiguration getEditorConfigurator()
          Returns the value of the 'Editor Configurator' reference.
 java.lang.String getExtension()
          Return the extension to use for the model file in the editor
 java.lang.String getExtensionDiagram()
          Return the extension to use for the diagram file in the editor
 GenModel getGenModel()
          Returns the value of the 'Gen Model' reference.
 java.lang.String getGraphConfIPath()
          Return the String that represent the IPath of the diagram.graphconf relative to the Plugin
 java.lang.String getJavaCopyrightText()
          Return the copyright as the Java format.
 LayoutType getLayout()
          Returns the value of the 'Layout' attribute.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 EList<ObjectConfiguration> getObjects()
          Returns the value of the 'Objects' containment reference list.
 java.lang.String getPackage()
          Returns the value of the 'Package' attribute.
 PaletteConfiguration getPalette()
          Returns the value of the 'Palette' containment reference.
 java.util.List<PartAction> getPartActions()
          Get the list of all the actions that are defined in the PartConfiguration elements of this DiagramConfiguration
 EList<PartConfiguration> getParts()
          Returns the value of the 'Parts' containment reference list.
 java.lang.String getPluginPrefix()
          Return the prefix of the Plugin.java file that should be associated with the diagram.
 java.lang.String getPluginVersion()
          Returns the value of the 'Plugin Version' attribute.
 java.lang.String getPrefix()
          Returns the value of the 'Prefix' attribute.
 java.lang.String getProjectName()
          Returns the value of the 'Project Name' attribute.
 java.lang.String getProvider()
          Returns the value of the 'Provider' attribute.
 GenClass getTemplateRootObject()
          Returns the value of the 'Template Root Object' reference.
 java.util.List<ModelObjectConfiguration> getUniqueModelObjectConfList(boolean nodeFilter, boolean edgeFilter)
          Get the list of all the model objects that are referenced by Parts.
 java.util.List<ModelObjectConfiguration> getUniqueModelObjectConfListFromPalette(boolean nodeFilter, boolean edgeFilter)
          Get the list of all the model objects referenced by the different PaletteItem of the PaletteConfiguration.
 boolean isForceOverwrite()
          Returns the value of the 'Force Overwrite' attribute.
 boolean isOrganizeImports()
          Returns the value of the 'Organize Imports' attribute.
 boolean isOverwriteGraphConf()
          Returns the value of the 'Overwrite Graph Conf' attribute.
 boolean isSamePluginAsEditor()
          Returns the value of the 'Same Plugin As Editor' attribute.
 void setCopyrightText(java.lang.String value)
          Sets the value of the 'Copyright Text' attribute.
 void setDefaultBackgroundColor(org.eclipse.swt.graphics.Color value)
          Sets the value of the 'Default Background Color' attribute.
 void setDefaultFont(org.eclipse.swt.graphics.Font value)
          Sets the value of the 'Default Font' attribute.
 void setDefaultForegroundColor(org.eclipse.swt.graphics.Color value)
          Sets the value of the 'Default Foreground Color' attribute.
 void setEditorConfigurator(EditorConfiguration value)
          Sets the value of the 'Editor Configurator' reference.
 void setForceOverwrite(boolean value)
          Sets the value of the 'Force Overwrite' attribute.
 void setGenModel(GenModel value)
          Sets the value of the 'Gen Model' reference.
 void setLayout(LayoutType value)
          Sets the value of the 'Layout' attribute.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 void setOrganizeImports(boolean value)
          Sets the value of the 'Organize Imports' attribute.
 void setOverwriteGraphConf(boolean value)
          Sets the value of the 'Overwrite Graph Conf' attribute.
 void setPackage(java.lang.String value)
          Sets the value of the 'Package' attribute.
 void setPalette(PaletteConfiguration value)
          Sets the value of the 'Palette' containment reference.
 void setPluginVersion(java.lang.String value)
          Sets the value of the 'Plugin Version' attribute.
 void setPrefix(java.lang.String value)
          Sets the value of the 'Prefix' attribute.
 void setProjectName(java.lang.String value)
          Sets the value of the 'Project Name' attribute.
 void setProvider(java.lang.String value)
          Sets the value of the 'Provider' attribute.
 void setSamePluginAsEditor(boolean value)
          Sets the value of the 'Same Plugin As Editor' attribute.
 void setTemplateRootObject(GenClass value)
          Sets the value of the 'Template Root Object' reference.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getProjectName

java.lang.String getProjectName()
Returns the value of the 'Project Name' attribute.

If the meaning of the 'Project Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Project Name' attribute.
See Also:
setProjectName(String), DiagramconfiguratorPackage.getDiagramConfiguration_ProjectName()
** Generated **
Model:
required="true" extendedMetaData="name='id' kind='attribute'"

setProjectName

void setProjectName(java.lang.String value)
Sets the value of the 'Project Name' attribute.

Parameters:
value - the new value of the 'Project Name' attribute.
See Also:
getProjectName()
** Generated **

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), DiagramconfiguratorPackage.getDiagramConfiguration_Name()
** Generated **
Model:
required="true"

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()
** Generated **

getPackage

java.lang.String getPackage()
Returns the value of the 'Package' attribute.

If the meaning of the 'Package' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Package' attribute.
See Also:
setPackage(String), DiagramconfiguratorPackage.getDiagramConfiguration_Package()
** Generated **
Model:
required="true"

setPackage

void setPackage(java.lang.String value)
Sets the value of the 'Package' attribute.

Parameters:
value - the new value of the 'Package' attribute.
See Also:
getPackage()
** Generated **

getPrefix

java.lang.String getPrefix()
Returns the value of the 'Prefix' attribute.

If the meaning of the 'Prefix' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Prefix' attribute.
See Also:
setPrefix(String), DiagramconfiguratorPackage.getDiagramConfiguration_Prefix()
** Generated **
Model:
required="true"

getPluginPrefix

java.lang.String getPluginPrefix()
Return the prefix of the Plugin.java file that should be associated with the diagram. If the diagram is generated in the same plugin as the editor, then the Activator class is the one provided by the editor, and so the prefix is retrieved from the editor configuration.

Returns:
String

setPrefix

void setPrefix(java.lang.String value)
Sets the value of the 'Prefix' attribute.

Parameters:
value - the new value of the 'Prefix' attribute.
See Also:
getPrefix()
** Generated **

getPalette

PaletteConfiguration getPalette()
Returns the value of the 'Palette' containment reference.

If the meaning of the 'Palette' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Palette' containment reference.
See Also:
setPalette(PaletteConfiguration), DiagramconfiguratorPackage.getDiagramConfiguration_Palette()
** Generated **
Model:
containment="true" required="true"

setPalette

void setPalette(PaletteConfiguration value)
Sets the value of the 'Palette' containment reference.

Parameters:
value - the new value of the 'Palette' containment reference.
See Also:
getPalette()
** Generated **

getParts

EList<PartConfiguration> getParts()
Returns the value of the 'Parts' containment reference list. The list contents are of type PartConfiguration.

If the meaning of the 'Parts' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Parts' containment reference list.
See Also:
DiagramconfiguratorPackage.getDiagramConfiguration_Parts()
** Generated **
Model:
type="org.topcased.modeler.diagramconfigurator.PartConfiguration" containment="true" required="true"

getLayout

LayoutType getLayout()
Returns the value of the 'Layout' attribute. The default value is "XYLayout". The literals are from the enumeration LayoutType.

If the meaning of the 'Layout' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Layout' attribute.
See Also:
LayoutType, setLayout(LayoutType), DiagramconfiguratorPackage.getDiagramConfiguration_Layout()
** Generated **
Model:
default="XYLayout"

setLayout

void setLayout(LayoutType value)
Sets the value of the 'Layout' attribute.

Parameters:
value - the new value of the 'Layout' attribute.
See Also:
LayoutType, getLayout()
** Generated **

getObjects

EList<ObjectConfiguration> getObjects()
Returns the value of the 'Objects' containment reference list. The list contents are of type ObjectConfiguration.

If the meaning of the 'Objects' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Objects' containment reference list.
See Also:
DiagramconfiguratorPackage.getDiagramConfiguration_Objects()
** Generated **
Model:
type="org.topcased.modeler.diagramconfigurator.ObjectConfiguration" containment="true" required="true"

getGenModel

GenModel getGenModel()
Returns the value of the 'Gen Model' reference.

If the meaning of the 'Gen Model' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Gen Model' reference.
See Also:
setGenModel(GenModel), DiagramconfiguratorPackage.getDiagramConfiguration_GenModel()
** Generated **
Model:
required="true"

setGenModel

void setGenModel(GenModel value)
Sets the value of the 'Gen Model' reference.

Parameters:
value - the new value of the 'Gen Model' reference.
See Also:
getGenModel()
** Generated **

getDefaultBackgroundColor

org.eclipse.swt.graphics.Color getDefaultBackgroundColor()
Returns the value of the 'Default Background Color' attribute. The default value is "255,255,255".

If the meaning of the 'Default Background Color' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Default Background Color' attribute.
See Also:
setDefaultBackgroundColor(Color), DiagramconfiguratorPackage.getDiagramConfiguration_DefaultBackgroundColor()
** Generated **
Model:
default="255,255,255" dataType="org.topcased.modeler.diagramconfigurator.Color"

setDefaultBackgroundColor

void setDefaultBackgroundColor(org.eclipse.swt.graphics.Color value)
Sets the value of the 'Default Background Color' attribute.

Parameters:
value - the new value of the 'Default Background Color' attribute.
See Also:
getDefaultBackgroundColor()
** Generated **

getDefaultForegroundColor

org.eclipse.swt.graphics.Color getDefaultForegroundColor()
Returns the value of the 'Default Foreground Color' attribute. The default value is "0,0,0".

If the meaning of the 'Default Foreground Color' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Default Foreground Color' attribute.
See Also:
setDefaultForegroundColor(Color), DiagramconfiguratorPackage.getDiagramConfiguration_DefaultForegroundColor()
** Generated **
Model:
default="0,0,0" dataType="org.topcased.modeler.diagramconfigurator.Color"

setDefaultForegroundColor

void setDefaultForegroundColor(org.eclipse.swt.graphics.Color value)
Sets the value of the 'Default Foreground Color' attribute.

Parameters:
value - the new value of the 'Default Foreground Color' attribute.
See Also:
getDefaultForegroundColor()
** Generated **

getDefaultFont

org.eclipse.swt.graphics.Font getDefaultFont()
Returns the value of the 'Default Font' attribute. The default value is "".

If the meaning of the 'Default Font' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Default Font' attribute.
See Also:
setDefaultFont(Font), DiagramconfiguratorPackage.getDiagramConfiguration_DefaultFont()
** Generated **
Model:
default="" dataType="org.topcased.modeler.diagramconfigurator.Font"

setDefaultFont

void setDefaultFont(org.eclipse.swt.graphics.Font value)
Sets the value of the 'Default Font' attribute.

Parameters:
value - the new value of the 'Default Font' attribute.
See Also:
getDefaultFont()
** Generated **

getTemplateRootObject

GenClass getTemplateRootObject()
Returns the value of the 'Template Root Object' reference.

If the meaning of the 'Template Root Object' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Template Root Object' reference.
See Also:
setTemplateRootObject(GenClass), DiagramconfiguratorPackage.getDiagramConfiguration_TemplateRootObject()
** Generated **
Model:
required="true"

setTemplateRootObject

void setTemplateRootObject(GenClass value)
Sets the value of the 'Template Root Object' reference.

Parameters:
value - the new value of the 'Template Root Object' reference.
See Also:
getTemplateRootObject()
** Generated **

isForceOverwrite

boolean isForceOverwrite()
Returns the value of the 'Force Overwrite' attribute. The default value is "false".

If the meaning of the 'Force Overwrite' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Force Overwrite' attribute.
See Also:
setForceOverwrite(boolean), DiagramconfiguratorPackage.getDiagramConfiguration_ForceOverwrite()
** Generated **
Model:
default="false" required="true"

setForceOverwrite

void setForceOverwrite(boolean value)
Sets the value of the 'Force Overwrite' attribute.

Parameters:
value - the new value of the 'Force Overwrite' attribute.
See Also:
isForceOverwrite()
** Generated **

isOverwriteGraphConf

boolean isOverwriteGraphConf()
Returns the value of the 'Overwrite Graph Conf' attribute. The default value is "true".

If the meaning of the 'Overwrite Graph Conf' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Overwrite Graph Conf' attribute.
See Also:
setOverwriteGraphConf(boolean), DiagramconfiguratorPackage.getDiagramConfiguration_OverwriteGraphConf()
** Generated **
Model:
default="true" required="true"

setOverwriteGraphConf

void setOverwriteGraphConf(boolean value)
Sets the value of the 'Overwrite Graph Conf' attribute.

Parameters:
value - the new value of the 'Overwrite Graph Conf' attribute.
See Also:
isOverwriteGraphConf()
** Generated **

isOrganizeImports

boolean isOrganizeImports()
Returns the value of the 'Organize Imports' attribute. The default value is "true".

If the meaning of the 'Organize Imports' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Organize Imports' attribute.
See Also:
setOrganizeImports(boolean), DiagramconfiguratorPackage.getDiagramConfiguration_OrganizeImports()
** Generated **
Model:
default="true" required="true"

setOrganizeImports

void setOrganizeImports(boolean value)
Sets the value of the 'Organize Imports' attribute.

Parameters:
value - the new value of the 'Organize Imports' attribute.
See Also:
isOrganizeImports()
** Generated **

getEditorConfigurator

EditorConfiguration getEditorConfigurator()
Returns the value of the 'Editor Configurator' reference.

If the meaning of the 'Editor Configurator' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Editor Configurator' reference.
See Also:
setEditorConfigurator(EditorConfiguration), DiagramconfiguratorPackage.getDiagramConfiguration_EditorConfigurator()
** Generated **
Model:
required="true"

setEditorConfigurator

void setEditorConfigurator(EditorConfiguration value)
Sets the value of the 'Editor Configurator' reference.

Parameters:
value - the new value of the 'Editor Configurator' reference.
See Also:
getEditorConfigurator()
** Generated **

getCopyrightText

java.lang.String getCopyrightText()
Returns the value of the 'Copyright Text' attribute.

If the meaning of the 'Copyright Text' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Copyright Text' attribute.
See Also:
setCopyrightText(String), DiagramconfiguratorPackage.getDiagramConfiguration_CopyrightText()
** Generated **
Model:

getJavaCopyrightText

java.lang.String getJavaCopyrightText()
Return the copyright as the Java format. The corresponding * characters are added.

Returns:
String the copyright that could be directly added in a java file

setCopyrightText

void setCopyrightText(java.lang.String value)
Sets the value of the 'Copyright Text' attribute.

Parameters:
value - the new value of the 'Copyright Text' attribute.
See Also:
getCopyrightText()
** Generated **

getPluginVersion

java.lang.String getPluginVersion()
Returns the value of the 'Plugin Version' attribute.

If the meaning of the 'Plugin Version' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Plugin Version' attribute.
See Also:
setPluginVersion(String), DiagramconfiguratorPackage.getDiagramConfiguration_PluginVersion()
** Generated **
Model:
required="true"

setPluginVersion

void setPluginVersion(java.lang.String value)
Sets the value of the 'Plugin Version' attribute.

Parameters:
value - the new value of the 'Plugin Version' attribute.
See Also:
getPluginVersion()
** Generated **

getProvider

java.lang.String getProvider()
Returns the value of the 'Provider' attribute. The default value is "Topcased".

If the meaning of the 'Provider' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Provider' attribute.
See Also:
setProvider(String), DiagramconfiguratorPackage.getDiagramConfiguration_Provider()
** Generated **
Model:
default="Topcased" required="true"

setProvider

void setProvider(java.lang.String value)
Sets the value of the 'Provider' attribute.

Parameters:
value - the new value of the 'Provider' attribute.
See Also:
getProvider()
** Generated **

isSamePluginAsEditor

boolean isSamePluginAsEditor()
Returns the value of the 'Same Plugin As Editor' attribute. The default value is "false".

If the meaning of the 'Same Plugin As Editor' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Same Plugin As Editor' attribute.
See Also:
setSamePluginAsEditor(boolean), DiagramconfiguratorPackage.getDiagramConfiguration_SamePluginAsEditor()
** Generated **
Model:
default="false" required="true"

setSamePluginAsEditor

void setSamePluginAsEditor(boolean value)
Sets the value of the 'Same Plugin As Editor' attribute.

Parameters:
value - the new value of the 'Same Plugin As Editor' attribute.
See Also:
isSamePluginAsEditor()
** Generated **

getBasePackage

java.lang.String getBasePackage()

** Generated **
Model:
kind="operation"

getExtension

java.lang.String getExtension()
Return the extension to use for the model file in the editor

Returns:
String the extension of the model file

getExtensionDiagram

java.lang.String getExtensionDiagram()
Return the extension to use for the diagram file in the editor

Returns:
String the extension of the diagram file

getGraphConfIPath

java.lang.String getGraphConfIPath()
Return the String that represent the IPath of the diagram.graphconf relative to the Plugin

Returns:
String the IPath string value to retrieve the diagram.graphconf file

getUniqueModelObjectConfList

java.util.List<ModelObjectConfiguration> getUniqueModelObjectConfList(boolean nodeFilter,
                                                                      boolean edgeFilter)
Get the list of all the model objects that are referenced by Parts.

Parameters:
nodeFilter - Specify whether the NodePartConfiguration should be included
edgeFilter - Specify whether the EdgePartConfiguration should be included
Returns:
the list of Unique ModelObjectConfiguration that are referenced among the different Parts of the Diagram

getUniqueModelObjectConfListFromPalette

java.util.List<ModelObjectConfiguration> getUniqueModelObjectConfListFromPalette(boolean nodeFilter,
                                                                                 boolean edgeFilter)
Get the list of all the model objects referenced by the different PaletteItem of the PaletteConfiguration.

Parameters:
nodeFilter - Specify whether the NodePartConfiguration should be included
edgeFilter - Specify whether the EdgePartConfiguration should be included
Returns:
the list of Unique ModelObjectConfiguration that are referenced among the different PaletteItem of the PaletteConfiguration of the Diagram.

getDefaultBackgroundColorStringValue

java.lang.String getDefaultBackgroundColorStringValue()
Get the String value representing the DefaultBackgroundColor


getDefaultForegroundColorStringValue

java.lang.String getDefaultForegroundColorStringValue()
Get the String value representing the DefaultForegroundColor


getDefaultFontStringValue

java.lang.String getDefaultFontStringValue()
Get the String value representing the DefaultFont


getPartActions

java.util.List<PartAction> getPartActions()
Get the list of all the actions that are defined in the PartConfiguration elements of this DiagramConfiguration

Returns:
the list of PartActions defined in this Diagram

Generators

Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.