G4 Panelbuilder: Operation/Reference Guide
G4 Panelbuilder: Operation/Reference Guide
G4 PanelBuilder
S of t w ar e
This Agreement replaces and supersedes all previous AMX Software License Agreements and is governed by the laws of the State of Texas, and all disputes will be resolved in the courts in Collin County, Texas, USA. For any questions concerning this Agreement, or to contact AMX for any reason, please write: AMX License and Warranty Department, 3000 Research Drive, Richardson, TX 75082.
Table of Contents
Table of Contents
G4 PanelBuilder Overview ..................................................................................1
Welcome to G4 PanelBuilder .................................................................................... 1 System Requirements ............................................................................................... 1 Supported AMX (G4) touch panel types: .................................................................. 1 The G4 PanelBuilder Work Area ............................................................................... 2
G4 PanelBuilder Application Interface ............................................................................ 2 File Menu ........................................................................................................................ 3 Edit Menu........................................................................................................................ 3 Project Menu................................................................................................................... 3 Toolbox Menu ................................................................................................................. 3 Diagram Menu................................................................................................................. 4 View Menu ...................................................................................................................... 4 Help Menu....................................................................................................................... 4 Diagram Area .................................................................................................................. 5 Toolbar............................................................................................................................ 5 Tasks Pane....................................................................................................................... 6 Quick Links ...................................................................................................................... 7 Toolbox ........................................................................................................................... 7 Color Schemes ................................................................................................................ 8 Status Bar........................................................................................................................ 8 Viewing Panes ................................................................................................................. 8 Changing Visual Style...................................................................................................... 8
Templates ............................................................................................................... 12
Preview A Template via Template Manager.................................................................. 12 Opening A Most Recently Used Template .................................................................... 12 Install A Template via Template Manager ..................................................................... 12 Install Templates from AMX.com .................................................................................. 12
G4 PanelBuilder
Table of Contents
Install A Template from File .......................................................................................... 13 Remove A Template from G4 PanelBuilder ................................................................... 13
Opening A Project .................................................................................................. 13 Changing Color Schemes ........................................................................................ 13 Creating A New Project from File ........................................................................... 14 Editing Project Properties....................................................................................... 14 Alternate Screen Names ......................................................................................... 14 Using Unicode Text................................................................................................. 14 Preview Diagram Element....................................................................................... 15 Preview A Toolbox Element.................................................................................... 15 Globally Remove An Element Instance ................................................................... 15 Undo, Redo And Delete.......................................................................................... 15 Create Snapshots to Clipboard............................................................................... 16 Show and Hide Grid................................................................................................ 16 Snap To Grid........................................................................................................... 16 Zoom in And out of Diagram .................................................................................. 16 Using Web Updates ................................................................................................ 16 Exiting G4 PanelBuilder .......................................................................................... 16
Template Requirements.......................................................................................... 20 Required Template Elements.................................................................................. 20 Optional Template Elements .................................................................................. 22 Rules for Navigating A Template ............................................................................ 25 Template Wide Conventions................................................................................... 25 AMX Element Naming Conventions........................................................................ 26
ii
G4 PanelBuilder
Table of Contents
Generate TPDesign4 Project dialog .............................................................................. 30 Install Templates from File dialog ................................................................................. 31 New From File dialog.................................................................................................... 31 New Project dialog........................................................................................................ 32 Open Project dialog ...................................................................................................... 33 Project Properties dialog .............................................................................................. 33 Replace Template dialog............................................................................................... 34 Save As dialog............................................................................................................... 34 Template Manager dialog ............................................................................................. 35 Template Sample Images dialog ................................................................................... 36 Unicode Edit Window.................................................................................................... 36
G4 PanelBuilder
iii
Table of Contents
iv
G4 PanelBuilder
G4 PanelBuilder Overview
G4 PanelBuilder Overview
Welcome to G4 PanelBuilder
With the advent of G4 PanelBuilder, AMX enables proficient G4 panel programmers to enjoy sleek touch panel designs without the need for a graphic artist. Dealers now have the choice of using AMX created panel templates or implementing their own TPDesign4 creations.
System Requirements
G4 PanelBuilder supports the following platforms: Windows 2000 (Service Pack 3 or greater) If you are installing on a Windows 2000 machine, you must have Administrator rights to install and run all required System files. Windows XP Home and Professional (Service Pack 1 or greater) Other PC requirements: Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended. 75 MB of free disk space (minimum requirement); 150 MB recommended. 128 MB of installed memory (RAM). Minimum (VGA) screen resolution of 800x600 Windows-compatible CD-ROM drive. Windows-compatible mouse (or other pointing device).
The nomenclature " NXT" indicates the table-top (tilt) model, and "NXD" represents the wall-mount version.
G4 PanelBuilder
G4 PanelBuilder Overview
Tasks Pane
Toolbox
Quick Links
Status Bar
Instance Counter The instance counter tracks and displays the number of times an element is used within the current project. Diagram Area Tasks Pane The Diagram area is the graphical representation of the flow your panel file will follow. After pulling the elements from the Toolbox you can connect and develop the elements. The tasks pane is a collection of links to commonly used functions. In addition to opening projects (both new and existing), tasks pane tracks recently opened projects and templates. To access anything listed in the tasks pane, click on any of the items listed. Located within the Tasks Pane is a small sub-section quick links. These links allow you quick access to adding and managing templates within G4 PanelBuilder.
Quick Links
G4 PanelBuilder
G4 PanelBuilder Overview
File Menu
The File menu serves as a location for file management, project information and template management. File Menu
New New From File Open Close Save Save As Generate TPDesign4 Project Install Templates From AMX.com Install Templates From File Template Manager Most Recently Used List Exit Launches the New Project dialog. Launches the New From File dialog. Launches the Open Project dialog. Closes the project currently open. Saves the current project. If the project has not been previously saved it will launch the Save As dialog. Launches the Save As dialog. Launches the Generate TPDesign4 Project dialog. When an internet connection is present, connects to AMX.com and launches the AMX.com Template Library dialog. Launches the Install Templates from File dialog. Launches the Template Manager dialog. A list of most recently opened project file names. Closes the G4 PanelBuilder application.
Edit Menu
The Edit menu governs the actions within the Diagram area. Edit Menu
Undo Redo Undoes action taken in diagram area. Undo does not apply to text changes within elements. Reverses the undo action taken within the diagram area.
Project Menu
The Project menu is a set of features covering the project properties and related items. Project Menu
Project Properties Color Schemes Launches the Project Properties dialog. Launches the Color Schemes dialog. Project Template Sample Images Launches the Template Sample Images dialog.
Toolbox Menu
The Toolbox menu is a set of features for interacting with the Toolbox area. Toolbox Menu
Add Element To Diagram Remove All Instances From Diagram Element Preview Adds the element currently selected within the Toolbox to the Diagram area. Removes all instances of the currently selected element from the Diagram area. Launches the Templates Sample Images dialog with the currently selected element shown.
G4 PanelBuilder
G4 PanelBuilder Overview
Diagram Menu
The Diagram menu interacts directly with the Diagram area. Diagram Menu
Add Element Properties Preview Show Grid Snap To Grid Zoom Out Zoom In Zoom A complete list of available elements within your selected template. Select any element to have it placed within the Diagram area. Launches the Diagram Properties dialog. This feature views the properties of the selected element within the Diagram area. Launches the Diagram Preview dialog. Shows the grid in the Diagram area. Locks all element placements to grid lines. Decreases the magnification of the diagram area. Increments are 150%, 125%, 100%, 75% and 50% of work area. Increases the magnification of the diagram area. Increments are 150%, 125%, 100%, 75% and 50% of work area. A list of available increments to zoom into or out of the diagram area. Click on the desired magnification to implement.
Copy Snapshot To Clipboard Copies only the diagram area to your computer's clipboard.
View Menu
The View menu allows you to toggle different aspects of the G4 PanelBuilder Application Interface on and off. Additionally, you can change the appearance of the application itself. A check next to the title indicates it is visible. View Menu
Visual Style A list of visual appearances for the G4 PanelBuilder. Select one of the following: Default (Windows 2000) Office XP Office 2003
Help Menu
The Help menu contains features for updating the application and connecting with AMX for a demo on how to use G4 PanelBuilder. Help Menu
Contents AMX Training Demo Web Update Launches the G4 PanelBuilder help, Contents section. Connects to AMX.com for the online demo for using G4 PanelBuilder. Launches the AMX Web Update utility. Internet connection is necessary.
About G4 PanelBuilder Displays the about G4 PanelBuilder dialog containing information pertaining to version and copyright.
G4 PanelBuilder
G4 PanelBuilder Overview
Diagram Area
The Diagram area is the graphical representation of the flow your panel file will follow. After pulling the elements from the Toolbox you can connect and develop the elements. You can either click and drag or nudge the elements within the Diagram area. Select an element and use your arrow keys to nudge.
Exiting Node Element
Entering Node
Connection Line
Diagram Area
Entering Node Exiting Node Element This node receives the connection line from another element. This node connects out to another element. The building block of the panel files, i.e., Modes, Navigation, Devices, and etc.
Connection Line The graphical representation of the connection between two elements. The color of the connection line is dictated by the element it is exiting.
Toolbar
The toolbar contains icons for the commonly used functions:
New New From File Open Save Generate TPDesign4 Project Delete
Undo Redo Color Schemes Zoom Out Zoom In Copy Snapshot To Clipboard Template Manager
FIG. 3 Toolbar
G4 PanelBuilder
G4 PanelBuilder Overview
Toolbar
New New From File Open Save Launches the New Project dialog. Launches the New From File dialog. Launches the Open Project dialog. Saves the current project. If the project has not been previously saved it will launch the Save As dialog. Deletes the element currently selected in the Diagram area. Undoes action taken in diagram area. Undo does not apply to text changes within elements. Reverses the undo action taken within the diagram area. Launches the Color Schemes dialog. Decreases the magnification of the diagram area. Increments are 150%, 125%, 100%, 75% and 50% of work area. Increases the magnification of the diagram area. Increments are 150%, 125%, 100%, 75% and 50% of work area. Launches the Template Manager dialog.
Generate TPDesign4 Project Launches the Generate TPDesign4 Project dialog. Delete Undo Redo Color Schemes Zoom Out Zoom In
Copy Snapshot To Clipboard Copies only the diagram area to your computer's clipboard. Template Manager
Tasks Pane
The tasks pane is a collection of links to commonly used functions. In addition to opening projects (both new and existing), tasks pane tracks recently opened projects and templates. To access anything listed in the tasks pane, click on any of the items listed.
Tasks Pane
Recently Opened Projects Open Project Recently Opened Templates New File New from File A list of file names for recently opened existing projects. Launches the Open Project dialog. A list of file names for recently opened templates. Launches the New Project dialog. Launches the New From File dialog.
G4 PanelBuilder
G4 PanelBuilder Overview
Quick Links
Located within the Tasks Pane is a small sub-section quick of links. These links allow you quick access to adding and managing templates within G4 PanelBuilder.
AMX.com Template Library Install Template from File Open Template Manager
Quick Links
Install Templates From AMX.com Install Templates From File Template Manager If a internet connection is available, G4 PanelBuilder connects to AMX's collection of online templates. The templates are found in AMX.com Template Library dialog. Launches the Install Templates From File dialog. Launches the Template Manager dialog.
Toolbox
All elements available within a selected template reside in the toolbox. The toolbox is only available when a template is open.
Element Sections
FIG. 6 Toolbox
As you can see, the toolbox is divided into elements with specific pages contained therein. Click on the element you would like to add, i.e., Navigation, Device, etc. All available elements will be shown. When available, a thumbnail representation of the page will appear within the toolbox; otherwise a general image will be shown for the thumbnail. Mouse-over the element to get a description. Once you have found the element you would like to use, you can right-click on the thumbnail to access the toolbox context menu or drag-and-drop the element into the diagram area. Only contained within the template are represented within the toolbox. If the template does not contain a particular element, you will not see it in the toolbox.
G4 PanelBuilder
G4 PanelBuilder Overview
Color Schemes
Templates can contain multiple color palettes, allowing you to switch from one color scheme to another within one template. The current scheme is reflected in the element preview but the elements in the toolbox will remain the main color scheme. Used either with Chameleon buttons or standalone, you can use a single template that can deliver different predefined color schemes.
Status Bar
Located at the bottom of the G4 PanelBuilder Application Interface is the status bar. In addition to giving you the current status of G4 PanelBuilder, i.e., Ready. The status bar also provides a brief description of toolbar and menu items via mouse over.
Viewing Panes
The G4 PanelBuilder Application Interface is composed of panes, sections containing tools for creating a panel project. To reveal or hide different panes: Select View > (any of the panes listed; a check mark indicates the pane is in view) Toolbar, Tasks Pane, Toolbox or Status Bar.
G4 PanelBuilder
Basic Operations
Basic Operations
Getting Started
Creating A New Project
The first step towards designing a new *.TP4 file is creating a new project file (*.PB4).
1. 2. 3. 4. 5.
Launch the G4 PanelBuilder application. Select File > New. This launches the New Project dialog. Type the Job Name in the corresponding field. Select the Panel Type and Resolution from the drop down menus. Select your desired template family from the thumbnails listed.
If no templates are shown you will need to load them. You can either Install A Template from File or Install Templates from AMX.com.
6. After you have clicked on your desired template, click OK. 7. Your new project is now open to the G4 PanelBuilder Application Interface. A Start element is in place
within the Diagram area. If a project is already open and you select open a new or existing project, you are prompted by the Save As dialog. The previous project will remain on screen until you are done setting up the new project.
1. Select the element type within the Toolbox. 2. Find the desired element, click-and-drag the element to the Diagram area.
3. Now connect the Start element to the Navigation element. Click on the Exiting node (white) on the Start
element and drag it to the other element. All possible connections are indicated by a green outline. If the connection cannot happen the outline is red. A connection line appears between the two elements.
G4 PanelBuilder
Basic Operations
4. You can now edit the properties for the Navigation element or select another element to add to the
diagram area. An element will populate the corresponding appropriate field, when connecting. This saves you the trouble of naming element properties.
1. Open a project or create a new project file. 2. Select Diagram > Add Element, then select the element with the appropriate number of selections or
device for your criteria. You can either click and drag or nudge the elements within the Diagram area. Select an element and use your arrow keys to nudge.
Connecting Elements
Developing flow between pages is made possible by creating lines from one element's exiting node to another element's entering node.
1. With a template open and elements present in the diagram area, left-click and hold on the exiting node of
a desired element.
2. Drag your mouse over any part of another element. If a connection is permissible, the element highlights
in green. If the connection is not possible the element highlights in red. You have now created the flow from one page to another.
10
G4 PanelBuilder
Basic Operations
1. Select an element in the Diagram area. 2. Select Diagram > Properties to open the Diagram Properties dialog. 3. Click within the text fields to edit. You can either type the name or use the browse (...) button to edit the
Connections fields.
4. Once all fields are edited, click OK. Generating A TPDesign4 Project
After your new project has all the necessary elements, their nodes are connected and the element properties are set; you are ready to generate a .TP4 file.
1. Select File > Generate TPDesign4 Project to launch the Generate TPDesign4 Project dialog. 2. Select the location to save the file and place a check next to Open project in TPDesign4 if you want G4
PanelBuilder to launch the newly created file within TPDesign4.
3. Click Save.
When you generate a TPDesign4 project G4 PanelBuilder stores information to the .PB4 file. As a result the file will indicate being "dirty" or changed. You will need to save the .PB4 file.
Saving A Project
To save a G4 PanelBuilder project file (*.PB4):
1. 2. 3. 4.
Select File > Save. If this is the first instance of a save for your project, the Save As dialog launches. Type the File name in the field provided. Locate the directory you would like to save within. Place a check next to Package template with project file if you would like to include the .TPT file with the .PB4 file. Doing this will allow you to open the G4 PanelBuilder file on other machines running the application.
5. Click Save.
Select Save As if you would like to save your project under another name or different location.
1. 2. 3. 4.
Select File > Save As to launch the Save As dialog. Type the File name in the field provided. Locate the directory you would like to save within. Place a check next to Package template with project file if you would like to include the .TPT file with the .PB4 file. Doing this will allow you to open the G4 PanelBuilder file on other machines running the application.
5. Click Save.
When you generate a TPDesign4 project G4 PanelBuilder stores information to the .PB4 file. As a result the file will indicate being "dirty" or changed. You will need to save the .PB4 file.
G4 PanelBuilder
11
Basic Operations
Closing A Project
To exit an open project but leave G4 PanelBuilder running: Select File > Close. If you have not already saved, the Close Project dialog will prompt you. If the file save is current the file closes. When you generate a TPDesign4 project G4 PanelBuilder stores information to the .PB4 file. As a result the file will indicate being "dirty" or changed. You will need to save the .PB4 file.
Templates
Preview A Template via Template Manager
G4 PanelBuilder pages derive their look from templates (*.TPT files). Template Manager allows you access to all template files located on your computer. To preview any template located on your computer using Template Manager:
1. 2. 3. 4.
Select File > Template Manager to launch the Template Manager dialog. Double-click on the thumbnail of a template family. Select a thumbnail for one of the panel types within the family. Click on the Samples button to launch the Template Samples Images dialog.
1. First, launch the Template Manager dialog by selecting File > Template Manager. 2. Click the Install button in the bottom left corner. 3. Select either:
From AMX.com From File
1. 2. 3. 4. 5.
Select File > Template Manager to open the Template Manager dialog. In the bottom left corner of the dialog, select Install. Select From AMX.com from the drop-down list to launch the AMX.com Template Library dialog. Select a thumbnail of one of the template families. Click the Install button.
If the .TPT file already resides on your computer you will be prompted by the Replace Template dialog. Select on of the following: Yes - Confirms the replacement of the .TPT file on a panel-by-panel basis. Yes All - Confirms the replacement of all .TPT files at one time. No - Denies the replacement of the .TPT file on a panel-by-panel basis. No All - Denies the replacement of all .TPT files at one time.
12
G4 PanelBuilder
Basic Operations
Abort - Cancels the template import with no changes. If you replace a .TPT file that is referenced by a .PB4 file, it will be updated in the .PB4 file.
6. After the template has been installed, click Close. Install A Template from File
G4 PanelBuilder utilizes templates to apply appearances to panel pages. You can import your own local files as a template (.TPT) for use within G4 PanelBuilder.
1. Select File > Install Templates From File to launch the dialog. 2. Locate the .TPT file you would like to import. 3. Click Install.
Templates are identified by their job names. Regardless of file name, if the job name already exists, you are prompted by the Replace Template dialog. If you replace a .TPT file that is referenced by a .PB4 file, it will be updated in the .PB4 file.
1. 2. 3. 4.
Open the Template Manager dialog by selecting File > Template Manager. Select the thumbnail of the template to be removed. Click Remove at the bottom of the window. Confirm you have selected the appropriate template and click OK.
Opening A Project
To open a (*.PB4) file in G4 PanelBuilder:
1. Select File > Open to launch the Open Project dialog. 2. Select the file and click OK.
If a project is already open and you select open a new or existing project, you are prompted by the Save As dialog. The previous project will remain on screen until you are done setting up the new project.
1. With your project file open go to Project > Color Schemes to open the Color Schemes dialog. 2. Select the color scheme in the field and click OK.
While the color change is not reflected in the toolbox, you will see it if you select an element and go to Diagram > Preview.
G4 PanelBuilder
13
Basic Operations
1. 2. 3. 4.
Select File > New From File to launch the New From File dialog. Open your desired project file (*.PB4). The next window to open is the New project dialog. Select the new template to be used with the project. Click OK.
If a project is already open and you select open a new or existing project, you are prompted by the Save As dialog. The previous project will remain on screen until you are done setting up the new project.
1. Select File > Project Properties to launch the Project Properties dialog. 2. Place your cursor within the white fields to add and edit text.
To set a password for the project:
2. Type a password in the field provided. 3. Re-type the password within Confirm. 4. Click OK when all changes have been made.
Project properties differ from file properties established in TPDesign4. File properties entered in TPDesign4 are what is displayed in the Template Manager dialog.
1. 2. 3. 4. 5. 6.
Select the element within the diagram area. Select Diagram > Properties to open the Diagram Properties dialog. Click on the browse button (...) to launch the Unicode Edit dialog widow. Type the Unicode within the text field and the equivalent is displayed below. Click OK to close the Unicode Edit dialog. Click OK to close the Diagram Properties dialog.
14
G4 PanelBuilder
Basic Operations
The Unicode can now only be edited via the Unicode Edit dialog. If the element name and screen name differ, both are displayed within the node. If Unicode characters are specified but the template does not support the specified font a Unicode font is used only in those instances. To set the Unicode Font:
1. Select Project > Project Properties to open the Project Properties dialog. 2. From the drop down list, select the font G4 PanelBuilder is to use in the event the Unicode character font
is not supported.
3. Click OK.
1. Select an element in the Diagram area. 2. Select Diagram > Preview to launch the Diagram Preview dialog. This view is what the finished panel
will look like.
1. Select an element in either the toolbox or Diagram area. 2. Select Toolbox > Element Preview to launch the Template Sample Images dialog. 3. Click Close when you are finished.
1. Select the element thumbnail to be removed within the Toolbox. 2. Select Toolbox > Remove All Instances From Diagram.
1. Select the item in the Diagram area. 2. Select Edit > Delete.
G4 PanelBuilder
15
Basic Operations
1. Select Diagram > Copy Snapshot To Clipboard. 2. Open a graphic program, i.e., Paint or Photoshop and paste the image into it.
Even if you zoom in or out of the Diagram area, the default, 100%, view is used in creating a snapshot to clipboard.
Snap To Grid
The Diagram area allows you to visually arrange your panel pages and connect them to create a flow. To have the elements snap to the grid: Select Diagram > Snap To Grid. When the check is present the elements snap to the grid. The elements align according to the grid in the Diagram area.
1. Select Help > Web Update to check for updates. 2. If updates are available for the installed version of G4 PanelBuilder they will be downloaded at this time. 3. After the download is complete Web Update will close G4 PanelBuilder and the updates will be added.
If you do not have Web Update installed, you will receive a window indicating where it can be downloaded.
Exiting G4 PanelBuilder
After you have created a new touch panel page, generated it and saved it, you are ready to close G4 PanelBuilder. Select File > Exit. If you have not already saved a currently open project, you are prompted to do so now. Confirm, deny or cancel the changes.
16
G4 PanelBuilder
According to the table there are only 6 resolutions, the minimum number to make a template family, but 12 different panel types. You only need one template per resolution but you should consider instances such as the MVP-8400, where the Pixels Per Inch is higher than the CV12 and the MVP-7500's limited color depth. Both examples are situations where you might consider making specific templates for those panel types.
1. You should spend some time deciding what you want the panel to do. What navigation model are you
going to use? You know you're going to have the required template elements but are some of your menus so complex they will require sub-menus? What devices and features will the template include? Consider using some optional template elements. Careful consideration will reveal the type of navigation you will need. Things to remember: You must have a minimum of 1 Navigation element. You must have a minimum of 1 Placeholder element. You must have a main preview image ("[preview].jpg" or "[preview].png"). You cannot create a "drill-down" style of navigation with G4 PanelBuilder. Your navigation menus will always be on top of your Devices. Make sure they do not conflict with each other. Suggestion
Create a simple TPD4 file showing the desired output. Doing this gives you a starting point to begin looking at how to modify the TPD4 file to create a template.
2. You are ready to begin restructuring the elements to fit your needs. Start with the Device and Navigation
elements first and the Placeholder elements last. The key for creating your own elements naming conventions. G4 PanelBuilder looks for navigations with the name, [nav#navName]pageName.
G4 PanelBuilder
17
Suggestions
Start with the most complex Device element first, then make copies of it. This method allows you to modify and delete thus the pages are more likely to be similar. Also, create several different variations of Navigation and Sub-Navigations (3 items, 4 items, etc...).
3. Create the preview images for the elements. Images do not have to be full size, in fact AMX templates
utilize a 1/4 screen size to reduce the template file size. Suggestion
Mock up the interface in TPDesign4 by opening the corresponding page and display all applicable popups. Select Page > Copy Image To Clipboard. Then open the resource manager and select Paste. Now rename the new image to the appropriate element name.
4. After you have completed the template design, do a generate. A .TPT file is created and a list of errors
and warnings are displayed at this time, if applicable.
18
G4 PanelBuilder
1. Select a panel page that best represents the color scheme used. It is suggested you use the same panel
page for all color schemes to better show the color changes.
2. With the selected panel page open and active, select Page > Create Template Preview Image to open the
Create Template Preview Image dialog.
3. 4. 5. 6.
Set Element Type to Palette. The Name must match the name you used in step 2 of Define The Color Scheme. You can set the Scale, File Format and Compression at your discretion. Click OK.
You can now export the file as a template, open and use it within G4 PanelBuilder.
G4 PanelBuilder
19
Template Requirements
There are a few key items required of all templates. TPD4 will not allow you to create a template without: A minimum of 1 Navigation Element. A minimum of 1 Placeholder Element. A main preview image ("[preview].jpg" or "[preview].png").
FIG. 11
The template must have at least one of each of the following elements: Navigation Elements - This is the main menu where most of your navigation selections are made. Consists of at least one popup but can contain multiple popups. Cannot contain any pages Only one can be displayed at a time
20
G4 PanelBuilder
buttonName [title]buttonName
buttonName
Placeholder Elements - This is a blank device element that allows you to represent unique items in the diagram area. Consists of one page and may have optional popups. Only one Placeholder element can be displayed at a time. Placeholder Element Specific Conventions
[placeholder#placeholderName]pageName placeholderName pageName [info]buttonName This text is used to populate the mouse-over element description in the toolbox. buttonName [title]buttonName The name of the Placeholder element as it appears in G4 PanelBuilder. The base page name used in the generated TP4 project. Only one page or popup within a Placeholder element can contain an Info button. The Info button contains the page flip information for displaying the Placeholder element and can also contain an optional icon image. This is unused and the button is deleted in the generated TP4 project. The pages and popups in a Placeholder element can contain one or more Title buttons. The text is replaced with the name given to the Placeholder element in the generated TP4 project. The button name will be used in the generated TP4 project.
buttonName
G4 PanelBuilder
21
buttonName [title]buttonName
buttonName
Sub-Navigation Elements - This element is a submenu and can occur on screen with Navigation elements. Consists of at least one popup and can contain multiple popups. Cannot contain pages. Sub-Navigation Element Specific Conventions
[subnav#navName]pageName navName pageName [info]buttonName This text is used to populate the mouseover element description in the toolbox. buttonName [item]buttonName The name of the Sub-Navigation element as it appears in G4 PanelBuilder. The base page name that is used in the generated TP4 project. Only one of the popups in a Sub-Navigation element can contain an Info button, which contains the page flip information for displaying the Sub-Navigation element and can also contain an optional icon image. Unused; the button is deleted in the generated TP4 project. Popups in the Sub-Navigation element must contain at least one Item button that will contain navigation information. Item buttons are ordered in the Navigation element left-to-right then top-to-bottom. The button name used in the generated TP4 project. The popups in a Sub-Navigation element can contain one or more Title buttons. The text within the Title buttons are replaced with the name given to the Sub-Navigation in the generated TP4 project. The button name used in the generated TP4 project.
buttonName [title]buttonName
buttonName
22
G4 PanelBuilder
Splash Elements - This element is a popup that can contain an image, i.e., corporate logo. Consists of at least one popup and can contain multiple popups. Cannot contain pages. Splash Element Specific Conventions
[splash#splashName]pageName splashName pageName [info]buttonName This text is used to populate the mouseover element description in the toolbox. buttonName [title]buttonName The name of the Splash element as it appears in G4 PanelBuilder. The base page name that is used in the generated TP4 project. Only one of the popups in a Splash element can contain an Info button, which contains the page flip information for displaying the Splash element and can also contain an optional icon image. Unused; this button is deleted in the generated TP4 project. Popups in a Splash element can contain one or more Title buttons. The text within the buttons is replaced with the name given to the Splash element in the generated TP4 project. The button name used in the generated TP4 project.
buttonName
Device Elements - This element is the actual device used. For reference, consult AMX templates where we list the most commonly used devices. Consists of one page and can contain multiple popups. Only one Device element can be displayed at a time. Device Element Specific
[device#deviceName]pageName deviceName pageName [info]buttonName This text is used to populate the mouseover element description in the toolbox. buttonName [title]buttonName The name of the Device as it appears in G4 PanelBuilder. The base page name used in the generated TP4 project. Only one page or popup in a Device element can contain an Info button which contains the page flip information for displaying the Device element and can also contain an optional icon image. Unused; the button is deleted in the generated TP4 project. Pages and popups in a Device element can contain one or more Title buttons. The text within the buttons is replaced with the name given to the Device element in the generated TP4 project. The button name used in the generated TP4 project.
buttonName
G4 PanelBuilder
23
Feature Elements - This element resembles the Device element. However, there can only be one Feature element in a panel design, i.e., the "Clean Panel" feature. Consists of one page and can contain multiple popups. Only one Feature element can be displayed at a time. Feature Element Specific Conventions
[feature#featureName]pageName featureName pageName [info]buttonName This text is used to populate the mouseover element description in the toolbox. buttonName [title]buttonName The name of the feature as it appears in G4 PanelBuilder. The base page name that is used in the generated TP4 project. Only one page or popup in a Feature element can contain an Info button, which contains the page flip information for displaying the Feature element and can also contain an optional icon image. Unused; the button is deleted in the generated TP4 project. The pages and popups in the Feature element can contain one or more Title buttons, whose text is replaced with the name given to the Feature in the generated TP4 project. The button name that is used in the generated TP4 project.
buttonName
Sub-Feature Elements - This element represents the "universal" features that appear on many pages, i.e., "volume." Consists of at least one popup and can contain multiple popups. Cannot contain pages. Sub-Feature Element Specific Conventions
[subFeature#subFeatureName]pageName subFeatureName pageName [info]buttonName This text is used to populate the mouseover element description in the toolbox. buttonName [title]buttonName The name of the Sub-Feature element as it appears in G4 PanelBuilder. The base page name that is used in the generated TP4 project. Only one of the pages or popups in a Sub-Feature element can contain an Info button, which contains the page flip information for displaying the Sub-Feature element and can also contain an optional icon image. Unused; the button is deleted in the generated TP4 project. Popups in a Sub-Feature element can contain one or more Title buttons, whose text is replaced with the name given to the Sub-Feature element in the generated TP4 project. The button name that is used in the generated TP4 project.
buttonName
24
G4 PanelBuilder
When navigating to a Device, Feature or Placeholder element from a Sub-Navigation element: Hide all popups on the page for that element. Perform the standard page flip to the page for that element. Show any popups for the element. Show any popups for the linked Sub-Feature, when applicable. Show the Navigation element that is linked to the Sub-Navigation element or chain. For Sub-Navigations the user must set "Hide On Action" to No, then show the Sub-Navigation element that is linked to the element. Otherwise, the Sub-Navigation is not shown. Info buttons are optional and only have to be included within an element if the order the popup pages is shown is important, if not all popup pages should be initially shown, or if an icon is used on the corresponding Navigation or Sub-Navigation button. If the Info button is omitted, popup pages are shown in alphabetical order.
G4 PanelBuilder
25
26
G4 PanelBuilder
Program Reference
Program Reference
Dialogs
AMX.com Template Library dialog
G4 PanelBuilder project files (*.PB4) derive their style from templates. In addition to making your own templates, you can download AMX created templates. Browsing through online template files is done so through the AMX.com Template Library dialog.
Template Family Thumbnail Template Family Properties
Cancel Filter Option (Show modified) Samples Install Template Collapse All Families Expand All Families
Template Family Panel Types Panels available for use within the selected family. Samples Show only new or modified templates Expand All Collapse All Install Cancel
G4 PanelBuilder
27
Program Reference
28
G4 PanelBuilder
Program Reference
Connections The connections displays how many are available and what the displayed name is within the currently selected node. This text is what is displayed on the buttons of the selected panel page. To edit, click in the text field and either begin typing or select the browse button (...). The browse button opens a text entry field that will allow you to see the Unicode Send Command Value. Once you have input the text, click OK to return to the Diagram Properties dialog with the changes or click Cancel to return with no changes. OK Cancel Returns to the Diagram area with changes. Aborts changes and returns to the Diagram area.
G4 PanelBuilder
29
Program Reference
An error will keep the element from working while warnings work but are replaced with the element closest matching the original element. Click Close to confirm and continue to the project file.
30
G4 PanelBuilder
Program Reference
Template Thumbnail
Cancel Samples Filter Option (Show modified) Install Template Collapse All Families Expand All Families
Template Family Panel Types Panels available for use within the selected family. Samples Show only new or modified templates Expand All Collapse All Install Cancel
G4 PanelBuilder
31
Program Reference
Template Properties
Template Family Thumbnail Thumbnail graphics for templates that meet the criteria established in the panel type and resolution fields. If no suitable templates are available the message, No Compatible Templates For Selected Panel Type, will appear. An exclamation point will appear in the top right of a thumbnail that can be used for the panel type but was not originally designed for that use. Some images within the panel pages could require alterations. Template Properties The template properties are: Template family file name Designer - Name of the individual that created the template Description - A brief note or special interest for the selected template appears here. Revision - The version number of the selected template. Elements - A expandable selection of all elements with their number of available selections. Previews button OK button Cancel button Launches the Template Sample Images dialog. Accepts selections made and opens the project into the G4 PanelBuilder Application Interface area. Cancels opening a new project file and returns to the applications.
32
G4 PanelBuilder
Program Reference
File Version
Password Confirmation
G4 PanelBuilder
33
Program Reference
Save As dialog
The Save As dialog is a typical Windows dialog. Browse to where you want the project file saved. Select Cancel to return to the application. There is one difference within this dialog. In the bottom left is a checkbox called, Package templates with project file. When saving a G4 PanelBuilder project file, check this option to save the template with the project file. This embeds the .TPT file with the .PB4 file. This feature allows you to transport .PB4 files to other computers that have G4 PanelBuilder without concern for the template file (*.TPT). When loading the .PB4 file and the .TPT file isn't found, G4 PanelBuilder installs the .TPT file. When loading the .PB4 file and the .TPT file is found, G4 PanelBuilder uses the resident .TPT file. When loading the .PB4 file and the .TPT file is found but there are differences, G4 PanelBuilder will prompt you for which .TPT file to use.
34
G4 PanelBuilder
Program Reference
G4 PanelBuilder
35
Program Reference
Text Field
Unicode Value
36
G4 PanelBuilder
Program Reference
Context Menus
Diagram Area Context Menu
The Diagram area context menu is a quick list of commonly used functions. To access the context menu, rightclick within the Diagram area. Diagram Area Context Menu
Add Element Properties Preview Delete Snap To Grid Zoom Out Zoom In Zoom A complete list of available elements within your selected template. Select any element to have it placed within the Diagram area. Launches the Diagram Properties dialog. This feature views the properties of the selected element within the Diagram area. Launches the Diagram Preview dialog. Deletes the element currently selected in the Diagram area. Locks all element placements to grid lines. Decreases the magnification of the diagram area. Increments are 150%, 125%, 100%, 75% and 50% of work area. Increases the magnification of the diagram area. Increments are 150%, 125%, 100%, 75% and 50% of work area. A list of available increments to zoom into or out of the diagram area. Click on the desired magnification to implement.
Copy Snapshot To Clipboard Copies only the diagram area to your computer's clipboard.
Visual Style A list of visual appearances for the G4 PanelBuilder. Select one of the following:
G4 PanelBuilder
37
Program Reference
38
G4 PanelBuilder
Program Reference
G4 PanelBuilder
39
12/08
2008
AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time.