Controls

Controls

There are a number of different controls and associated features used within the application and detailed within the documention that require explanation.

The following sections aim to provide details on some of the unfamiliar controls and more advanced features they contain.

Child Window

A Child Window is a "pop up" style window that appears in front of the previous page content.

Child Windows are used extensively within the application, ranging from small windows to create or edit individual objects to large import or management type windows.

Some Child Windows can "flip" to display content on the reverse side.

There are three simple types of child window that also feature within the application, they are: Confirmation, Prompt and Alert.

Confirmation

The Confirmation window is used to confirm a user action, most commonly used to confirm whether to proceed with the removal of an item.

It will contain two buttons with options to proceed or cancel.

Prompt

The Prompt window is used to collect a simple text input from the user in order to confirm an action.

It will contain a text input area and two buttons with options to proceed or cancel.

Alert

The Alert window is used to display an important message about the recently performed user action.

It will contain only an "OK" button in order to close the alert.

DataGrid

The DataGrid is a control used to display data in a grid of columns and rows with each row having individual cells corresponding to the columns.

The DataGrid is used extensively in the application and has several features as detailed below:

Double Click

Double clicking on a row within the DataGrid will perform a relevant action associated with that grid.

This feature is mostly used as an alternate way to edit the associated objects of the DataGrid - (assuming the user has the correct permissions) double clicking on a row is equivalent to selecting the row and clicking on the "Edit" button nearby.

Inline Editing

The DataGrid has an "Inline Editing" feature, meaning the displayed items can be edited directly in the control. This feature is only used within Build Work Packages, Implementation Work Packages and Test Plans.

Single-clicking on a cell of the currently selected item will put that cell into "Edit Mode". Double-clicking a cell of an item that is not currently selected will achieve the same result (first click selects item, second click enables edit mode).

Paging

The paging feature of the DataGrid divides the contents into discreet pages, each page containing a set number of items. The pages can be navigated using the paging controls at the bottom of the control.

Row Details

The Row Details feature of the DataGrid enables certain pices of data to be optionally visible or collapsed. This feature is used as a place to store details relating to the grids associated objects that aren't already displayed within columns.

The additional information can be made visible by clicking the button or collapsed by clicking the button in the special column, often positioned to the far left or right of the DataGrid.

TreeList

The TreeList is a similar data driven control like the DataGrid with columns and rows but it additionally has support for hierarchical data.

Hierarchical data with "Parent-Child" relationships can be displayed and at each hierarchical level, the "nodes" can be choosen to be collapsed or expanded.

Although a lot like the DataGrid there are some differences between the features they offer, for example the TreeList is incapable of having Paging because of the hierarchical data being displayed, some of the TreeList's difference features are detailed below:

Inline Editing

The TreeList has an "Inline Editing" feature, meaning the displayed items can be edited directly in the control.

Single-clicking on a cell of the currently selected item will put that cell into "Edit Mode". Double-clicking a cell of an item that is not currently selected will achieve the same result (first click selects item, second click enables edit mode).

Drag and Drop

An advanced feature of the TreeList control is it's ability to edit the hiarchical structure and/or order of the data via a drag-drop mechanism.

Dragging an item over the others in the list will display a small overlay underneth the cursor that will indicate where to "drop" the item. There are 3 options displayed depending on the position of the cursor against the row it is hovering over:

  • Before - drops the item before the item the cursor is hovering over.
  • Inside - drops the item inside, making it a child of the item the cursor is hovering over.
  • After - drops the item after the item the cursor is hovering over.

Row Details

The Row Details feature of the TreeList enables certain pices of data to be optionally visible or collapsed. This feature is used as a place to store details relating to the grids associated objects that aren't already displayed within columns.

The additional information can be made visible by clicking the button or collapsed by clicking the button in the special column, often positioned to the far left or right of the TreeList.

Rich Text Box

The Rich Text Box is an advanced text box that provides an array of different text editing features as well as some additional image related features.

A Rich Text Box must be selected in order for the features of the Rich Text Box Tool Bar to become active.

Toolbar features from left to right:

Feature Description
Undo Clicking the button reverses the last action. The down arrow allows past actions to be reviewed and reversed. The last 20 actions are stored, clicking the arrow will display a list of the actions, clicking an action will reverse all actions upto and including that action.
Redo Redo the last reversed action. Much like the undo feature, stores past 20 reversed actions.
Bold, Italic, Underline Basic text editing features, 8 different underline textures to pick from.
Centre Text Centre aligns text.
Bulleted/Numbered List Allows lists to be formatted with solid or numbered bullet points. 4 different options available.
Text Highlight Colour Colours the background behind the text. 70 colours available.
Font Colour Colours the font text. 70 colours available.
Paragraph Shading Colours the background behind the selected paragraph.
Spell Check Enable/Disables spell check.
Text Align Left/Right/Justify Aligns text to the left/right or both with extra spacing.
Strikethrough Draws a line through the middle of the selected text.
Subscript Insert small letters below the text baseline.
Superscript Insert small text above the line of text.
Clear Formatting Clears all the formatting from the selection, leaving only plain text.
Show/Hide Formatting Symbols Show paragraph marks and other hidden formatting symbols.
Find/Replace Find or replace text within the Rich Text Box.
Insert Picture Insert a picture from file.
Insert Code Block Insert block containing formatted programming source code.
Insert Symbol Insert symbols that are not on the users keyboard.

Right clicking in the Rich Text Box will present a context menu with basic Cut, Copy and Paste options and also the ability to insert a hyperlink.

Right clicking upon an inserted picture will present 2 extra options within the context menu. The first is the ability to change how the picture behaves with the surrounding text, the text wrapping options available are:

  • In Line with Text
  • Square
  • Top and Bottom
  • Behind Text
  • In Front of Text

The second additional option when clicking on an inserted picture is the ability to edit the inserted picture within an "Image Editor Dialog" that is rich in image editing features, detailed below.

Drop-down list

The drop-down list is used to display a list of values from which the user can select a single element.

Summary Control

The Summary Control is used to display Sucess, Warning/Information and Error/Validation Error messages.

Validation Errors are errors that occur due to input from the user not meeting the required specifications, the most common type of validation error that is likely to be encountered is the "[insert property name] is required." error when attempting to save properties with no value set.

Sucess and Warning/Information warning messages will disappear from the list after 4 seconds. Error messages will remain until manually removed by the user using the button on the right.

The Summary Control will appear at the very bottom of the application window or at the very bottom of a child window if one is open and will disappear when no messages remain.

Tab Control

The Tab Control is a container that displays data in separate "Tabs", allowing the user to select the "Tab Headers" at the top in order to change the displayed data underneth.

Context Menu

A Context Menu is a menu of options that appears upon user interaction, such as clicking a button. The menu will offer a selection of options for the user to choose from, selecting an option will close the context menu and clicking somewhere off the menu will also close it.

Expander

The Expander is a control that allows its content to be expanded or collapsed, this allows "busy" pages with lots of content to be customised by the user to be more clutter-free so its easier to view the content required.

Clicking on the blue "header" of the expander will expand/collapse the content inside. Please note: sometimes buttons for additional features are included in the expander "header" to create a clutter-free page, clicking on these buttons will not trigger the expand/collapse behaviour.

Report Viewer

The Report Viewer is the control used to display reports in Project on Demand, it includes features to aid in navigating through reports pages and selecting specific text.

The tool bar at the top of the control includes two features:

  • Page Navigation - The and buttons can be used to navigate in the report to the previous and next pages respectively. Alternatively a page number can be entered in the neighbouring text box and the enter key pressed to navigate to a specific page.
  • View Modes - Pan is the default View Mode, it allows the user to click somewhere within the Report and scroll the Report up and down using their mouse. Text Selection View Mode can be used instead to select text contained within the Report. The View Mode can be changed by clicking the respective buttons in the tool bar, alternatively right clicking in the Report will display a context menu with the same options.

The Report Viewer also features a number of common key-bindings:

Hotkey Description
Ctrl+C Copy
Ctrl+A Select All
Left Arrow Move to Previous Character
Right Arrow Move to Next Character
Ctrl+Left Arrow Move to Previous Word
Ctrl+Right Arrow Move to Next Word
Upper Arrow Move Line Up
Down Arrow Move Line Down
Home Move to Line Start
End Move to Line End
Ctrl+Home Move to Start of Document
Ctrl+End Move to End of Document