Poseidon for UMLTM
  UMLdoc
 PREV      NEXT       FRAMES    NO FRAMES      

com.gentleware.jboogie.openapi

Interface Target

com.gentleware.jboogie.openapi.Target

public interface Target


For documentation, please see the package.html or www.gentleware.com/support/developer.


 Inner Classifier Summary
public   Target.Memento
 
arrow_up
 

 Method Summary
public Diagram   getActiveDiagram()
The diagram that is visible in the main panel. 
public int   getDiCount()
 
public DiagramElement   getDiElement()
 
public DiagramElement   getDiElement(int i)
 
public List   getDiElements()
 
public RefObject   getFirstValidTargetElement()
 
public RefObject   getFocusedElement()
The single element that has keyboard focus. 
public Target.Memento   getMemento()
 
public Project   getProject()
 
public int   getSelectionCount()
 
public SingleTarget   getSingleTarget(int index)
 
public Object   getSmElement()
 
public int   getSmElementCount()
 
public List   getSmElements()
 
public Object   getSource()
 
public Diagram   getTargetedDiagram()
Used to be called getDiagram. 
public List   getTargetedDiagrams()
Used to be called getDiagrams. 
public boolean   isSingleSelection()
 
public boolean   isValid()
 
arrow_up
 

Tagged Values
static false
gentleware-imported-line-number 17
gentleware-imported-package-statement-line-number 5
 

 Inner Classifier Detail

Target.Memento

public  Target.Memento

arrow_up
 Method Detail

getActiveDiagram

public Diagram getActiveDiagram()


The diagram that is visible in the main panel.  
Returns:
The visible diagram, may be null.
arrow_up


getDiCount

public int getDiCount()

Returns:
The number of DI elements in the target.
arrow_up


getDiElement

public DiagramElement getDiElement()

Returns:
arrow_up


getDiElement

public DiagramElement getDiElement(int i)

Parameters:
i -
Returns:
arrow_up


getDiElements

public List getDiElements()

Returns:
The di elements that represent the target in the current diagram.
arrow_up


getFirstValidTargetElement

public RefObject getFirstValidTargetElement()

Returns:
the first element within this target that is still valid - e.g if we have a sm-element and a di-element, and the di-element gets removed while the sm-element remains constant, then return that sm-element
arrow_up


getFocusedElement

public RefObject getFocusedElement()


The single element that has keyboard focus. May be a Di or an Sm element. May be null.  
Returns:
arrow_up


getMemento

public Target.Memento getMemento()

Returns:
a representation of this target that is valid across undo/redo cycles
arrow_up


getProject

public Project getProject()

Returns:
arrow_up


getSelectionCount

public int getSelectionCount()

Returns:
arrow_up


getSingleTarget

public SingleTarget getSingleTarget(int index)

Parameters:
index -
Returns:
arrow_up


getSmElement

public Object getSmElement()

Returns:
null if this target does not contain a model element, else the first model element
arrow_up


getSmElementCount

public int getSmElementCount()

Returns:
The number of model elements in the target.
arrow_up


getSmElements

public List getSmElements()

Returns:
a list of all model elements in this target Beware: The collection does not include nulls. So the association to figs cannot be made by index.
arrow_up


getSource

public Object getSource()

Returns:
the source that caused this target to be created
arrow_up


getTargetedDiagram

public Diagram getTargetedDiagram()


Used to be called getDiagram. Not null only if the user has explicitly selected a diagram in the tree or clicked on an empty space in a diagram.  
Returns:
The diagram that the user selected, or null.
Since:
2.0
arrow_up


getTargetedDiagrams

public List getTargetedDiagrams()


Used to be called getDiagrams. Not empty only if the user has explicitly selected a diagram in the tree or clicked on an empty space in a diagram.  
Returns:
The diagram(s) that the user selected, or an empty list.
Since:
2.0
arrow_up


isSingleSelection

public boolean isSingleSelection()

Returns:
arrow_up


isValid

public boolean isValid()

Returns:
true iff all sm and di elements in this target still exist
arrow_up
Created  2004 - 12 - 1

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2003-2004 Gentleware AG, Schanzenstr. 70, 20357 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.