-Top- -Classes- -Public Operations- -Class Diagrams- -Sequence Diagrams-
_ A B C D E F G H I J K L M N O P R S T U V W ~
Class UmlBaseItem
|
Declaration :
Directly inherited by : UmlItem
Base class of all the classes representing browser's objects.
In the API all for each 'system' class exists a 'user' class under your responsability which inherits the 'system' class.
You do not have to change the 'system' classes, place your attributes and operations in the corresponding 'user' classes : all the instances made by the 'system' classes are instance of the corresponding 'user' classes.
You must never create or delete yourself a class of the API, use the Create operation defined in the 'system' classes.
To not allow you to access to the 'system' attributes or to call 'system' internal operations even by error, the 'system' internal parts are declared 'private' rather than 'public' or 'protected'.
Artifact : UmlBaseItem
Operation kind |
Declaration :
returns the kind of the item
Operation name |
Declaration :
returns the name
Operation set_Name |
Declaration :
to set the name On error return FALSE in C++, produce a RuntimeException in Java
Operation stereotype |
Declaration :
returns the stereotype
Operation set_Stereotype |
Declaration :
to set the stereotype On error return FALSE in C++, produce a RuntimeException in Java
Operation description |
Declaration :
returns the description
Operation set_Description |
Declaration :
to set the description On error return FALSE in C++, produce a RuntimeException in Java
Operation parent |
Declaration :
returns the parent (0/null if it is applied on the project itself), to go all over the browser tree
Operation children |
Declaration :
returns (in Java : a copy of) the children list, to go all over the browser tree
Operation childrenVisible |
Declaration :
return TRUE if the children exist and are visible (independently of the scroll bar) in the browser, else FALSE
Operation set_childrenVisible |
Declaration :
open the item in the browser (its children are visible) if y is TRUE, else close it (its children are not visible). May be applied on items without children. The item is also selected in the browser, so set_ChildrenVisible(childrenVisible()) is the right way to select the item in the browser.
On error return FALSE in C++, produce a RuntimeException in Java
Operation propertyValue |
Declaration :
In C++, in case the key specified by 'k' exist for the current object, the string 'v' is modified which the associated value and TRUE is returned, else returns FALSE.
In Java return the value associated with the key specified by 'k' for the current object, null in case the property doesn't exist.
These properties may be edited through the object dialog last tab named 'user'
Operation set_PropertyValue |
Declaration :
to set (may be insert a new) the value 'v' associated to the key 'k' On error return FALSE in C++, produce a RuntimeException in Java
Operation properties |
Declaration :
returns all the properties of the object through (in Java a copy of) a dictionnary
Operation supportFile |
Declaration :
Returns the absolute path name of the file memoring the Item. In general an item is saved in a file associated to its package, the exceptions are :
- the body of the operations of a class which definition contains the keyword '{$body}'. This path name is returned when you apply supportFile on any operation of the class.
- the drawing of the diagrams, this path name is returned when you apply supportFile on the diagram.
- the configuration of the tools edited throw the entry 'Tools Settings' of the menu Tools is saved in the file 'tools'
- the configuration of the '#include' and 'using' forms associated to the external type and edited through the last C++ tab of the 'Generation Settings' dialog is saved in the file 'cpp_includes'
- the configuration of the 'imports' forms associated to the external types and edited through the last Java tab of the 'Generation Settings' dialog is saved in the file 'java_imports'
- the configuration of the '#include' forms associated to the external type and edited through the last Idl tab of the 'Generation Settings' dialog is saved in the file 'idl_includes'
Operation isWritable |
Declaration :
return TRUE in case the item may be modified, i.e. it is not an API base 'plug-out' class and the corresponding file(s) are not read-only.
Operation apply |
Declaration :
Apply asynchronously the tool on the item, returns an identifier to call isToolDone()
Operation isMarked |
Declaration :
return TRUE in case the item is marked
Operation set_isMarked |
Declaration :
to mark/unmark the current item. The project cannot marked On error return FALSE in C++, produce a RuntimeException in Java
Operation referencedBy |
Declaration :
Returns the items referencing the current one. The result may contains UmlRelations (their target is the current item), UmlNcRelations (their target is the current item) or UmlComponents (the associated component of the current item when it is a UmlClass, a non source component associated with the current one).
Operation unload |
Declaration :
to unload the object to free memory, it will be reloaded automatically if needed. Recursively done for the sub items if 'rec' is TRUE.
if 'del' is true the sub items are deleted in C++, and removed from the internal dictionnary in C++ and Java (to allow it to be garbaged), you will have to call Children() to re-access to them
Operation isToolRunning |
Declaration :
'id' is an identifier returned by apply(), indicates if the tool is still running
Operation markedItems |
Declaration :
Extra Class Member remark |
Definition :
/** * Do NOT use the next definitions */
Attribut _defined |
Declaration :
Attribut _marked |
Declaration :
Attribut _identifier |
Declaration :
Attribut _name |
Declaration :
Attribut _stereotype |
Declaration :
Note : protected in Java for internal reason, but do NOT access to this field yourself !
Attribut _description |
Declaration :
Relation _parent (<unidirectional association>) |
Declaration :
Attribut _children |
Declaration :
Attribut _dict |
Declaration :
Attribut _all |
Declaration :
Extra Class Member initialization |
Definition :
static { _all = new Hashtable(997); }
Operation read_if_needed_ |
Declaration :
internal, do NOT use it
Operation create_ |
Declaration :
internal, do NOT use it
Operation read_uml_ |
Declaration :
internal, do NOT use it
Operation read_cpp_ |
Declaration :
internal, do NOT use it
Operation read_java_ |
Declaration :
internal, do NOT use it
Operation read_idl_ |
Declaration :
internal, do NOT use it
Operation read_children_ |
Declaration :
internal, do NOT use it
Operation reread_children_if_needed_ |
Declaration :
internal, do NOT use it
Operation set_it_ |
Declaration :
internal, do NOT use it
Operation set_it_ |
Declaration :
internal, do NOT use it
Operation set_it_ |
Declaration :
internal, do NOT use it
Operation set_it_ |
Declaration :
internal, do NOT use it
Operation set_it_ |
Declaration :
internal, do NOT use it
Operation read_ |
Declaration :
internal, do NOT use it
Operation UmlBaseItem |
Declaration :
the constructor, do not call it yourself !
Operation ~UmlBaseItem |
Declaration :
the destructor, do not delete objects yourself !!!!!!!!!!
Operation identifier_ |
Declaration :
internal, do NOT use it
Operation defined_ |
Declaration :
internal, do NOT use it
All public operations : |
apply , children , childrenVisible , defined_ , description , identifier_ , isMarked , isToolRunning , isWritable , kind , markedItems , name , parent , properties , propertyValue , referencedBy , set_childrenVisible , set_Description , set_isMarked , set_Name , set_PropertyValue , set_Stereotype , stereotype , supportFile , unload