com.togethersoft.openapi.rwi
Interface RwiReference

All Known Subinterfaces:

RwiDiagramReference, RwiLinkReference, RwiMemberReference, RwiNodeReference

public interface RwiReference

extends RwiPropertyMap

RwiReference is a generic type of a reference. References are
used in diagrams to represent elements of the model. Every element can have many references to it from
different diagrams.

A reference can be set to be visible or invisible within the diagram via setVisible method.

An imported reference can be deleted using the delete method. (Imported references are
described in the RwiDiagram interface).
It's very important to understand that references are only pointers to elements.
Deleting an imported reference from a diagram doesn't remove the referenced element from the model,
but from this diagram only.

The RwiNodeReference, RwiMemberReference, RwiDiagramReference and
the RwiLinkReference interfaces extend RwiReference and represent
references to the nodes, members, diagrams and links respectively.

Author:

TogetherSoft

Since: Together 3.0

See Also: RwiNodeReference, RwiMemberReference, RwiDiagramReference, RwiLinkReference

Method Detail

canDelete

public boolean canDelete()

Checks whether it is possible to remove an imported reference to model's element from its diagram. Note that
removing a reference doesn't delete the referenced element from the model. Non-imported references can not be deleted.

Parameters:

element the element to which a reference is being removed

Returns: true if it is possible to remove a reference, false otherwise

See Also:

RwiElement.canDelete(), RwiDiagram.canAddReference(com.togethersoft.openapi.rwi.RwiElement)

public void delete()

Removes an imported reference to model's element from its diagram. Note that
this doesn't delete this element from the model. Non-imported references can not be deleted.

Parameters:

element the element to which a reference is being removed

See Also:

RwiElement.delete(), RwiDiagram.addReference(com.togethersoft.openapi.rwi.RwiElement)

public RwiDiagram getContainingDiagram()

Returns a diagram this reference belongs to.

Returns: a diagram this reference belongs to

public RwiElement getElement()

Returns an element for this reference.

Returns: an element for this reference

public RwiPositions getPositions()

public boolean isImported()

Deprecated.

Returns: true if this reference is imported, fasle otherwise

See Also:

RwiDiagram

public boolean isVisible()

Deprecated.

Returns: true if it is visible, false otherwise

public RwiLinkReferenceEnumeration outgoingLinkReferences()

Returns an enumeration of references to outgoing links.

Returns: an enumeration of references to outgoing links

See Also:

RwiLinkReference

public void setVisible(boolean value)

Deprecated.

Parameters:

value The boolean value. true to set visible, false to set invisible