Introduction

The Object Model Browser is your main work center in Together. It enables you to construct object models visually while keeping the source code for the model synchronized with the graphical representation. The Object Model Browser's window (Browser window) automatically opens when you open an existing Project or create a new Project. It then displays the top level diagram (Default.vfPackage) for the Project. The Browser window remains open until you close it or exit Together.

You can open multiple instances of the Object Model Browser by choosing Browse in New Window  whenever that command is available on a context menu. This enables you to view and edit multiple diagrams in the current Project. (See also: Directory tab, and  User Reference: Diagram nodes context menu).

Use the Object Model Browser to:
 

	Navigate the current Project and individual diagrams (especially large diagrams)
	Construct and modify diagrams; edit properties of diagram elements
	Annotate diagrams and elements and link them to other diagrams or to disk files
	Manage diagram layouts and trigger diagram operations and updating
	View and edit source code and comments

 

Overview of the Browser Window

The Object Model Browser window is divided into four panes:

	Figure 3.1. The Object Model Browser's panes. Red dashed lines indicate pane resizing locations.

	The Navigation pane displays views of your Project and enables you to navigate Project directories and the current diagram.
	The Diagram pane contains the visual elements of the current diagram.
	The Inspector pane enables you to view and edit the properties for diagrams and elements of diagrams, and to set diagram filters.
	The Text pane enables viewing and editing of source code for the currently selected visual element in the Diagram pane, or source file in the Navigation pane.

Diagram toolbars

The Object Model Browser also has a vertical Toolbar that enables you to quickly place icons for diagram elements, nodes and links for example, in the Diagram pane. The composition of the Toolbar changes dynamically depending upon the type of diagram currently displayed in the browser (Class, Use Case, State, etc.) For complete information on the different Toolbars, see User Reference: Toolbars.

There is a separator between the Toolbar and the Navigation and Inspector panes enabling you to resize the left-hand region of the browser window.

Using the Navigation pane

The Navigation pane enables you to navigate the Packages, diagram files, and source code files that make up a Together Project. This pane has two tabs:
 

	The Directory tab displays a hierarchical tree view of the current Project enabling Explorer-style navigation of directories and files.
	The Overview tab displays a thumbnail view of the current diagram enabling quick visual navigation to any portion of it.

 

Directory tab

The Directory tab enables you to navigate around the current Project. The hierarchical tree displays icons and text representing the physical and logical packages in the project, and the various types of files and diagrams. Many of the icons that display in this tab have context menus that enable you to create new diagrams in a selected Package, or view a selected existing diagram in the current instance, or a new instance of the Object Model Browser window. (See User Reference: Context menus - Navigation pane.)

Tips for using this tab

	Packages have a folder icon. Double-clicking a Package folder moves you inside it, makes it the current package, and displays its contents in the Directory tab.
	When a Package icon is selected, you can create a new diagram in that Package either by choosing File | New Diagram from the Main menu, by using the context menu of the selected Package icon.
	Each diagram type has a distinct icon (see Figure 3.2-a). Double-clicking the icon for a diagram file (e.g., Default.vfPackage or *.vfSequence) displays the nodes in the diagram in the Navigation pane as shown in Figure 3.2-b. It does not display the diagram in the Diagram pane... choose Browse or Browse in New Window on the diagram icon's context menu to open the selected diagram in the Object Model Browser.
	Selecting a diagram node in the Navigation pane selects the corresponding node icon in the Diagram pane, automatically scrolling that pane if necessary.
	Selecting the icon of a source code file causes the file's contents to display in the Text pane of the Object Model Browser window.

 

	Figure 3.2-a. Navigation pane's Directory tab

 

	Figure 3.2-b. Using context menu to display a diagram in the Diagram pane

 

Overview tab

The Overview tab enables you to visually navigate the diagram currently displayed in the Diagram pane. This tab displays a "thumbnail sketch" of the entire diagram and a shadow over the region currently visible in the Diagram pane (see Figure 3.3). The Diagram pane scrolls proportionally with any movement of the shadow.

Tips for using this tab

	Use this tab to quickly navigate around large diagrams
	Drag the shadow to scroll the Diagram pane to the region of the diagram you want to view.
	Resize the shadow ("grab" and drag the lower right corner) to increase or decrease the Zoom level in the Diagram pane.
	Figure 3.3. Navigation pane's Overview tab

 

Using the Diagram pane

If you are using Together for visual system modeling, the Diagram pane is the heart  of the user interface. It is here that you create the various diagrams for your system and view and edit the icons that represent nodes, links, or other elements of your model. Icons display in the notation specified in your Options configuration. (For information on selecting the notation, see Dialogs Reference: Options dialog - Diagram tab. For information on configuring Options, see Chapter 5.)
 

Tips for using this pane

	Click on nodes or links to select them. For nodes that contain Members, click on a Member to select it. Properties of the selected element display in the Inspector.
	Right-click on nodes and links for access to operations on the node or link Context menu.
	Use the Diagram toolbar to place new icons on the diagram background. In Class diagrams, placing node and link icons synchronously adds the corresponding source-code constructions to the Project.
	Scroll the pane horizontally and vertically using its scrollbars or the Overview tab.
	Resize the pane vertically by dragging its lower edge up or down. Resize the pane horizontally by dragging the separator located between the Toolbar and the Navigation/Inspector region, or by resizing the Browser window.
	Clicking on the pane background displays the diagram's properties and filters in the Inspector pane.
	Right-clicking on the background displays the Diagram context menu with operations and options for the current diagram. (See: User Reference: Diagram context menu.)
You can find more detailed information about creating and working with diagrams in the User Guide: Chapter 1. Diagram Basics.

 

Using the Diagram Toolbars

The Diagram Toolbar is part of the Diagram pane (if you choose View | Text Only on the Main menu, it is hidden along with the rest of the diagram). You use the toolbar to place icons representing elements of your system model on the background of the Diagram pane.

There is a different Toolbar for each type of diagram supported by Together. The appropriate Toolbar displays when you create or browse into any diagram in a Project. For information about the different types of diagrams, see the User Guide. For information on a specific Toolbar, see User Reference: Toolbars Reference.

To place a node icon on a diagram:

1. Click the appropriate button on the Diagram Toolbar to depress it.
2. Move the cursor to the desired position in the Diagram pane and click.
To cancel the icon placement:
• Click the Select button at the top of the Toolbar. The select button is common to all Diagram Toolbars.
To create a link between nodes:
1. Click the Diagram Toolbar button for the link.
2. Place the mouse pointer over the first node in the link.
3. Drag the link directly to the second node or to the diagram background and select the link target from the resulting dialog box.
For more detailed information on working with diagrams, see User Guide: Chapter 1. Diagram Basics, in particular Creating Nodes, and Creating Links.

Using the Text pane

The Text pane displays source code contained in the source file currently selected in the Navigation pane or the Class diagram element currently selected in the Diagram pane. You can directly edit source code in this pane. Modifications to such things as class or interface declarations or values of properties are reflected visually in the diagram to which the code pertains. When you select a Class icon on the diagram, the Text pane displays the source code with the Class declaration highlighted. The same applies for members and interfaces (in Java) .

For Class diagrams, which generate source code, the text pane displays by default; for other diagrams it is initially hidden. The Text pane has no context menu.

In a multi-tasking environment, Together automatically saves changed files when you switch to another application and reloads them when you switch back. This makes it easy to use your preferred source code editor in parallel with Together. Note that files are being changed from the two sources, when you modify visual elements of diagrams (in the Diagram pane) and/or when you modify directly source code (in the Text pane).

At the bottom of the Text pane is the Status bar. It shows source file name and path or messages, column and row where cursor is currently positioned and a status message of the source file (modified, read-only etc.)

Updating the diagram

Whenever you change the source code in the Text pane, click on the Diagram pane to apply the changes to the diagram. If you change an attribute's name in the source code, for example, click on the Diagram pane and the attribute name changes on the icon.
Text that you type in the Text pane, or source code changes you make in external tools are passed to Together "as is". They are reflected in Together's diagrams when diagram updating occurs. Diagram updates are "one-way": from the source code to the visual model.
 

Understanding the Text pane's limitations

IMPORTANT:
You are fully responsible for the syntactical correctness of changes you make to source code in the Text pane. As noted above, the changes are actualized when you click on the Diagram pane. In case of errors, the corresponding diagram element (along with its selection) disappears. The Message window displays enabling you jump to the error-prone code and correct it.

Together is primarily a visual modeling tool as opposed to a programming tool. Together's Text pane is mainly a convenience that enables you to make quick "tweaks" to your code. It is possible to create an entire class in the Text pane, but you must then specify its full, complete declaration and definition. The same applies to operations - you must fully create its code (as for C++ in two places, declaration and definition). You will probably find it more productive to create classes and members using Together's visual tools, or, if you really prefer to typewrite code, with a third-party source code editor or IDE.
 

Tips for using the Text pane

	Select a source file icon in the navigation Pane to display its code in the Text pane.
	Select an element in a diagram (e.g. a node or link icon, or a Class or Interface member) to display its declaration source code, if applicable.  Note: C++ elements can have definitions. Shift + click an element to display its definition source code.
	Scroll the pane using its scrollbars.
	Resize the pane vertically by dragging its upper edge (also the lower edge of the Diagram pane).
	Resize the pane horizontally by dragging the separator located between the Toolbar and the Navigation/Inspector region, or by resizing the Browser window.
	Show or hide the pane using the main menu commands: View | Diagram only, View | Text only and View | Diagram and Text.
	Use the basic hot keys to speed your work in the Text pane.

International Keyboard notes

Text editing is compatible with different keyboard layouts if you are using the Microsoft Virtual Machine. All characters that can be entered with AltGr-num are entered correctly.
• AltGr-num is now not equal to Ctrl-num.
• In Norwegian & Deutch layouts (layouts in which characters that can be entered as Alt-num presently) pressing & releasing AltGr (without pressing any other key while holding AltGr) leads to switching to the host window.
• In English layout this feature is not present any more.
 

The Inspector Pane

The Inspector pane is the most dynamic of the four panes of the Object Model Browser. Its many features and uses are covered in the next chapter, Getting Started Chapter 4: Using the Inspector.

Chapter contents:

Introduction
Overview of the Browser window
Diagram Toolbars
Using the Navigation pane
Directory tab
Overview tab
Using the Diagram pane
Using the Diagram Toolbars
Using the Text pane
The Inspector Pane