File	Doc	Category	Size	Date	Package
UMLModel.java	API Doc	Example	7979	Tue Dec 08 01:21:00 GMT 1998	oisoft.togetherx.scriptapi.UML

UMLModel

Fields Summary

Constructors Summary

Methods Summary
public UMLPackage	getCurrentPackage() Returns the current package. Current package is the package of the diagram, which has the focus at the moment when the method has been called. return Interface to the current package see UMLPackage
public UMLPackage	getDiagramByName(java.lang.String name) Returns diagram by name. The name must be a fully qualified name in terms of Together/J, how it is returned by, e.g., the UMLElement.#getQualifiedName() method. param name Full qualified name of the diagram return Interface to the diagram see UMLElement#getQualifiedName see UMLPackage
public UMLElement	getElementByName(java.lang.String name) Returns element by name. This covers any element in any diagram. The name must be a fully qualified name in terms of Together/J, how it is returned by, e.g., the UMLElement.#getQualifiedName() method. param name Full qualified name of the element return Interace to the diagram see UMLElement#getQualifiedName
public UMLNode	getNodeByName(java.lang.String name) Returns node by name. The name must be a fully qualified name in terms of Together/J, how it is returned by, e.g., the UMLElement.#getQualifiedName() method. param name Full qualified name of the node return Interface to the node see UMLElement#getQualifiedName see UMLNode
public UMLNode	getNodeByName(java.lang.String name, UMLNode context) Returns node by name. The name may be short or fully qualified If the name is short then context is used for its search UMLElement.#getQualifiedName() method. param name Full qualified name of the node param context Context class return Interface to the node see UMLElement#getQualifiedName see UMLNode
public UMLNode	getNodeByType(UMLType type) Returns node by type. The type is returned by, e.g., the UMLMember.#getType() method. param name Full qualified name of the node return Interface to the node see UMLMember#getType see UMLNode
public java.io.File	getProjectFile() Returns File for project file. There can be only one project opened. return File object of the project file
public java.lang.String	getRelativePath(java.lang.String fullPath) Convert path to path relative to the project. param fullPath Path to be converted return Path relative to the project file path
public UMLPackage	getRootPackage() Returns the root (top-level) package of the whole model. return Interface to the top-level package see UMLPackage
public boolean	isIncludeLinkAttribute() Returns the value of "Include Link-Attribute" mode. return true - Attributes-as-Links are included in attributes false - Attributes-as-Links are excluded from attributes. see UMLClassifier#getAttributes see UMLModel#setIncludeLinkAttribute
public boolean	isIncludeModelOnly() Returns the value of "Include model only" mode. return true - only model's elements included; false - imported classes and logical packages also included. see UMLModel#setIncludeModelOnly
public boolean	isIncludePureLinkAttribute() Returns the value of "Include Pure Link-Attribute" mode. return true - Pure Links are included in attributes false - Pure Links are excluded from attributes. see UMLClassifier#getAttributes see UMLModel#setIncludeLinkAttribute since 354
public boolean	isIncludeVisibleOnly() Returns the value of "Include visible only" mode. return true - only visible elements included; false - hidden elements also included. see UMLModel#setIncludeVisibleOnly
public void	setIncludeLinkAttribute(boolean includeLinkAttribute) This method controls the mode of including attributes those are also links into the list of attributes. True says to include attributes-as-links in any iteration of attributes. False says to NOT include them. The attributes mentioned here are extracted by iterative methods of UMLClassifier interface and its subclasses. By default, the Include Link-Attribute mode is set to false. param includeLinkAttribute sets the mode see UMLClassifier#getAttributes see UMLModel#isIncludeLinkAttribute
public void	setIncludeModelOnly(boolean includeModelOnly) This method controls the mode of including other elements into the model. True says to include only "model's" elements (that is defined in the model); False says to include additionally imported classes and logical package diagrams. The elements mentioned here are extracted by iterative methods of UMLPackage interface and its subclasses. By default, the Include Model Only mode is set to false. param includeModelOnly sets the mode see UMLModel#isIncludeModelOnly
public void	setIncludePureLinkAttribute(boolean includePureLinkAttribute) This method controls the mode of including design comments those are used to create links into the list of attributes. True says to include pure links (comment-as-links) into any iteration of attributes. False says to NOT include them. The attributes mentioned here are extracted by iterative methods of UMLClassifier interface and its subclasses. By default, the Include Pure Link-Attribute mode is set to false. param includePureLinkAttribute sets the mode see UMLClassifier#getAttributes see UMLModel#isIncludeLinkAttribute since 354
public void	setIncludeVisibleOnly(boolean includeVisibleOnly) This method controls the mode of including hidden elements into the model. True says to include only visible elements; False says to include additionally hidden elements (which can be hidden explicitly by the 'Hide' command or implicitly by filters on the "Display" tab of diagrams. The elements mentioned here are extracted by iterative methods of UMLPackage interface and its subclasses. By default, the Include Visible Only mode is set to true. param includeVisibleOnly sets the mode see UMLModel#isIncludeVisibleOnly
public void	updateDiagrams() Use this method when you change something and wish to update diagrams from the source code.
public void	updateFileBuffers() Use this method when you change something and wish to reload the changed source code.