com.change_vision.jude.api.inf.editor
Interface InternalBlockDiagramEditor

com.change_vision.jude.api.inf.editor.InternalBlockDiagramEditor
All Superinterfaces:
BasicDiagramEditor, DiagramEditor
All Implemented Interfaces:
BasicDiagramEditor, DiagramEditor

public InternalBlockDiagramEditor
extends BasicDiagramEditor

Interface to edit (create/delete) CompositeStructure diagrams.


Method Summary
abstract  IInternalBlockDiagram createInternalBlockDiagram(IBlock owner, String name)
          Create a Internal Block Diagram in a parent block.
abstract  IInternalBlockDiagram createInternalBlockDiagram(IInterfaceBlock owner, String name)
          Create a Internal Block Diagram in a interface block.
abstract  ILinkPresentation createLinkPresentation(IElement model, INodePresentation linkEnd0, INodePresentation linkEnd1)
          Create a ILinkPresentation.
abstract  INodePresentation createNodePresentation(IElement model, Point2D location)
          Create a INodePresentation.
abstract  INodePresentation createNodePresentation(IElement model, INodePresentation container, Point2D location)
          Create a INodePresentation.
abstract  INodePresentation createProvidedInterfacePresentation(INodePresentation endPresentation, Point2D location)
          Create a provided interface for a port.
abstract  INodePresentation createRequiredInterfacePresentation(INodePresentation endPresentation, Point2D location)
          Create a required interface for a port.
 
Methods inherited from class com.change_vision.jude.api.inf.editor.BasicDiagramEditor
createNote, createNoteAnchor, createNoteAnchor, createProblemNote, createRationaleNote
 
Methods inherited from class com.change_vision.jude.api.inf.editor.DiagramEditor
createImage, createLine, createRect, createText, delete, deleteDiagram, deletePresentation, getDiagram, setDiagram
 

Method Detail

createInternalBlockDiagram

abstract IInternalBlockDiagram createInternalBlockDiagram(IBlock owner,
                                                          String name)
Create a Internal Block Diagram in a parent block. Diagram is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the diagram is created successfully. Parts and connectors,ports are created in default on the diagram if parts are held by the owner.

Parameters:
owner - Parent Package
name - name
Returns:
Internal Block Diagram
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      NAME_DOUBLE_ERROR_KEY - An element with the same name already exists. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values: 
      Error messages for exceptions.

createInternalBlockDiagram

abstract IInternalBlockDiagram createInternalBlockDiagram(IInterfaceBlock owner,
                                                          String name)
Create a Internal Block Diagram in a interface block. Diagram is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the diagram is created successfully. Parts and connectors,ports are created in default on the diagram if parts are held by the owner.

Parameters:
owner - Parent Package
name - name
Returns:
Internal Block Diagram
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      NAME_DOUBLE_ERROR_KEY - An element with the same name already exists. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred.
Values: 
      Error messages for exceptions.

createNodePresentation

abstract INodePresentation createNodePresentation(IElement model,
                                                  Point2D location)
Create a INodePresentation.

Parameters:
model - model
location - location
Returns:
INodePresentation.
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      NAME_DOUBLE_ERROR_KEY - An element with the same name already exists. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.
Values: 
      Error messages for exceptions.

createNodePresentation

abstract INodePresentation createNodePresentation(IElement model,
                                                  INodePresentation container,
                                                  Point2D location)
Create a INodePresentation.

Parameters:
model - model
container - Parent Part
location - location
Returns:
INodePresentation.
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      NAME_DOUBLE_ERROR_KEY - An element with the same name already exists. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.
Values: 
      Error messages for exceptions.

createProvidedInterfacePresentation

abstract INodePresentation createProvidedInterfacePresentation(INodePresentation endPresentation,
                                                               Point2D location)
Create a provided interface for a port.

Parameters:
endPresentation - port presentation
location - the position of the provided interface
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.
Values: 
      Error messages for exceptions.

createRequiredInterfacePresentation

abstract INodePresentation createRequiredInterfacePresentation(INodePresentation endPresentation,
                                                               Point2D location)
Create a required interface for a port.

Parameters:
endPresentation - port presentation
location - the position of the provided interface
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.
Values: 
      Error messages for exceptions.

createLinkPresentation

abstract ILinkPresentation createLinkPresentation(IElement model,
                                                  INodePresentation linkEnd0,
                                                  INodePresentation linkEnd1)
Create a ILinkPresentation.

Parameters:
model - model
linkEnd0 - the presentation connected to one side of the link
linkEnd1 - the presentation connected to one side of the link
Returns:
ILinkPresentation.
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys: 
      PARAMETER_ERROR_KEY - if a parameter is not set properly. 
      ILLEGALMODELTYPE_ERROR_KEY - if the model type is illegal. 
      NO_NAME_ERROR_KEY - if the name is empty. 
      NAME_DOUBLE_ERROR_KEY - An element with the same name already exists. 
      BAD_TRANSACTION_KEY - Bad Transaction. 
      HAS_EXCEPTION_KEY - if an exception has occurred. 
      READ_ONLY_KEY - if a read-only element is edited.
Values: 
      Error messages for exceptions.