Astah API

https://members.change-vision.com/javadoc/astah-api/10_1_0/
Admin
Astah API provides an interface for programmatic interaction with Astah, a UML modeling tool,...
Tokens:526,529
Snippets:1,727
Trust Score:7.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get SystemPropertyAccessor (No ClassLoader)

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/system/SystemPropertyAccessorFactory

Creates a SystemPropertyAccessor. Only one instance can be created. This method is deprecated and may throw ClassNotFoundException if the class path is invalid.

```java
public static SystemPropertyAccessor getSystemPropertyAccessor()

Returns:
    SystemPropertyAccessor

Throws:
     ClassNotFoundException - Invalid Class Path
```

--------------------------------

### Get SystemPropertyAccessor (With ClassLoader)

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/system/SystemPropertyAccessorFactory

Creates a SystemPropertyAccessor using a specified ClassLoader. Only one instance can be created. This method is deprecated and may throw ClassNotFoundException if the class path is invalid.

```java
public static SystemPropertyAccessor getSystemPropertyAccessor(ClassLoader classLoader)

Parameters:
     classLoader - ClassLoader

Returns:
    SystemPropertyAccessor

Throws:
     ClassNotFoundException - Invalid Class Path
```

--------------------------------

### IConstraint Interface Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IConstraint

Provides details on the methods available for the IConstraint interface, including getting and setting specifications and retrieving constrained elements.

```APIDOC
IConstraint Interface Documentation:

Inherited Fields from INamedElement:
- PACKAGE_VISIBILITY
- PRIVATE_VISIBILITY
- PROTECTED_VISIBILITY
- PUBLIC_VISIBILITY

Method Summary:

IElement[] getConstrainedElement()
  - Description: Get the constrained elements.
  - Returns: An array of IElement objects that are constrained by this constraint.

String getSpecification()
  - Description: Get Specification.
  - Returns: The specification string of the constraint.

void setSpecification(String specification)
  - Description: Set Specification.
  - Parameters:
    - specification: The new specification string for the constraint.
```

--------------------------------

### Entity Access and Project Information

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectAccessor

Provides methods to retrieve entities by their ID, get the Astah installation path, and check project modification status.

```APIDOC
getEntity(String id)
  - Returns the IEntity with the specified ID.
  - Searches model and diagram elements in currently open projects.
  - Returns null if no project is open or the entity is not found.
  - Parameters:
    - id: The ID string of the IEntity to search for.
  - Returns: The found IEntity object.

getAstahInstallPath()
  - Obtains the installation path of the astah* application.
  - Returns: The installation path as a String.
  - Since: 6.6.4

isProjectModified()
  - Checks if the current project has been modified.
  - Returns: true if the project is modified, false otherwise.
  - Since: 6.6.4

hasSameElement(String name)
  - Checks if an element with the given name exists in the project.
  - Parameters:
    - name: The name of the element to check.
  - Returns: True if an element with the same name exists, false otherwise.
  - Since: 6.7.0

hasSameElement(String name, Class<?> type)
  - Checks if an element with the given name and type exists in the project.
  - Parameters:
    - name: The name of the element to check.
    - type: The Class of the element to check.
  - Returns: True if an element with the same name and type exists, false otherwise.
  - Since: 6.7.0
```

--------------------------------

### SystemPropertyAccessorFactory Constructors and Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/system/SystemPropertyAccessorFactory

Details the constructors and methods available for the SystemPropertyAccessorFactory class. This includes information on how to access and utilize system properties within the astah-api.

```APIDOC
SystemPropertyAccessorFactory:
  __init__()
    Constructs a new SystemPropertyAccessorFactory.

  getSystemPropertyAccessor()
    Returns the SystemPropertyAccessor instance.
    Returns: SystemPropertyAccessor - the system property accessor.
```

--------------------------------

### Astah API IERPackage Entity Retrieval

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IERPackage

This API documentation details methods for retrieving entities from an IERPackage in the Astah API. It includes functions to get all entities, including those in sub-packages, and to get entities directly within the package.

```APIDOC
IEREntity[] getAllEntities()
  - Returns all entities, including those belonging to sub-packages.

IEREntity[] getEntities()
  - Returns entities directly within the package.
```

--------------------------------

### SystemPropertyAccessorFactory Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/system/SystemPropertyAccessorFactory

Provides methods to create SystemPropertyAccessor instances. Both methods are deprecated.

```APIDOC
SystemPropertyAccessorFactory:
  getSystemPropertyAccessor()
    Returns: SystemPropertyAccessor
    Description: Creates SystemPropertyAccessor.
    Deprecated: true

  getSystemPropertyAccessor(ClassLoader classLoader)
    Parameters:
      classLoader: The ClassLoader to use.
    Returns: SystemPropertyAccessor
    Description: Creates SytemPropertyAccessor.
    Deprecated: true
```

--------------------------------

### Astah API: Diagram and Element Properties

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IDiagram

Provides methods to get and set properties for diagrams and elements within the Astah API. Includes retrieving all properties, getting a specific property by key, and setting properties individually or in bulk.

```APIDOC
IDiagram.getProperties()
  Returns: HashMap - All properties of the diagram.

IDiagram.getProperty(String key)
  Parameters:
    key: String - The key of the property to retrieve.
  Returns: String - The value of the specified property.

IDiagram.setProperty(String key, String value)
  Parameters:
    key: String - The key of the property to set.
    value: String - The value of the property to set.
  Throws:
    InvalidEditingException - If an error occurs during editing, such as using the API in the community version, invalid parameters, bad transactions, exceptions, or editing read-only elements.

IDiagram.setProperties(Map map)
  Parameters:
    map: Map - A map containing properties to set.
  Throws:
    InvalidEditingException - If an error occurs during editing, similar to setProperty.
```

--------------------------------

### SystemPropertyAccessorFactory Constructor

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/system/SystemPropertyAccessorFactory

Creates an instance of SystemPropertyAccessorFactory. This constructor is deprecated.

```java
public SystemPropertyAccessorFactory()
```

--------------------------------

### Icon Notation Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the icon notation for diagram elements.

```Java
static final String NOTATION_TYPE;
// This is a key to get or set the icon notation.
```

--------------------------------

### Astah API: Element Type Modifier

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IElement

Methods for getting and setting the type modifier of an element.

```APIDOC
IElement:
  getTypeModifier()
    Gets the type modifier of the element.
    Returns:
      String: The type modifier.

  setTypeModifier(String typeModifier)
    Sets the type modifier of the element.
    Parameters:
      typeModifier: The new type modifier.
```

--------------------------------

### IOutputPin Interface Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IOutputPin

Provides documentation for the IOutputPin interface, detailing its inheritance and purpose within the astah API.

```APIDOC
Interface IOutputPin

All Superinterfaces:
     IActivityNode, IElement, IEntity, IHyperlinkOwner, INamedElement, IObjectNode, IPin

* * *
public interface IOutputPin extends IPin
Interface for OutputPins. 

Since:
    6.6
  * ## Field Summary
  * ## Method Summary
```

--------------------------------

### Operation Compartment Visibility Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the visibility of an Operation compartment in a Class.

```Java
static final String OPERATION_COMPARTMENT_VISIBILITY;
// This is a key to get or set the visibility of an Operation compartment in a Class.
```

--------------------------------

### IPluginModelTab API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/ui/IPluginModelTab

Documentation for the IPluginModelTab interface methods.

```APIDOC
IPluginModelTab:
  initialize()
    Called when the tab is initialized by the application.

  update()
    Called when the model is modified.
```

--------------------------------

### Freehand Line Opacity Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the alpha (opacity) of a Freehand line.

```Java
static final String OPACITY;
// This is a key to get or set the alpha of the Freehand line.
```

--------------------------------

### IStateMachineDiagram Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IStateMachineDiagram

Methods specific to the IStateMachineDiagram interface, including getting the associated state machine.

```Java
IStateMachine getStateMachine()
Get StateMachine.
```

--------------------------------

### IPluginModelTab API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/ui/IPluginModelTab

This section details the methods available in the IPluginModelTab interface for plugin development in astah. It covers setting and retrieving models, initializing the tab panel, and updating the tab's display.

```APIDOC
Interface IPluginModelTab

Delegated interface to add the property tab to show selecting model by Plug-in.

Nested Classes:
  IPluginModelTab.Stub: The stub implementation of IPluginModelTab.

Methods:
  void setModel(Object model)
    Description: This method is called when model is selected.
    Parameters:
      model: Selected model

  Object getModel()
    Description: Get the model which is shown in this view.
    Returns:
      model: Selected model

  List<?> getModelParameters()
    Description: Provide in the future (internal use only).

  String getTabName()
    Description: Implement to show the name of the tab.
    Returns:
      tabName: the name of the tab

  void initPanel()
    Description: This method is called when the tab is initialized by the application.

  void update()
    Description: This method is called when the model is modified.
```

--------------------------------

### Get StateMachine - astah-api

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IStateMachineDiagram

Retrieves the StateMachine associated with an element. This method is part of the IStateMachine interface.

```Java
/**
 * Get StateMachine.
 * 
 * @return StateMachine.
 */
public IStateMachine getStateMachine();
```

--------------------------------

### IPluginExtraView API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/ui/IPluginExtraView

Provides API documentation for the IPluginExtraView interface, including its constructor.

```APIDOC
IPluginExtraView:
  __init__()
    Deprecated.
```

--------------------------------

### Get Comment Body (astah-api)

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IComment

Retrieves the body content of a comment. This method is part of the IComment interface.

```Java
/**
 * Get Body.
 *
 * @return Comment body
 */
String getBody()
```

--------------------------------

### ProjectEventListener API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectEventListener

This section details the methods available in the ProjectEventListener interface for handling project lifecycle events. It includes method signatures, parameter descriptions, and the purpose of each method.

```APIDOC
ProjectEventListener:
  Description: Project event listener.

  Methods:
    projectOpened(ProjectEvent e)
      Description: Project is Opened.
      Parameters:
        e: ProjectEvent - The event object containing project information.

    projectClosed(ProjectEvent e)
      Description: Project is Closed.
      Parameters:
        e: ProjectEvent - The event object containing project information.

    projectChanged(ProjectEvent e)
      Description: Project is changed.
      Parameters:
        e: ProjectEvent - The event object containing project information.
```

--------------------------------

### Astah Project Accessor API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectAccessor

Provides documentation for key methods within the Astah Project Accessor, including XMI import/export and project opening.

```APIDOC
ProjectAccessor:
  importXMI(projectName: String, isIgnoreModelVersion: boolean)
    Opens an astah* Project's XMI.
    Parameters:
      projectName: The name of the project to import.
      isIgnoreModelVersion: A boolean flag to ignore model version checks.
    Throws:
      LicenseNotFoundException: If the license cannot be found.
      ProjectNotFoundException: If the project cannot be found.
      NonCompatibleException: If the API version is older than the project's last edited version.
      ClassNotFoundException: If some models cannot be read.
      IOException: If an input/output error occurs.
      InvalidUsingException: If the community version and UML version cannot use the XMI API.

  exportXMI(fileName: String)
    Saves the astah* Project as the specified XMI file name.
    Parameters:
      fileName: The name of the file to save.
    Throws:
      LicenseNotFoundException: If the license cannot be found.
      ProjectNotFoundException: If the project cannot be found.
      IOException: If an input/output error occurs.
      InvalidUsingException: If the community version and UML version cannot use the XMI API.

  open(in: InputStream)
    Opens an astah* Project from an InputStream.
    Parameters:
      in: The InputStream to read the project from.
    Throws:
      (Specific exceptions not detailed in the provided text for this method, but likely similar to importXMI)
```

--------------------------------

### LicenseNotFoundException Constructor

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/exception/LicenseNotFoundException

The default constructor for the LicenseNotFoundException class. It is used when a valid license for API execution is not installed.

```Java
LicenseNotFoundException()
  * A valid license for API execution is not installed.
```

--------------------------------

### SystemPropertyAccessorFactory Constructor

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/system/SystemPropertyAccessorFactory

The SystemPropertyAccessorFactory class constructor. This method is deprecated.

```java
public SystemPropertyAccessorFactory()
```

--------------------------------

### Operation Constraint Visibility Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the visibility of an Operation constraint in a Class or a Subsystem.

```Java
static final String OPERATION_CONSTRAINT_VISIBILITY;
// This is a key to get or set the visibility of an Operation constraint in a Class or a Subsystem.
```

--------------------------------

### IPluginTabView API Reference

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/ui/IPluginTabView

API documentation for the IPluginTabView interface, outlining methods for managing plugin tab views in Astah.

```APIDOC
IPluginTabView:
  getSelectedModels(): Object[]
    Description: Implement to get the selected models in the tab.
    Returns: The selected models in the tab.

  initTreeModel(): void
    Description: This method is called when the tab is initialized by the application.

  addSelectionListener(ISelectionListener listener): void
    Description: This method is called by the application to add a listener to know what is selected in the tab.
    Parameters:
      listener: The listener to be added.
```

--------------------------------

### Operation Stereotype Visibility Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the visibility of an Operation Stereotype in a Class or a Subsystem.

```Java
static final String OPERATION_STEREOTYPE_VISIBILITY;
// This is a key to get or set the visibility of an Operation Stereotype in a Class or a Subsystem.
```

--------------------------------

### IPort Interface - Method Summary

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IPort

Provides a summary of methods available for the IPort interface. This section links to the detailed method information.

```APIDOC
IPort Interface:
  Method Summary:
    - Links to detailed method information for the IPort interface.
```

--------------------------------

### Null Option Visibility Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the visibility of a Null option in an ER Entity.

```Java
static final String NULL_OPTION_VISIBILITY;
// This is a key to get or set the visibility of a Null option in an ER Entity.
```

--------------------------------

### astah-api 10.1.0 Javadoc Navigation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IEntity

Provides navigation links for the astah-api Javadoc, specifically for the com.change_vision.jude.api.inf.model package. Includes links to overview, package summary, class details, tree structure, deprecated methods, index, and help.

```APIDOC
Project: /websites/members_change-vision_javadoc_astah-api_10_1_0

Navigation:
- Skip navigation links
- Diagram
  - Overview
  - Package
  - Class
  - Tree
  - Deprecated
  - Index
  - Help

Package: com.change_vision.jude.api.inf.model

Search: SEARCH
```

--------------------------------

### Get State Machine Diagram - Astah API

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IStateMachine

Retrieves the StateMachineDiagram object associated with the state machine.

```APIDOC
IStateMachineDiagram getStateMachineDiagram()
  Get StateMachine Diagram.

  Returns:
      StateMachine Diagram.
```

--------------------------------

### PresentationPropertyUtil API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyUtil

API documentation for the PresentationPropertyUtil class, detailing methods for creating keys related to guard conditions and operands in CombinedFragments.

```APIDOC
PresentationPropertyUtil:
  __init__()
    Constructor for PresentationPropertyUtil.

  createGuardXKey(index: int) -> String
    Create a key to get or set the X coordinate of a guard condition in a CombinedFragment.
    Parameters:
      index: index of a guard condition
    Returns:
      Key to get or set the X coordinate of a guard condition in a CombinedFragment.
    Since:
      6.8.0

  createGuardYKey(index: int) -> String
    Create a key to get or set the Y coordinate of a guard condition in a CombinedFragment.
    Parameters:
      index: index of a guard condition
    Returns:
      Key to get or set the Y coordinate of a guard condition in a CombinedFragment.
    Since:
      6.8.0

  createOperandLengthKey(index: int) -> String
    Create a key to get or set the length of an Operand in a CombinedFragment.
    Parameters:
      index: index of an Operand
    Returns:
      Key to get or set the length of an Operand in a CombinedFragment.
```

--------------------------------

### IMultiplicityRange Method Details

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IMultiplicityRange

Details the methods for getting and setting multiplicity range bounds, including parameters and exceptions.

```APIDOC
Method Details:

getLower():
int getLower()
Get Lower.
Returns: Lower

getUpper():
int getUpper()
Get Upper
Returns: Upper

setLower(int lower):
void setLower(int lower)
Set Lower
Parameters:
  lower: Lower
Throws:
  InvalidEditingException - InvalidEditingException occurs.
    Keys:
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
      PARAMETER_ERROR_KEY - if a parameter is not set properly.
      READ_ONLY_KEY - if a read-only element is edited.
    Values:
      Error messages for exceptions.

setUpper(int upper):
void setUpper(int upper)
Set Upper
Parameters:
  upper: Upper
Throws:
  InvalidEditingException - InvalidEditingException occurs.
    Keys:
      ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
      PARAMETER_ERROR_KEY - if a parameter is not set properly.
      READ_ONLY_KEY - if a read-only element is edited.
    Values:
      Error messages for exceptions.
```

--------------------------------

### Operation Parameter Visibility Key

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the visibility of an Operation parameter in a Class, a Message, or a Subsystem.

```Java
static final String OPERATION_PARAMETER_VISIBILITY;
// This is a key to get or set the visibility of an Operation parameter in a Class, a Message or a Subsystem.
```

--------------------------------

### ProjectAccessor API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectAccessorFactory

API documentation for the ProjectAccessor interface, detailing its creation, parameters, return values, and exceptions.

```APIDOC
ProjectAccessor:
  __init__(classLoader: ClassLoader)
    Parameters:
      classLoader: ClassLoader - The ClassLoader to use for creating the ProjectAccessor.
    Returns:
      ProjectAccessor - An instance of ProjectAccessor.
    Throws:
      ClassNotFoundException - If the ClassLoader is invalid or cannot load necessary classes.
    Notes:
      - This method is deprecated.
      - Only one ProjectAccessor can be created per application instance.
      - Operations are limited to a single project at a time.
```

--------------------------------

### IPartition Interface Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IPartition

Documentation for the IPartition interface, detailing its inheritance and purpose within the astah-api. It extends INamedElement and is used to represent partitions in diagrams.

```APIDOC
Interface IPartition 

All Superinterfaces:
     IElement, IEntity, IHyperlinkOwner, INamedElement

public interface IPartition extends INamedElement
Interface for Partition.
  * ## Field Summary 
  * ## Method Summary 
  * ## Method Detail
```

--------------------------------

### Instance Specification Slot Visibility

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/presentation/PresentationPropertyConstants

Key to get or set the visibility of a slot without values in an Instance Specification.

```Java
static final String INSTANCE_SLOT_VISIBILITY;
// This is a key to get or set the visibility of a slot without values in an InstanceSpecification.
```

--------------------------------

### IVertex Inherited Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IState

Methods inherited from the IVertex interface, including getting incoming and outgoing elements.

```APIDOC
getIncomings()
getOutgoings()
```

--------------------------------

### IWindow Interface Methods - astah-api

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/ui/IWindow

Documentation for the IWindow interface, which provides methods to get the main window and its parameters. These methods are intended for use within plugins to interact with the astah application's UI.

```APIDOC
Interface IWindow

Interface to get UI object from the application for Plug-in.

Methods:

getParameters
Map getParameters()
  Provide in the future(internal use only)

getParent
Window getParent()
  Get main window
  Returns: Main Window
```

--------------------------------

### ProjectAccessor API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectAccessor

API documentation for the ProjectAccessor interface, including methods for project status, element comparison, XMI import, project modification checks, project opening, and listener management.

```APIDOC
ProjectAccessor:
  hasProject()
    Returns: boolean
    Description: Get whether a project is open or not.

  hasSameElement(String name)
    Parameters:
      - name: String
    Returns: boolean
    Description: Checks if a project has an element with the specified name.

  hasSameElement(String name, Class clazz)
    Parameters:
      - name: String
      - clazz: Class
    Returns: boolean
    Description: Checks if a project has an element with the specified name and class.

  importXMI(String projectName)
    Parameters:
      - projectName: String
    Returns: void
    Description: Opens a project's XMI file by its name.

  importXMI(String projectName, boolean isIgnoreModelVersion)
    Parameters:
      - projectName: String
      - isIgnoreModelVersion: boolean
    Returns: void
    Description: Opens a project's XMI file, optionally ignoring model version.

  isProjectModified()
    Returns: boolean
    Description: Checks if the current project has been modified.

  open(InputStream in)
    Parameters:
      - in: InputStream
    Returns: void
    Description: Opens an astah* Project from an InputStream.

  open(InputStream in, boolean isIgnoreModelVersion)
    Parameters:
      - in: InputStream
      - isIgnoreModelVersion: boolean
    Returns: void
    Description: Opens an astah* Project from an InputStream, optionally ignoring model version.

  open(String projectName)
    Parameters:
      - projectName: String
    Returns: void
    Description: Opens an astah* Project by its name.

  open(String projectName, boolean isIgnoreModelVersion)
    Parameters:
      - projectName: String
      - isIgnoreModelVersion: boolean
    Returns: void
    Description: Opens an astah* Project by its name, optionally ignoring model version.

  open(String projectName, boolean isIgnoreModelVersion, boolean lockMode, boolean allowReadOnly)
    Parameters:
      - projectName: String
      - isIgnoreModelVersion: boolean
      - lockMode: boolean
      - allowReadOnly: boolean
    Returns: void
    Description: Opens an astah* Project with specified parameters including lock mode and read-only status.

  removeEntityEditListener(EntityEditListener listener)
    Parameters:
      - listener: EntityEditListener
    Returns: void
    Description: Removes an EntityEditListener.

  removeProjectEventListener(ProjectEventListener listener)
    Parameters:
      - listener: ProjectEventListener
    Returns: void
    Description: Removes a ProjectEventListener.
```

--------------------------------

### Astah API: IActivityNode Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IFlow

Provides methods to get the source and target ActivityNodes associated with an activity flow.

```APIDOC
IActivityNode getSource()
  Get ActivityNode as Source.
  Returns: ActivityNode.

IActivityNode getTarget()
  Get ActivityNode as Target.
  Returns: ActivityNode.
```

--------------------------------

### Astah Project Creation Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectAccessor

Provides methods for creating Astah projects with different configurations, including specifying project paths, template paths, and whether to use user-defined tagged values. Some methods may throw IOException or ProjectNotFoundException.

```APIDOC
ProjectAccessor:
  create(String projectPath)
    Creates an Astah project at the specified path without loading user-defined tagged values.
    Parameters:
      projectPath: The path where the project will be created.
    Throws:
      IOException: If an input/output error occurs.

  create()
    Creates an Astah project without loading user-defined tagged values. The project path must be specified later using saveAs().
    Throws:
      IOException: If an input/output error occurs.
    Since: 6.6

  create(String projectPath, String templatePath, boolean useDefinedTaggedValues)
    Creates an Astah project using a specified template and optionally loads user-defined tagged values.
    Parameters:
      projectPath: The path where the project will be created.
      templatePath: The path to the template file.
      useDefinedTaggedValues: If true, loads user-defined tagged values during project creation.
    Throws:
      IOException: If an input/output error occurs.
      ProjectNotFoundException: If the specified template project cannot be found.

  create(String projectPath, String templatePath)
    Creates an Astah project using a specified template without loading user-defined tagged values.
    Parameters:
      projectPath: The path where the project will be created.
      templatePath: The path to the template file.
    Throws:
      IOException: If an input/output error occurs.
      ProjectNotFoundException: If the specified template project cannot be found.
```

--------------------------------

### Get Activity from IActivity

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IActivityDiagram

Retrieves the Activity object associated with the current context. This method is part of the IActivity interface.

```Java
/**
 * Get Activity.
 * @return Activity.
 */
IActivity getActivity();
```

--------------------------------

### Get Icon Type - astah-api

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/view/IconDescription

Retrieves the Icon Type associated with an object. This method is part of the IconType interface in the astah-api.

```Java
/**
 * Get Icon Type.
 *
 * @return Icon Type
 */
public IconType getType()
```

--------------------------------

### Astah API IPartition Methods

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IPartition

Provides documentation for various methods of the IPartition interface in the Astah API. These methods allow retrieval of parent and child partitions, associated activity nodes, partition orientation, and neighboring partitions.

```APIDOC
IPartition:
  getSuperPartition()
    Returns the parent partition. Returns null if there is none.

  getSubPartitions()
    Returns an array of child partitions. Returns an empty array if there are none.

  getActivityNodes()
    Returns an array of associated activity nodes. Returns an empty array if there are none.

  isHorizontal()
    Checks if the partition's direction is horizontal.
    Returns: true if horizontal, false if vertical.

  getPreviousPartition()
    Gets the partition to the left (if horizontal) or above (if vertical). Returns null if none exists.

  getNextPartition()
    Gets the partition to the right (if horizontal) or below (if vertical). Returns null if none exists.
```

--------------------------------

### IState Methods - Region Information

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IState

Methods to get the size of regions and the rectangle of a specified region within a state.

```APIDOC
getRegionSize()
  - Returns: The size of regions.

getRegionRectangle(int regionIndex)
  - Parameters:
    - regionIndex: The index of the region.
  - Returns: The Rectangle of the specified region.
  - Throws:
    - InvalidUsingException: If regionIndex is out of range.
```

--------------------------------

### ProjectAccessor API Documentation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/project/ProjectAccessor

Provides comprehensive documentation for the ProjectAccessor interface, covering its fields and methods for project manipulation and event handling in the astah* API.

```APIDOC
ProjectAccessor:
  Interface to Operate astah* project.

  Fields:
    REFERENCE_PROJECT_STATUS_LATEST: int
      Represents the latest status of a reference project.
    REFERENCE_PROJECT_STATUS_NEED_UPDATE: int
      Indicates that a reference project needs an update.
    REFERENCE_PROJECT_STATUS_NOT_FOUND: int
      Signifies that a reference project was not found.

  Methods:
    addEntityEditListener(EntityEditListener listener)
      Adds an EntityEditListener to the project accessor.
      Parameters:
        listener: The EntityEditListener to add.

    addProjectEventListener(ProjectEventListener listener)
      Adds a ProjectEventListener to the project accessor.
      Parameters:
        listener: The ProjectEventListener to add.

    addReferenceProject(String path)
      Adds a Reference Project in astah* Project.
      Parameters:
        path: The file path of the reference project to add.

    changeReferenceProject(String fromPath, String toPath)
      Changes the path of a Reference Project in astah* Project.
      Parameters:
        fromPath: The current file path of the reference project.
        toPath: The new file path for the reference project.

    clearReferenceProject(String path)
      Clears a Reference Project in astah* Project.
      Parameters:
        path: The file path of the reference project to clear.

    close()
      Closes the astah* Project.

    create()
      Creates an Astah project without loading user-defined tagged values.

    create(String projectPath)
      Creates an astah* Project without loading user-defined tagged values.
      Parameters:
        projectPath: The file path where the project will be created.

    create(String projectPath, boolean useDefinedTaggedValues)
      Creates an astah* Project.
      Parameters:
        projectPath: The file path where the project will be created.
        useDefinedTaggedValues: A boolean indicating whether to use defined tagged values.
```

--------------------------------

### Get Vertices - Astah API

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IStateMachine

Retrieves an array of Vertex objects from the model. Returns an empty array if no vertices are found.

```APIDOC
IVertex[] getVertexes()
  Get Vertexes.

  Returns:
      The array of Vertexes. Return the empty array if there is none.
```

--------------------------------

### astah-api Javadoc Navigation

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/ui/IPluginModelTab

Provides navigation links for the astah-api Javadoc, allowing users to browse through different sections of the documentation including overview, package summaries, class details, and search functionality.

```APIDOC
Project: /websites/members_change-vision_javadoc_astah-api_10_1_0

Navigation:
  - Skip navigation links
  - Diagram Index
  - Overview
  - Package Summary (com.change_vision.jude.api.inf.ui)
  - Class Details
  - Tree (Package Hierarchy)
  - Deprecated List
  - Index (All Classes)
  - Help

Sections within Package/Class:
  - Summary:
    - Nested Classes
    - Fields
    - Constructors
    - Methods
  - Detail:
    - Fields
    - Constructors
    - Methods

Search Functionality: [SEARCH](https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/search.html)
```

--------------------------------

### Get Owned Elements - INamedElement Interface

Source: https://members.change-vision.com/javadoc/astah-api/10_1_0/api/en/doc/javadoc/com/change_vision/jude/api/inf/model/IPackage

Retrieves all elements owned by this INamedElement. This method is part of the INamedElement interface in the Astah API.

```APIDOC
INamedElement:
  getOwnedElements() : INamedElement[]
    Description: Get owned elements.
    Returns: the array of the owned elements. Return the empty array if there is none.
    See Also: com.change_vision.jude.api.inf.model
```
Tokens:
Raw