# Object diagram

The object diagrams may be placed in a use case view, a use case or a class view

An object diagram is created through the new object diagram entry of the use case view, use case and class view browser menus.

## Browser menu

The node menu appearing with a right mouse click on its representation in the browser is something like these, supposing the diagram not read-only nor deleted :

### Browser Menu : show

show allows to show the diagram picture, and edit it in case it is not read only.

### Browser Menu : edit

edit allows to show/modify the diagram properties. In case the diagram is read-only, the fields of the dialog are also read-only.

#### object diagram dialog, tab Uml

The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one (empty here). It is possible to choose into the list or to give a new one, or to empty it. The stereotype of a diagram doesn't have a special meaning for BOUML.

The editor button visible above and associated here to the description, allows to edit the description in an other window, or to call an external editor (for instance Xcoral) specified through the environment dialog. Note that this external editor have to create an own window, its parameter is the pathname of the file containing the description, its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog is closed (I do not like very much this polling but this works even QT isn't compiled with the thread support).

### Browser Menu : edit drawing settings

This dialog allows to specify how the items of the diagram must be drawn by default, you may choose default for each value, in this case the effective value if specified in the upper level (which itself may specify default etc ... up to the project level).

- write class instance horizontally : To write the instance type and name on the same line, or on two lines

- package name in tab : to indicate if the package's name must be written in the tab which is the small rectangle on the top (note : a transparent package doesn't have shadow) :

- show classes and packages context : to indicate if the context where the class/package is defined must be written, it is not the case just above for a package. The context may be the “UML context” which is the path of the package in the browser (choice followed for awt below), or the C++ / Php namespace specified by the package, or the Java package specified by the package (choice followed for picture below), or the Python package specified by the package or at least the Idl module, for instance for a package :

- automatic labels position : To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited or the associated class pictures moved etc ...

- show stereotype properties : to indicate through a note the (non empty) value of the stereotype properties in case the object is stereotyped by a stereotype part of a profile. By default the stereotype properties are hidden.

### Browser Menu : duplicate

Clone the diagram in a new one

### Browser Menu : delete

The delete entry is only present when the diagram is not read-only.

Delete the diagram and all its representation in the opened diagrams. After that it is possible to undelete it (from the browser) until you close the project : obviously the deleted items are not saved !

### Menu : mark

See mark

### Browser Menu : tools

The menu entry tool is only present in case at least a plug-out may be applied on the diagram. The selected tool is called and applied on the current diagram.

## Picture menu

The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these, supposing the diagram not read-only :

### Picture Menu : edit drawing settings

see edit drawing settings.

### Picture Menu : select all

Select all the items of the current diagram, also done through a control a

### Picture Menu : find selected browser element

To find in the diagram a representation of the elements selected in the browser

### Picture Menu : optimal scale

similar to the fit scale button, change scale to see all the diagram's elements at great as possible

### Picture Menu : optimal window size

Similar to the button , change the size of the windows to see all the diagram's elements with the current scale

### Picture Menu : copy optimal picture part

Copy all the diagram elements, equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size

### Picture Menu : copy visible part

Put the visible part of the current diagram in the clipboard (copy), it is a screen copy, the current scale have impact on the picture quality.

It is also possible to print all (not only the visible part) the current diagram on printer or a file through the button

### Picture Menu : save optimal picture part

To save all the diagram elements in a file, equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size

### Picture Menu : save visible picture part

To save the visible part of the current diagram in a file, it is a screen copy, the current scale have impact on the picture quality.

### Picture Menu : set preferred size and scale

To memorize the current diagram sub window size and the current scale. These ones will be used the next time the diagram will be opened.

### Picture Menu : set preferred scale

To memorize the current scale. These one will be used the next time the diagram will be opened.

### Picture Menu : restore preferred size and scale

In case a preferred sub window size and preferred scale was set, follow them.

### Picture Menu : unset preferred and scale

To stop to define a preferred size and scale was set

### Picture Menu : format

By default the diagram's canvas size is 840 x 1188 points corresponding to an iso A4 format (210*4 x 297*4), all the available formats are :

- iso A5 : 592 x 840

- iso A4 : 840 x 1188

- iso A3 : 1188 x 1680

- iso A2 : 1680 x 2376

- iso A1 : 2376 x 3364

- iso A0 : 3364 x 4756

- USA A : 864 x 1116

- USA B : 1116 x 1728

- USA C : 1728 x 2236

- USA D : 2236 x 3456

- USA E : 3456 x 4472

- USA Letter : 864 x 1116

- USA Legal : 864 x 1424

- USA Tabloid : 1116 x 1728

Each format also exists in landscape (it is Ledger in case of Tabloid)

### Picture Menu : undo changes

Undo all the changes made since the diagram was opened the last time. Note that the diagram is restored independently of the the project saving. Obviously the deleted browser items was not restored !

## Link Menu

The menu appearing with a right mouse click on link is something like these, supposing the diagram not read-only (in the first case the link is doesn't have an associated relation) :

### Link Menu : edit

edit allows to choose the relation supported by the link, the available relations depends on the type of each extremities, the current relation (if set) is shown by the selection :

### Link Menu : select relation in browser

Is of course only available when the relation is set

### Message Menu : select labels

Of course only available when the relation is set, to select the labels (relation's name, stereotypes, role(s) and multiplicity(ies)) associated to the relation. Useful when you are lost after many label movings.

### Message Menu : labels default position

Of course only available when the relation is set, to place the roles's name associated to the relation in the default position. Useful when you are lost after many label movings.

By default when you move a class instance or a link point break or edit the link, the labels are moved to their default position, this may be irritating. To ask BOUML to not move the labels in a diagram, use the drawing settings of the diagrams.

## Class instance Menu

The menu appearing with a right mouse click on a class instance is something like this, supposing the diagram not read-only :

Contrarily to the sequence and collaboration diagrams, an object diagram show modeled instances : there is no pure graphical instances.

### Message Menu : edit drawing settings

This dialog allows to specify how a the class instance must be drawn, you may choose default for each value, in this case the effective value if specified in the upper level (which itself may specify default etc ... up to the project level).

write class instance horizontaly : To write the instance type and name on the same line, or on two lines.

## Default stereotypes

The dialog allowing to set the default stereotypes has a tab reserved for the diagrams :

## Drawing

An object diagram may contain classes instances, notes, texts, diagram icons, packages, fragment and links.

To place these elements in the diagram, use the buttons on the top (to create a new element or choose from the already defined ones) then click at the appropriate position in the diagram, or grab the element from the browser into the diagram.

To show a relation between two class instances, add a link between the instance then edit the link through a double click or through a right mouse click.

The scale may be changed from 30 up to 200 %. To allows to see the relation kinds even with a small scale, the size of the arrows is unmodified.

fit% allows to set the largest scale allowing to show all the picture, as it is possible. Because of the scrollbar management, hitting several times on fit% may give several scales.

Classically, the left mouse click may be used to select an element, or several when the control key is down, a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down. The diagram's elements may be moved after a left mouse click on an element and maintaining the click down during the mouse move. The right mouse click is used to show context dependent menus.

control s is a shortcut to save the project

control shift s is a shortcut to save the project in a new one

control p is a shortcut to print the active diagram

control a is a shortcut to select all the diagram's elements

control d is a shortcut to delete the selected element(s), the model is affected

suppr is a shortcut to remove the selected element(s) from the diagram, these elements are not deleted

control c is a shortcut to copy the selected diagram's elements

control x is a shortcut to cut (remove from diagram) the selected diagram's elements

control v is a shortcut to paste the selected diagram's elements

control z and control u are a shortcut of undo

control r and control y are a shortcut of redo

the keyboard arrows allow to move the selected items

You can define your own shortcut using the shortcut editor through the Miscellaneous menu.

When several diagram's elements are selected, the menu appearing on a left mouse click allows to align or resize them :

If all the selected elements has the same kind (for instance all are a class), you edit their drawing settings globally :

and for instance when the elements are notes :

The settings valuing <unchanged> are not changed for the selected elements, in the other case the same value is set for all the elements.

You can also reuse the drawing settings set for the first selected element for the other selected elements.

### Note

A note may contain any text, a note is resizeable. To change the text of a note choose the edit entry of its menu or double click on it, this open a window containing the text, close the window to end the edition :

A right click on the edited note calls a dialog allowing some text manipulations thanks Qt.

A right mouse click on a note show the following menu :

The font may be changed, by default the font is the one used to write the other texts.

The color of the text may be changed, a text is black by default.

Edit drawing settings allows to change the fill color

Select linked items select all the items connected this the current one through any line, in the previous picture this select all except the package, the text “upper diagram :” and the use case diagram icon.

### Text

Text is another way to write a text, contrary to the note a text is written alone (see “upper diagram :” on the picture below), by default a text contains blabla: a text cannot be empty. The edition of a text is done like for a note. A text is resizeable, a resize is not automatically done when the contains is modified.

A right mouse click on a text show the following menu :

### Image

You can directly insert an image independently of the use of stereotype part of a profile, the size of the image is followed when the zoom if 100%, else the image is resized accordingly to the zoom. Like for a profile the image can be specified through an absolute path, or a path relative to the root directory for the icons or relative to the project directory. In case the path of an icon is not absolute, the icon are searched first using the root directory for the icons, then using the current directory, then using the project directory.

When you insert an image or edit one the following dialog appears :

A right mouse click on an image show the following menu :

### Diagram icon

A diagram icon is a shortcut to a diagram, this allows to quickly navigate through the diagram without limitation (a class or some other item kinds may be associated to only one diagram). The used icon indicates the diagram kind, but its name is not written.

A double mouse left click on a diagram icon opens the diagram, the open entry of the diagram icon menu does the same thing.

A right mouse click on a diagram icon show the following menu :

The other diagram's elements have an own chapter, refer to them.

Previous : class diagram

Next : state diagram