Together User's Reference

	User Reference	Appendix A

CONTENTS

This reference guide documents item by item the important elements of Together that you may need to know about as you work with the product. Here is a quick overview of the information you can find here:

Menu System reference

All main menu bar menus and commands are documented. Each context menu in the system is also documented together with its commands. Use your browser's Find feature to locate menus or commands by name.

Toolbars

A Reference guide to all the toolbars in Together.

Dialogs

This section is a detailed reference to all the dialogs that can be found in Together.

Links reference

A Reference guide to diagram links and the elements with which they can be used.

Keyboard Shortcuts

This topic documents basic keyboard shortcuts available in Together.

Menu System reference

Main Menu
Context Menus

Main Menu

File

New Project - create and open a new project. Opens the New Project dialog.
Open Project - open an existing project. This command opens the system File dialog.
Project Properties - details on the project's location and additional paths. Opens the Project Properties dialog.
New Diagram - create new top level or other level diagram, depending upon Navigation focus. Opens the New Diagram dialog.
Close - close the active instance of the Object Model Browser
Close All -close all open instances of the Object Model Browser (in effect, closes the Project)
Save - save the current diagram
Save All - save all work
Print - print the current diagram
Exit - Close the current project and exit from Together

Edit

Undo - revert to state before last action
Cut - cut selected item or text to Clipboard
Copy - copy selected item or text to Clipboard
Paste - paste item or text from Clipboard to cursor location
Delete - delete the selected element on the diagram
Select All - select all contents (Text pane only)
Global Options - open Options Dialog to set options that will apply to all diagrams.
Reload Options - reloads the configuration file(s) allowing to actualize changes there.

Find - display the Find dialog to search for strings on the current diagram or in the source code. If it finds a match, the element is highlighted, and the diagram scrolls to make element visible.
Replace (Text pane only) - display the Replace dialog, to individually or globally change occurrences of text.
Search Again - search for next occurrence of the search string in the Find dialog.
Go to Line Number (Text pane only) - display the Go To Line Number dialog to jump to lines within the source file

View

Messages - view the Message Log window. Errors and other message output goes to this window
Diagram Only - show diagram only in current window
Text Only - show text only in current window
Diagram and Text - show both diagram and text in current window
Toggle Wide Diagram - expand or contract the Diagram pane. When expanded, it hides the Navigation and Inspector panes

Tools

Scan all diagrams - internally opens all diagrams in the current project to make them available for documentation generation.
Generate Documentation - options for printing and/or saving project Documentation to disk. Opens the Generate Documentation dialog.
Generate IDL - exports source code of Together project to IDL source files.
Rose Exporter - exports Together model to Rose model (MDL) file.
Open script - enables access to Together Scripts, invokes the Open Script dialog to run, create, compile, and edit additional scripts.

Help

Contents - Together on-line documentation contents
Getting started - Together "Getting Started" contents
How to - page of links to various "how to" subjects in Together on-line documentation
User Guide - Together "User Guide" contents
User Reference - Together "User Reference" document (this file)
About - product version and license information

Context Menus

This sections documents the various context menus that appear when you click the right mouse button either in a pane of the Object Model Browser, or when an icon or element in a diagram is selected. Each section details the pane in which the menu appears, and with what elements the menus are associated.

Navigation Pane
Diagram Pane
Class diagram elements context menus

Package
Class
Interface
Object
Operation
Attribute

Use Case diagram context menus
State diagram context menus
Sequence diagram context menus

Object context menu

Links context menu
Inspector Pane

Hyperlink To tab context menu

Options-Tools-Parameters context menu

Navigation Pane

Directory tab context menus

Package node icon (in Navigation tree)

New Diagram - Creates a diagram in the selected package. Displays the New Diagram dialog.

Diagram icon (nodes with extensions .vfPackage, .vfClass, .vfSequence, .vfState or .vfUseCase)

Browse - view the diagram in the current Object Model Browser
Browse in new Window - open a new Object Model Browser window to display the diagram
Delete - Permanently delete the selected diagram and any related source code file (command is hidden for .vfPackage nodes)

Diagram Pane

Diagram (background) context menu

Import - (available only for Class diagrams)
Show Hidden - (available only for Class diagrams) shows a list of all currently hidden diagram elements. You can choose which of them to redisplay.
Layout All (available only for Class diagrams) - invokes the automatic layout feature for the entire diagram.
Layout Selected - invokes automatic layout only for the elements that are currently selected, and those elements linked directly or indirectly to the selected elements. Positions of unselected elements remain unchanged.
Layout All, for Printing - Automatically optimizes the entire diagram layout to ensure that all elements are within the page boundaries currently configured in Print Options.
Layout Selected, for Printing -similar to above, except it only operates on the currently selected diagram elements.
Zoom In - enlarges the diagram view
Zoom Out - shrinks the diagram view
Fit in Window - fits the diagram to the Diagram pane size
Default Zoom - restores default size
Diagram Options... - displays the Diagram Options dialog to configure options applicable to current diagram only.
Update Package Links - updates and displays any new dependencies between packages
Update Diagrams - globally updates all diagrams incorporating any changes in source code or properties

Class diagram elements context menus

Package Context Menu

New Class - create a new class within the current package
New Interface - create a new interface within the current package (Java only)
Delete - delete the package. A package cannot be deleted unless all its contents have already been deleted - otherwise an error message is displayed
Hide - hide the package icon so it does not display in the diagram
Route Links - automatically lay out links of the selected package (e.g. dependency links)
Actual Size - when you have resized a package this command returns it to the size required to show the name and any contents
Browse - browse the package in the current Object Model Browser window
Browse in New Window - browse the package in a new Object Model Browser window

Class Context Menu

New Attribute - create a new attribute for the selected class
New Operation - create a new operation for the selected class
New Constructor - create a constructor for the selected class
New Destructor - create a destructor for the selected class (C++ only)
New Class - create a new class within the current source file
Paste - paste attributes/operations cut or copied from other classes or interfaces
Delete - delete the selected class from the diagram and the model
Unlink - (only available for Imported class) delete the selected class from the diagram
Hide - hide the selected class from current diagram
Route Links - automatically lay out links of the selected class
Actual size - resize the class to the size required to show its name and/or member names

Interface Context Menu (Java only)

New Attribute - create a new attribute for the selected interface
New Operation - create a new operation for the selected interface
New Interface - create a new interface within the current source file
Paste - paste attributes/operations cut or copied from other classes or interfaces
Delete - delete the selected interface from the diagram and the model
Unlink - (only available for Imported interface) delete the selected interface from the diagram
Hide - hide the interface from the current diagram
Route Links - automatically lay out links of the selected interface
Actual size - resize the interface to the size required for showing its contents

Object context menu (Class diagram)

Delete - delete the selected object from the diagram and the model
Hide - hide the object from the diagram
Route Links - automatically lay out links of the selected object
Actual size - resize the interface to the size required for showing its labels

Attribute and Operation Context Menu

New Attribute - creates a new attribute member above the currently selected attribute. Available only when an attribute is selected.
New Operation - creates a new operation member above the currently selected operation. Available only when an operation is selected.
Delete - delete selected member
Cut - cut selected member to Clipboard
Copy - copy selected member to Clipboard
Clone - create a copy of the selected member with the same name and paste it back into the member's compartment
Paste - paste a cut or copied attribute or operation above the currently selected attribute or operation

Use Case diagram

All the elements of Use Case diagrams have only one command on the their context menu. This command is Delete.

State diagram

State Context Menu

New Internal Transition - create a new internal transition for the selected state (available only on ordinary

States, and not on Start-, End-State, History, and SyncBar)

Delete - delete the selected state

Sequence diagram

Object Context Menu

New Class - create a new class for the selected object. This class also appears on the class diagram at the level on which the diagram was created
Add control structure - available only in Coad scenario - appends the scenario with a control structure in the current object's column. The control structure is selectable from the dialog.
Delete - delete the selected object

Links

All Links have Delete command on the their context menu.
Additional commands appear on the Association and Aggregation links. The commands are applicable either to client or supplier edge of the link depending contextually on which edge is closer to the clicking point.

Client context menu:

0..1 - inserts client cardinality = 0..1
1 - inserts client cardinality = 1
* - inserts client cardinality = *
1..* - inserts client cardinality = 1..*
client role - displays in-place edit box for entering client's role
client qualifier role - displays in-place edit box for entering client's qualifier
label - displays in-place edit box for entering link's label

Supplier context menu:

0..1 - inserts supplier cardinality = 0..1
1 - inserts supplier cardinality = 1
* - inserts supplier cardinality = 0..*
1..* - inserts supplier cardinality = 1..*
supplier role - displays in-place edit box for entering supplier's role
supplier qualifier - displays in-place edit box for entering supplier's qualifier
label - displays in-place edit box for entering link's label

Inspector Pane

Hyperlink To tab context menu

This tab menu enables you to link multiple files, URLs and diagrams to a selected element in the current diagram, or the diagram itself (if nothing is selected). Each link displays as a row in the Hyperlink To tab.

New Diagram - creates a new diagram and links it to the selected element
Link Diagram - shows a list of all diagrams in the current project. Select a diagram name in the list and click OK to link the diagram to the currently selected element. (Note: This only links diagrams that have been created in Together for current project)
Add URL - Enables linking the selected element to a disk file or a resource on your intranet or the Internet. Adds a field to the tab in which you can enter a file specification or URL. The ellipsis button displays the File Selection dialog in which you can choose a local or network disk file.

Hyperlink To elements context menu

When you create any of these links, they appear as properties in the tab. You can browse the links by right clicking on the property. For diagrams links this displays:

Unlink - removes the property
Browse - opens diagram in the current Object Model Browser window
Browse in new Window - opens diagram in a new Object Model Browser window

For file and URL links:

Unlink - removes the property
Open - opens the file using the application that is associated with the file type on your system. For URLs, opens the resource in your system's Web browser.

NOTE: Because of operating systems limitations, Together can't open URL with specified anchor. Specify URLs to files only.

Options dialog - Tools Tab

Parameters context menu

Menu command	Macro ^*	Description
Full path specification	$FILE_SPEC$	full path to file containing object (e.g. declaration of class ⁺⁺)
File directory	$FILE_DIR$	directory part of path (including drive, if OS has drives, without slash)
File name	$FILE_NAME$	name part of file name (part before the last dot, or full name)
File extension	$FILE_EXT$	extension part of file name (after and not including the last dot, or empty)
Full path relative to project	$REL_SPEC$	$FILE_SPEC$, but relative to the project directory (does not include leading and ending slash)
Directory relative to project	$REL_DIR$	$FILE_DIR$, but relative to the project directory (does not include leading and ending slash)
Prompt for parameters	$EDITLINE$	expands to parameters entered in the edit box that is displayed on tool's invokation
Object's line number in file	$LINENUMBER$	expands to number of line (1-based) of object in file
System property value	$PROPERTY:<name>$	(replace <name> with a property name) expands to the value of system property or property from ../lib/host.properties.
System classpath	$PROPERTY: java.class.path$	Java classpath for your system
Together home directory	$TOGETHER_HOME$	expands to the Together home (installation) directory

^* Same set of macros for $FILE_* is supported for project: $PROJECT_* but is not available on the menu. You can type these macros in the Parameters edit control.

⁺⁺C++ Definition file support:
For C++ operations, any file macro can be used with DEF_ prefix (e.g. $DEF_FILE_SPEC$, $DEF_REL_PATH$). $DEF_LINENUMBER$ is also possible

Toolbars reference

Main Toolbar
Class Diagram Toolbar
State Diagram Toolbar
Use Case Diagram Toolbar
Sequence Diagram Toolbar
Collaboration Diagram Toolbar

Main Toolbar

Class Diagram Toolbar

The composition of the Class Diagram Toolbar varies slightly depending on the target language of the current Project.

State Diagram Toolbar

Use Case Diagram Toolbar

Sequence Diagram Toolbar

Collaboration Diagram Toolbar

Dialogs references

Links references

Links in Class diagram
Links in Use Case diagram
Messages in Sequence/Collaboration diagram
Links in State diagram

Basic Keyboard Shortcuts

Key	Function	In Pane(s)
Ctrl + A	Add Attribute to the selected Class or Interface icon	Diagram (Class only)
Ctrl + C	Copy selected text or element(s)	Diagram, Inspector, Text
Ctrl + F	Find	Diagram, Text
Ctrl + G	Goto line	Text
Ctrl + H	Toggle "High pane" mode: the pane fits the height of the OMB window, hiding opposite pane. Note: invoked for Text pane it also makes "high" Navigation pane, hiding Inspector.	Diagram, Text
Ctrl+Shift + H	Help Contents (also F1)	All
Ctrl + I	Display the Import dialog (import Classes)	Diagram
Ctrl + L	Find next (after Find in corr. pane)	Diagram, Text
Ctrl + M	Toggle "Maximize pane" mode. The pane fits the whole OMB window, hiding other panes.	Diagram, Text
Ctrl + N	Display New Diagram dialog (create new diagram in current package)	All
Ctrl + O	Add Operation to the selected Class or Interface icon	Diagram (Class only)
Ctrl + P	Print current diagram	All
Ctrl + R	Replace	Text
Ctrl + S	Save the current diagram	All
Ctrl + V	Paste text or element(s) from Clipboard	Diagram, Inspector, Text
Ctrl + W	Toggle "Wide pane" mode: the pane fits the width of the OMB window, hiding Navigation and Inspector panes.	Diagram, Text
Ctrl + X	Cut selected text or element(s) (to Clipboard)	Diagram, Inspector, Text
Ctrl + Z	Undo	Diagram, Inspector, Text
F1	Help Contents	All
F5	Update Diagram	All
Ctrl + F5	Rescan and update all diagrams in the current project	All
DEL	Delete selected element(s) or text; Unlink imported classes. (Optional confirmation dialog displays for classes, physical and logical packages)	Diagram, Inspector, Text
+ (PLUS)	Zoom In	Diagram, Overview
- (MINUS)	Zoom Out	Diagram, Overview
Ctrl + Left or Right Arrow	Jumps words in direction of arrow	Text
Shift + Left or Right Arrow	Select text, character by character	Text
Up/Down Arrow	Move to previous/next field	Inspector
Shift + Up or Down Arrow	Select text, line by line	Text

Using Keyboard with mouse

Mouse action	In Diagrams	In Dialogs^*
click	Select an icon	Select an item
`CTRL` + click	Select a number of icons of the same kind (e.g. classes, attributes)	If multiselection enabled, select a number of items
`SHIFT` + click	In C++ projects: navigate to the definition source code of a member's icon	If multiselection enabled, select a number of adjacent items
Draw a rectangle over workspace	Select a number of nodes in the rectangle	<unavailable>
Drag-and-drop	Move members between classes; move classes between packages	<unavailable>
`CTRL` + drag&drop	Copy members between classes; import classes to/from packages	<unavailable>

^* Here are supposed the property dialogs like Import, Show Hidden, TypeSelection.

Chapter contents

Menu System reference

GO TO TOP

CONTENTS

GETTING STARTED

HOW TO

HELP CONTENTS

This page is hosted by the Chair for Applied Software Engineering of the Technische Universität München.
Imprint (Impressum)