public interface IDiagram extends IItem
This interface is not intended to be implemented by clients.
IEncyclopedia.getDiagrams()
Modifier and Type | Method and Description |
---|---|
ISymbol |
createSymbol(String name,
long type)
Creates an instance of the Symbol class with a particular name and type.
|
void |
exportBMP(File file)
Exports the diagram into a BMP file.
|
void |
exportBMP(File file,
boolean uncrop)
Exports the diagram into a BMP file.
|
void |
exportSVG(File file)
Exports the diagram into a SVG file.
|
void |
exportWMF(File file)
Exports the diagram into a WMF file.
|
ISymbol |
getSymbolById(long id)
Returns a symbol from its identity.
|
List<ISymbol> |
getSymbols()
Returns all symbols contained in the diagram.
|
String |
getXML()
Returns the XML content of the diagram.
|
void |
hide()
Used to close an instance of a diagram that is currently open.
|
boolean |
isHidden()
Determines whether a diagram is closed or open.
|
boolean |
isLocked()
Check if the diagram is locked by the application.
|
void |
show()
Open the diagram on a System Architect screen.
|
void |
unlock()
Unlock the diagram in the application.
|
delete, getAuditId, getEncyclopedia, getId, getName, getProperty, getPropertyListOf, getPropertyOneOf, getTypeMinor, getTypeName, setName, setProperty, setPropertyOneOf
boolean isHidden()
true
is the diagram is closed, false
if it is displayed.void hide()
void show()
String getXML()
List<ISymbol> getSymbols()
ISymbol getSymbolById(long id)
id
- the symbol identifier.ISymbol createSymbol(String name, long type)
Refer to the SYMBOLS.BAS file in the System Architect directory for a complete listing of all symbols and their internal numbers.
name
- name of new symbol.type
- type of System Architect symbol that is being createdvoid exportBMP(File file)
Preconditions:
file
- the file where to export the picture.IllegalStateException
- if the diagram is not displayed in System ArchitectRuntimeException
- if the diagram image is not exported by System Architectvoid exportBMP(File file, boolean uncrop)
Preconditions:
file
- the file where to export the picture.uncrop
- determines whether to uncrop diagram content for the export.IllegalStateException
- if the diagram is not displayed in System ArchitectRuntimeException
- if the diagram image is not exported by System Architectvoid exportSVG(File file)
Preconditions:
file
- the file where to export the picture.IllegalStateException
- if the diagram is not displayed in System ArchitectRuntimeException
- if the diagram image is not exported by System Architectvoid exportWMF(File file)
Preconditions:
file
- the file where to export the picture.IllegalStateException
- if the diagram is not displayed in System ArchitectRuntimeException
- if the diagram image is not exported by System Architectboolean isLocked()
true
if and only if the diagram is locked by the application;
false
otherwise.void unlock()
Warning: This method does not unlock the diagram symbols. To unlock the symbols, all the definitions represented by the diagram symbols must be unlocked.