GUI

Window Area Overview

If started in graphical mode, crystal_facet_uml shows a window with

  • toolbar on top,

  • drawing area in the center,

  • element configuration widgets to the right and

  • an optional notification bar at the bottom.

Tool Bar

Create/Use DB

  • Opens an existing database file or creates a new database file

Export

  • Exports all diagrams to the selected folder (supported formats are txt, png, pdf, ps and svg)

New Window

  • Opens another window on the same database.

Navigate

Edit

Create

Cut

  • Cut all pink-cornered elements to the clipboard (features of classifiers are cut independantly of their corner-colors)

Copy

  • Copy all pink-cornered elements to the clipboard (features of classifiers are copied independantly of their corner-colors)

Paste

  • Pastes diagrams and classifiers from the clipboard to the uml model. (Relationships are not pasted) If id and name are identical to an existing element, an instance of the existing element is pasted to the diagram. Otherwise a new element is created.

Delete

  • Deletes all pink-cornered elements. This operation may fail if marked elements have unmarked children.

Instantiate

  • Toggles the pink-cornered classifiers between classes and instances. (Does not work for relationships and features)

Highlight

  • Toggles the pink-cornered classifiers between yellow-marked, greyed-out and normal. (Does not work for relationships and features)

Reset Selection

  • Resets the pink-cornered selection

Undo

  • Un-does the last operation (Opening a database and exporting files cannot be undone)

Redo

  • Re-does the last un-done operation

About

  • Shows version, license and copyrights

Drawing Area

Diagrams are layouted automatically. You can influence the locations of classifiers only. When adding too many classifiers or relations, auto layouting may not achieve the expected results. In many cases, splitting the diagram into two or more diagrams solves the layouting issues and at the same time improves understandability by focusing on one aspect/topic per diagram.

Navigate

  • To navigate to parent, sibling or children diagrams, click on the show diagram.

  • To create a new diagram, click on the icon, or for a new child-diagram.

  • To restructure the diagram tree by shifting the current diagram up and the parent down, press F7.

Edit

  • To move classifiers within the diagram, 1.) press, 2.) drag and 3.) release the mouse button.

  • To select the diagram or a classifier or a feature or a relationship with yellow corners, click on this object.

  • To mark an element with pink corners, click on these objects twice.

Create

  1. To create a classifier, click at an empty space in the diagram.

  2. To create a child classifier, click into the white space of a classifier. (Alternatively, create a classifier and a containment relationship.)

  3. To create a feature, click onto a classifier (name or border).

  4. To create a relationship, press on the source classifier and drag it to the destination classifier.

Element Configuration Area

Edit the properties of the yellow-cornered object.

  • name of the focused object

  • stereotype/valuetype of the focused object (deactivated depending on object-type)

  • type of the focused object

  • description of the focused object

Maximum stringlengths

All strings (names, descriptions, stereotypes) have a maximum length. Ascii characters require one, most other characters two bytes. Current sizes in bytes are: Classifiers:

  • DATA_CLASSIFIER_MAX_NAME_LENGTH = 47,

  • DATA_CLASSIFIER_MAX_STEREOTYPE_LENGTH = 47,

  • DATA_CLASSIFIER_MAX_DESCRIPTION_LENGTH = 4095,

Features:

  • DATA_FEATURE_MAX_KEY_LENGTH = 47, (name)

  • DATA_FEATURE_MAX_VALUE_LENGTH = 255, (type)

  • DATA_FEATURE_MAX_DESCRIPTION_LENGTH = 1023,

Relationships:

  • DATA_RELATIONSHIP_MAX_NAME_LENGTH = 47,

  • DATA_RELATIONSHIP_MAX_DESCRIPTION_LENGTH = 1023,

Diagrams:

  • DATA_DIAGRAM_MAX_NAME_LENGTH = 47,

  • DATA_DIAGRAM_MAX_DESCRIPTION_LENGTH = 8191,

Commit

  • Stores the latest changes to the database immediately. This feature is optional, it is not necessary to explicitly save the file.

Notification Bar

Information

  • Informs on success of an operation, e.g. an export

Warning

  • Informs on a possible problem

Error

  • Informs on an error