Tib Gi Pe Ui Reference

TIBCO General Interface Builder GUI Reference
Professional Edition Software Release 3.2 November 2006
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN TIBCO GENERAL INTERFACE BUILDER GETTING STARTED GUIDE). USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIB, TIBCO, Information Bus, The Power of Now, TIBCO General Interface, and TIBCO General Interface Builder are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. PLEASE SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright 2001-2006 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information
| iii
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii TIBCO General Interface Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Further Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Chapter 1 Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Project Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Tools Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Palettes Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Context Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Palette Context Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Work Area Context Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Taskbar Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 XML Mapping Utility Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 2 Toolbar Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Work Area Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Attributes Editor Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Component Hierarchy Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Component Libraries Palette Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Local Data Cache Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Project Files Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Recycle Bin Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 System Log Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 XSL Parameters Palette Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 JavaScript Test Utility Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 JavaScript Step Through Debugger Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 XML Mapping Utility Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Rules Tree Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
iv
| Contents
Mapper Log Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Test Interface Tool Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Taskbar Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 3 Dialogs and Tools Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

File Profile Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 IDE Settings Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IDE Settings Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IDE Hot Keys Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paths Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Project Settings Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployment Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Add-Ins Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Classpath Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Legacy Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deployment Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HTML Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Launch Link Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inline Div Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 37 39 39 40 41 41 43 44 44 44 46 46 46 47
Color Picker Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Find and Replace Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 JavaScript Test Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 XML Mapping Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rules Tree Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rule Profile Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapper Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Test Interface Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 50 51 52 57 57
XML/XSL Merge Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Chapter 4 Prototype Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Cross-browser Box Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Form Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Matrix Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Contents v
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Menus and Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Chapter 5 Charting Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Area Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Area Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Bar Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Bar Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Bubble Series. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Category Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Chart Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Column Chart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Column Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Grid Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Line Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
vi
| Contents
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Line Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Linear Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Logarithmic Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Pie Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Pie Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Plot Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Point Series. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
| vii
Preface
TIBCO General Interface Builder is a development environment for building rich internet applications. The object modeling features of General Interface Builder enable developers to quickly create reusable GUI components and assemble them into full applications or application modules. Applications can be accessed in a web browser from a URL, existing HTML page, or portal environment. Related Documentation, page viii Typographical Conventions, page ix How to Contact TIBCO Customer Support, page xi
viii
| Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
TIBCO General Interface Documentation

The following documents form the TIBCO General Interface documentation set: TIBCO General Interface Builder Getting Started Guide Read this manual for overview information, installation instructions, and information on how to build TIBCO General Interface applications. TIBCO General Interface Builder GUI Reference Refer to this manual to learn more about menus, dialogs, tools, toolbars, and components. TIBCO General Interface API Reference Refer to this online help content for descriptions of the TIBCO General Interface JavaScript API functions and methods. TIBCO General Interface Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release.
To open the documentation in the product, choose Help > Help Contents. Documentation is also available online at http://developer.tibco.com.
Further Information
For further information on TIBCO General Interface Builder, visit TIBCO Developer Network at http://developer.tibco.com, a comprehensive community that provides opportunities to increase your understanding of TIBCO General Interface Builder. Among the many resources at this web site you will find: Video tutorials Sample projects Product documentation Best practices documents Forums
Preface ix
Typographical Conventions
The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention
code font
Use Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process.
bold code font
Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type the username
admin.
In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default value.
italic font
Italic font is used in the following ways: To indicate a document title. For example: See TIBCO BusinessWorks Concepts for more details. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname
Key combinations
Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.
| Typographical Conventions
Table 2 Syntax Typographical Conventions Convention

[ ]
Use An optional item in a command or code syntax. For example:

MyCommand [optional_parameter] required_parameter
A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3
bold code font
In command syntax, indicates the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
{ }
A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either param1 and param2 or param3 and param4:
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
Preface xi
How to Contact TIBCO Customer Support

The Professional Edition of TIBCO General Interface is unsupported. If you would like support for this product, you may upgrade to the Enterprise Edition and purchase a Support Contract. For self-service support, education, and access to the TIBCO Developer Network, visit http://developer.tibco.com. For an overview of TIBCO Support Services and information about getting started with TIBCO Product Support, visit this site http://www.tibco.com/services/support.
xii
| How to Contact TIBCO Customer Support
|1
Chapter 1
Menu Commands
This chapter describes TIBCO General Interface Builder menu commands. For an overview of the TIBCO General Interface Builder user interface and its components, see Interface Basics in TIBCO General Interface Builder Getting Started Guide.
Topics
Project Menu, page 2 File Menu, page 3 Tools Menu, page 6 Palettes Menu, page 7 Help Menu, page 8 Context Menus, page 9
| Chapter 1
Menu Commands
Project Menu
The Project menu includes the following commands. Command New Project Description Displays a prompt to create a new project and opens the new project in the same browser window. A default project directory structure is also created on the file system. Displays a list of the last ten projects that were opened. Clicking a project name opens the project. Displays a list of all projects in the workspace/JSXAPPS folder. Clicking a project name opens the project. Displays the Project Settings dialog for configuring project deployment, add-ins, class path, and legacy settings for the open project. Displays the Deployment Utility which is used to generate code for deploying the application in a browser. Create an HTML or XHTML launch page for standalone applications or generate HTML code to insert applications into an existing web page. Runs the current project configuration in a new browser window to simulate the runtime environment. The project runs in the same mode asTIBCO General Interface Builder, such as HTML or XHTML. Runs the project in a new browser window on a local HTTP server as specified on the Paths page of the IDE Settings dialog. If the HTTP server isnt configured, you are prompted to configure it.
Recent Projects User Projects
Project Settings
Deployment Utility
Run Project
Run Project from HTTP
File Menu 3
File Menu
The File menu includes the following commands. Command New GUI Component XML Document Submenu Command Description Creates a new, empty tab in the work area for the selected file type. Creates an empty GUI component file. Save with the .xml extension in the components directory of the project. Creates an empty XML file for content data, such as default values, for the application. Save with the .xml extension in the xml directory of the project. Creates an empty XSL file for transforming XML files containing application data. Save with the .xsl extension in the xsl directory of the project. Creates an empty JavaScript file. Save with a .js extension in the js directory of the project. Creates an empty CSS file for defining application styles. Save with a .css extension in the css directory of the project. Creates an empty dynamic properties resource file. Save with the .xml extension in the jss directory of the project. See Dynamic Properties Files in TIBCO General Interface Builder Getting Started Guide. Creates an empty mapping rules file for connecting to web services. Save with the .xml extension in the rules directory of the project. See Mapping Components to XML Nodes in TIBCO General Interface Builder Getting Started Guide.
XSL Document
JavaScript File CSS File
Dynamic Properties File
Mapping Rule
| Chapter 1
Menu Commands
Command Open Recent Files
Submenu Command
Description Displays the File dialog for opening an existing file for use in the application. Displays a list of recently created files. Clicking a file name opens that file in the project. Closes the active tab. If the file contains unsaved changes, you are prompted to save the file. Closes tabs for all open files. If a file contains unsaved changes, you are prompted to save the file. Displays a Confirm Revert dialog where you can choose to revert the active file to the last saved state. After reloading, any recycled objects are cleared from the Recycle Bin and cannot be recovered.
Close
Close All
Revert
Revert All
Displays a Confirm Revert dialog where you can choose to revert all open files to the last saved state. After reloading, any recycled objects are cleared from the Recycle Bin and cannot be recovered.
Save Save to Cache
Saves the active file. For an XML document, saves the active file to the in-memory, local data cache.
File Menu 5
Command Save and Reload
Submenu Command
Description Saves the active file to disk and reloads the file appropriate to the file type. For example, JavaScript files (.js) are reloaded into the browser memory space to reflect the updated code. After reloading, any recycled objects are cleared from the Recycle Bin and cannot be recovered. This menu isnt available for open data cache files.
Save As Save a Copy to Disk Save All
Saves the active file with a different file name. For a cache document, opens the Save File dialog where you can enter a new file name and save the file to disk. Saves all open files in the project.
| Chapter 1
Menu Commands
Tools Menu
For more information on tools, see Tools in TIBCO General Interface Builder Getting Started Guide. Command XML/XSL Merge Tool Description Displays the XML/XSL Merge utility, which displays the results of applying an XSLT document. You can open multiple instances of this tool. Displays a list of TIBCO General Interface communications add-ins that have been installed, such as the XML Mapping Utility. Displays the Color Picker utility for choosing color values. Displays the JavaScript Test Utility for testing JavaScript code. Displays a search dialog for searching and replacing text in open text files. Displays a dialog for setting preferences for the visual authoring environment, such as IDE settings, IDE hot keys, and paths.
Communications
Color Picker JavaScript Test Utility Find and Replace IDE Settings
Palettes Menu 7
Palettes Menu
The Palettes menu includes the following palettes. Each of these palettes has a context menu. See Palette Context Menus on page 9. For more information on palettes, see Object Modeling Palettes in TIBCO General Interface Builder Getting Started Guide. Keyboard Shortcut Ctrl+1 Ctrl+2 Ctrl+3 Ctrl+4 Ctrl+5 Ctrl+6 Ctrl+7 Ctrl+8 Ctrl+9
Command Component Hierarchy Properties Editor Events Editor Attributes Editor XSL Parameters Component Libraries Local Data Cache Project Files Recycle Bin
Description Displays or hides the Component Hierarchy palette. Displays or hides the Properties Editor palette. Displays or hides the Events Editor palette. Displays or hides the Attributes Editor palette. Displays or hides the XSL Parameters palette. Displays or hides the Component Libraries palette. Displays or hides the Local Data Cache palette. Displays or hides the Project Files palette. Displays or hides the Recycle Bin palette. Objects that have been deleted using the Component Hierarchy palette can be recovered from the Recycle Bin. Displays or hides the System Log palette.
System Log
Ctrl+l (lowercase L)
| Chapter 1
Menu Commands
Help Menu
The Help menu includes the following commands. Command API Documentation Description Provides full documentation of the TIBCO General Interface APIs organized by class. You can view the API documentation in a dialog, a separate window, or the HTML version in a browser window. Opens the TIBCO General Interface Builder documentation in a web browser. Provides a link to TIBCO Developer Network at http://developer.tibco.com for TIBCO General Interface feature updates, discussion forums, tips, samples, tutorials, and documentation to assist the application development process. Provides links to JavaScript, XSLT, DHTML, and VML reference resources on the Microsoft Developers Network web site, as well as to the Regular Expressions Guide at Mozilla. Provides version information for TIBCO General Interface and TIBCO General Interface Builder, as well as important legal notices. Displays the License Agreement for the product.
Help Contents TIBCO Developer Network
Internet Resources
About TIBCO General Interface License Agreement
Context Menus 9
Context Menus
To access a context menu, right-click an area of the user interface or right-click an object in a palette, such as a file name in the Project Files palette. For Mac, use Ctrl+click. Press the Escape or Left Arrow keys to close the menu.
Palette Context Menus

This section describes the context menu for each palette. Attributes Editor Palette Context Menu Command Remove Attribute Description Removes the selected attribute.
Component Hierarchy Palette Context Menu Submenu Command
Command Clone
Description Creates an exact copy of the selected object and any children. The new object is added as the last child of the selected objects parent object. Repaints the Live Component view in the work area to reflect changes. Refreshes the data in the cache and repaints the Live Component view in the work area. Available for objects that implement jsx3.xml.Cacheable.
Repaint Re-Fetch Data and Repaint Persistence Transitory
Sets the selected component to transitory. When the component file is saved, the transitory object is not saved to disk.
10
| Chapter 1
Menu Commands
Command
Submenu Command Embedded
Description Embeds the selected component. When the component file is saved, the embedded object is saved to disk. By default, components from the Component Libraries palette are embedded. Sets the selected component to a reference. A referenced component is a link to a component file. For example, <include
src="workspace/prototypes/greenbutton.x ml" async="false"/>.
Referenced
The name of a referenced component in the Component Hierarchy palette is displayed using blue italic font. Sets the selected component to an asynchronous reference. An asynchronous referenced component is a link to a component file that loads asynchronously. For example, <include
Referenced Asynchronous
src="workspace/prototypes/greenbutton.x ml" async="true"/>. The name of a referenced component in the Component Hierarchy palette is displayed using green italic font.
Import
Embedded Referenced
Imports a copy of a component. When saved, the component is saved to disk. Imports a link to a component file, not the actual contents of the component. For example, <include
src="workspace/prototypes/greenbutton.xm l" async="false"/>. The name of a referenced component in the Component Hierarchy palette is displayed using blue italic font.
Context Menus 11
Command
Submenu Command Referenced Asynchronous
Description Imports a link to a component file asynchronously, not the actual component. For example, <include
src="workspace/prototypes/greenbutton.x ml" async="true"/>. The name of a referenced component in the Component Hierarchy palette is displayed using green italic font.
Export
As XML As HTML
Exports the selected DOM branch as an XML file, which can then be used in other projects. Exports the selected DOM branch as an HTML file. This is useful for testing and printing. Moves the selected object to the Recycle Bin. There is a separate Recycle Bin for each GUI component. Moves all descendants of the selected object to the Recycle Bin. There is a separate Recycle Bin for each GUI component. Copies the objects name to the clipboard. Copies the objects Getter code to the clipboard. For example,
myAddressLookup.getJSXByName("block")
Recycle Self
Recycle Descendants Copy Name to Clipboard Copy Getter Code to Clipboard
Component Libraries Palette Context Menu
Command Copy Path
Description Copies the path of the selected component to the clipboard. For example, the path for the Dialog component would be
GI_Builder/prototypes/Containers/Dialog.xml.
12
| Chapter 1
Menu Commands
Events Editor Palette Context Menu To access the context menu in the Events Editor palette, right-click a cell in the Value column. Command Reset/Clear Description Clears the value field of the selected row.
Local Data Cache Palette Context Menu Command View/Edit View Markup Copy Name Copy Source Remove from Cache Description Opens the selected cache document in the work area. Opens the selected document in the work area as a read-only, formatted file. Copies the name of the document to the clipboard. Copies the selected documents source to the clipboard. Removes and deletes the selected document from the in-memory cache.
Project Files Palette Context Menu Command Edit Edit Profile Description Opens the selected file in the work area for editing. Displays the File Profile dialog where you can modify the file ID, file type, file URI, and whether the file auto loads or not. See File Profile Dialog on page 34. Sets the selected file(s) to auto load when the application runs. Dereferences the selected file and removes it from the project. The file is not deleted from disk. Loads or reloads selected files from disk into browser memory.
Auto Load Dereference Load/Reload
Context Menus 13
Command Copy Path
Description Copies the file path to the clipboard. For example, js/logic.js.
XSL Parameters Palette Context Menu Command Remove Parameter Description Removes the selected parameter.
14
| Chapter 1
Menu Commands
Work Area Context Menus

The work area context menus include menus for the work area tabs and the work area editors. Work Area Tabs Context Menu The tabs at the top of the work area have a context menu. Command Close Revert Save Save to Cache Save and Reload Description Closes the selected file. Revert to the previously saved version of the file. Saves the file. For a cache document, saves it to the cache. Saves the active file to disk and reloads the file appropriate to the file type. For example, JavaScript files (.js) are reloaded into the browser memory space to reflect the updated code. After reloading, any recycled objects are cleared from the Recycle Bin and cannot be recovered. This menu isnt available for open data cache files. Save a Copy to Disk Save As For a cache document, displays the Save File dialog where you can save the file to disk. Displays the Save File dialog where you can save the file with a different name and to a different location.
If a file is read-only, a Lock icon displays on the work area tab. To open a locked, read-only file, double-click the Lock icon.
Context Menus 15
Work Area Editors Context Menus For text and XML files, there is a context menu in the work area. Command Wrap Text Unwrap Text Description Wraps the text in the work area so all of the text is visible without horizontal scrolling. Displays the text without any wrap.
Taskbar Context Menu

To access the taskbar context menu, right-click the project name link at the bottom left of the TIBCO General Interface Builder user interface. Command Copy Namespace to Clipboard Copy Path to Clipboard Project Settings Description Copies the project namespace to the clipboard. Copies the project path to the clipboard. For example, workspace/JSXAPPS/myAddressLookup. Displays the Project Settings dialog where you can modify project settings, such as deployment, add-ins, class path, and legacy settings. See Project Settings Dialog on page 41. Runs the project in a new browser window.
Run Project
XML Mapping Utility Context Menu

The XML Mapping Utility has a context menu in the Rules Tree panel. Rules Tree Context Menu The Rules Tree context menu has the following commands. Command Add New Rule Submenu Command Description Adds a new rule to the selected rule.
16
| Chapter 1
Menu Commands
Command
Submenu Command Element Attribute
Description Adds a new element rule to the selected node. Adds a new attribute rule to the selected node. Attributes associate name-value pairs with elements. Adds a new CDATA rule to the selected node. Text in a CDATA section is ignored by the XML parser. CDATA sections begin with the string <![CDATA[ and end with the string ]]>. Reparse the deleted children of a selected rule node. Displays the Reparse Selected Branch dialog. Click Reparse to reparse the selected node. Note that reparsing removes any existing descendants rules of the selected node. Displays a sample input message for the selected request node and a sample output message for the selected response node. Runs a test on the selected operation node in the Rules Tree.
CDATA
Reparse
Sample Message Execute (Quick Test)
| 17
Chapter 2
Toolbar Commands
This chapter describes TIBCO General Interface Builder toolbar commands.
Topics
Work Area Toolbar, page 18 Attributes Editor Palette Toolbar, page 19 Component Hierarchy Palette Toolbar, page 20 Component Libraries Palette Toolbar, page 21 Local Data Cache Palette Toolbar, page 22 Project Files Palette Toolbar, page 23 Recycle Bin Palette Toolbar, page 24 System Log Palette Toolbar, page 25 XSL Parameters Palette Toolbar, page 26 JavaScript Test Utility Toolbar, page 27 JavaScript Step Through Debugger Toolbar, page 28 XML Mapping Utility Toolbar, page 29 Taskbar Toolbar, page 32
18
| Chapter 2
Toolbar Commands
Work Area Toolbar

The work area provides several views of the open file. These views are available from the work area toolbar to the lower right of the work area. Button Description Displays the active file in Live Component view. This view is available for GUI components and dynamic properties files. Displays the active file in Source XML/Source Text view. This view is available for all file types.
Displays the active file in Formatted Source XML view. This view is read-only and is available for XML, XSL, dynamic properties, and GUI component files. Displays the active file in Rendered HTML view. This view is read-only and is available only for GUI components. Displays the active file in Component Profile view. This view is available only for GUI components. For more information, see Work Area Views in TIBCO General Interface Builder Getting Started Guide.
Attributes Editor Palette Toolbar 19
Attributes Editor Palette Toolbar

The Attributes Editor palette toolbar has the following buttons: Button Description Controls docking options for the palette, which include the following:
Fixed Positions the palette in the selected quadrant. Floating Floats the palette, which can be moved and minimized. Close Closes the palette.
Adds the specified name-value pair to the component definition as an HTML attribute and value. Type values in the Name and Value fields and click the Add button to add the attribute. The addition is visible in the component definition (Source XML view) and in the Rendered HTML view in the work area. For example, <properties
mycolor="red"/>.
Press the Enter key to navigate the Attributes Editor palette fields.
20
| Chapter 2
Toolbar Commands
Component Hierarchy Palette Toolbar

The Component Hierarchy palette toolbar has the following buttons: Button Description Controls docking options for the palette, which include the following:
Creates an exact copy of the selected object and any children. The new object is added as the last child of the parent of the selected object. Repaints the Live Component view of the selected object in the work area to reflect changes. Refreshes the data in the cache and repaints the Live Component view in the work area. Available for objects that implement jsx3.xml.Cacheable. Moves the selected object to the Recycle Bin. There is a separate Recycle Bin for each GUI component. Moves all descendants of the selected object to the Recycle Bin. There is a separate Recycle Bin for each GUI component. Shows or hides the focus rectangle in the work area. Most GUI objects can be selected in the work area using Ctrl+click. This button is off by default, because it can interfere with interactions and events of the selected objects children. Toggle snap-to-grid behavior for objects in the work area.
Synchronizes the Component Hierarchy palette with the current version of the hierarchy on disk.
Component Libraries Palette Toolbar 21
Component Libraries Palette Toolbar

The Component Libraries palette toolbar has the following buttons: Button Description Controls docking options for the palette, which include the following:
Fixed Positions the palette in the selected quadrant. Floating Floats the palette, which can be moved and
minimized.
Close Closes the palette.
Synchronizes the Component Libraries palette with the current version of the libraries on disk.
22
| Chapter 2
Toolbar Commands
Local Data Cache Palette Toolbar

The Local Data Cache palette toolbar has the following buttons: Button Description Controls docking options for the palette, which include the following:
Opens the selected file in a tab in the work area, where it can be edited. Opens the selected file in the Formatted Source XML view.
Removes the selected file from cache.
Project Files Palette Toolbar 23
Project Files Palette Toolbar

The Project Files palette toolbar has the following buttons:
Button
Description Controls docking options for the palette, which include the following:
Creates a new tab in the work area for the selected file type.
Displays the Open File dialog for adding an existing file to the project. Also opens the file in a tab in the work area. Opens the selected file in the project in a tab in the work area.
Opens the File Profile dialog, where you can edit file ID, type, Auto Load, and URI values for the selected file. See File Profile Dialog on page 34. Removes the selected file from the project. The file is not deleted from disk. Loads or reloads selected file(s) in the work area.
Rescans project files from disk.
24
| Chapter 2
Toolbar Commands
Recycle Bin Palette Toolbar

The Recycle Bin palette toolbar has the following buttons: Button Description Restores the selected recycled objects.
Empties all objects in the Recycle Bin and deletes them from memory. Deleted items cant be recovered.
System Log Palette Toolbar 25
System Log Palette Toolbar

The System Log palette toolbar has the following buttons: Button Description Controls docking options for the palette, which include the following:
Bottom Positions the palette at the bottom of the IDE. Floating Floats the palette, which can be moved and minimized. Window Opens the palette in a separate browser window, which is independent of TIBCO General Interface Builder. Close Closes the palette.
Clears the contents of the System Log palette.
INFO, DEBUG,
Controls the message log level. Choose from OFF, FATAL, ERROR, WARN, or TRACE.
26
| Chapter 2
Toolbar Commands
XSL Parameters Palette Toolbar

The XSL Parameters palette toolbar has the following buttons: Button Description Controls docking options for the palette, which include the following:
Adds the specified name-value pair to the component definition as an xslparameters element. Type values in the Name field or use the type-ahead feature to select a name from the drop-down list. Enter a value in the Value field and click the Add button to add the parameter. The addition is visible in the component definition (Source XML view) and the Rendered HTML view in the work area. For example, <xslparameters
jsx_rowbg2="#efefff"/>. jsx_rowbg1="#ffffff"
Press the Enter key to navigate the XSL Parameters palette fields.
JavaScript Test Utility Toolbar 27
JavaScript Test Utility Toolbar

The JavaScript Test Utility toolbar has the following buttons: Button Description Executes the JavaScript code in the upper panel.
Opens the JavaScript Step Through Debugger. This tool is only supported in General Interface Builder when running in Internet Explorer. To debug in Firefox, use the Venkman extension. Visit http://getahead.ltd.uk/dwr/ajax/venkman/. Displays a history of the ten most recently executed code snippets to choose from and restore.
28
| Chapter 2
Toolbar Commands
JavaScript Step Through Debugger Toolbar
The JavaScript Step Through Debugger is only supported in Internet Explorer. To debug in Firefox, use the Venkman extension. Visit http://getahead.ltd.uk/dwr/ajax/venkman/. The JavaScript Step Through Debugger toolbar has the following buttons: Button Description Executes only the highlighted line of JavaScript code.
Skips the highlighted line of JavaScript code and advances the selection bar to the next line. Executes all JavaScript code in the upper panel.
Cancels any current debugging operation and closes the utility.
XML Mapping Utility Toolbar 29
XML Mapping Utility Toolbar

The XML Mapping Utility has the following buttons on the top toolbar. Other areas of the XML Mapping Utility also have toolbars. Button Description Creates a new rules file with component mappings.
Opens an existing rules file for viewing and editing.
Saves the current mappings in a rules file.
Saves the current mappings with a new file name.
Rules Tree Toolbar

The Rules Tree toolbar has the following buttons: Button Name Test Command Description Launches the Test Interface Tool where you can step through and execute operations in the Rules Tree. Automatically maps nodes to GUI components and CDF elements. CDF Attribute Creates a CDF attribute mapping using the rule name as the attribute name. Creates a CDF record mapping and attribute mappings for descendant elements and attributes.
Map
CDF Record
30
| Chapter 2
Toolbar Commands
Button
Name
Command DOM (Map and Create)
Description Creates a new Form element and adds it to the active selection within the the DOM palette. Also creates the mapping. Removes selected mappings.
Detach
Mappings Restrictions Headers Delete
Removes all mapping rules for the selected node. Removes all restrictions for the selected node. Removes all HTTP headers for the selected node. Deletes a rule or all unselected rules.
Selected Rules Unselected Sibling Rules Generate
Deletes the selected rules from the tree. Deletes all siblings of the selected items from the tree. Generates JavaScript code for the selected operation and places it on the clipboard for pasting into a JavaScript file. The rules file must be saved first.
Mapper Log Toolbar

The Mapper Log toolbar has the following buttons: Button Description Clears the mapper log.
XML Mapping Utility Toolbar 31
Button
Description
WARN, INFO, DEBUG,
Controls the message log level. Choose from OFF, FATAL, ERROR, or TRACE.
Test Interface Tool Toolbar

The Test Interface toolbar has the following buttons: Button Description Resets the tester.
Starts or resumes the test.
Pauses the test.
(Receive tab) Generates alternate inbound message.
32
| Chapter 2
Toolbar Commands
Taskbar Toolbar
The taskbar is located at the at the bottom left of the TIBCO General Interface Builder user interface. The taskbar toolbar has the following buttons: Button Description Opens the project directory in a new browser window. Right-click this hyperlink to access the taskbar context menu. See Taskbar Context Menu on page 15. Shows the work area and the palettes.
Shows the work area only and hides all palettes.
| 33
Chapter 3
Dialogs and Tools Field Descriptions
This chapter describes the fields of TIBCO General Interface dialogs and tools. For an overview of TIBCO General Interface Builder tools, see Tools in TIBCO General Interface Builder Getting Started Guide.
Topics
File Profile Dialog, page 34 IDE Settings Dialog, page 37 Project Settings Dialog, page 41 Color Picker Tool, page 45 Deployment Utility, page 46 Find and Replace Tool, page 48 JavaScript Test Utility, page 49 XML Mapping Utility, page 50 XML/XSL Merge Tool, page 59
34
| Chapter 3
File Profile Dialog

To open the File Profile dialog, right-click a file in the Project Files palette and choose Edit Profile. You can also select a file and click the Edit Profile button on the Project Files palette toolbar. Command ID Description ID of the file generated by TIBCO General Interface. This ID can be modified but must be unique. Type of file, such as GUI Component, JavaScript, CSS, XML, XSLT, or Dynamic Properties Sets how files are loaded. Available options vary by file type.
Type
Auto Load
File Profile Dialog 35
Command Auto Load JavaScript Files
Description For more information on how JavaScript files are loaded, see Class Loading in TIBCO General Interface Builder Getting Started Guide.
Manually/As Needed The JavaScript file is
dynamically loaded when its needed. For the file to be loaded automatically, it must be registered in a class path on the Classpath page of the Project Settings dialog (Project > Project Settings) or loaded using a jsx3.require() method call. Otherwise, it can only be loaded programmatically with the Server.loadResource() method. If a JavaScript class file is registered on a class path, it doesnt need to be registered as a project resource to be dynamically loaded.
At Full Init If the jsxlt parameter is set to
false or is missing, the JavaScript file is loaded when the application loads.
At Light Init If the jsxlt parameter is set to

true,
the JavaScript file is loaded when the application loads. loaded when the application initializes. When this option is selected, the file name in the Project Files palette is displayed in bold.
At Init The JavaScript file is automatically
36
| Chapter 3
Command Auto Load CSS Files Dynamic Properties Files Mapping Rules Files XML and XSL Files
Description
Manually The file is loaded programmatically with the loadResource() or loadInclude() method.
Note: Its not recommended to load CSS files programmatically, because they can be very slow to load. XML and XSL files are typically set to Manually. They can also be loaded into cache using the XML URL property in the Properties Editor palette. Rules files are typically set to Manually.
At Init The file is automatically loaded when
the application initializes. GUI Component Files The Auto Load option is disabled for GUI component files. You can specify a GUI component file to automatically load when the application initializes in the Initial Component field on the Deployment page of the Project Settings dialog. The path of the file relative to the project folder.
URI
Buttons
The following buttons are on the bottom right of the File Profile dialog: Button Apply Save Cancel Description Applies the changes but doesnt close the dialog. Saves the changes and closes the dialog. Cancels any changes and reverts back to the last saved version.
IDE Settings Dialog 37
IDE Settings Dialog

In the IDE Settings dialog, you can modify TIBCO General Interface Builder integrated development environment (IDE) preferences for the visual authoring environment. The options in this dialog allow you to customize the IDE, modify and add keyboard shortcuts for menus, and set paths. Settings in this dialog are saved to workspace/settings/builder.xml. For more in-depth discussion of some of these options, see Setting Preferences in TIBCO General Interface Builder Getting Started Guide.
IDE Settings Page

The IDE Settings page displays options for the TIBCO General Interface IDE. Field Output character encoding Description Specifies the character encoding to use when saving files, such as UTF-16. If this field is empty, the default is used, which is system-dependent. Click the Test button to verify that the specified encoding can be written and that its available on the system. For Internet Explorer, encoding behavior varies according to Microsoft Windows updates and security settings, which might need to be modified. UTF-16 and the default system encoding should be supported regardless. If the test fails for other encodings, you might need to enable the ADODB.Stream object. See "How to disable the ADODB.Stream object from Internet Explorer" at http://support.microsoft.com/default.aspx?kbid=870 669 and reverse the instructions to enable it. Output line separator Specifies the line separator by operating system, such as UNIX, Mac OS, or Microsoft Windows.
38
| Chapter 3
Field Instead encode XML files as
Description Specifies the character encoding to use when saving XML files. This setting overrides the XML declaration, if any. Check the Add character encoding to XML declarations option to modify the encoding in the XML declaration. Click the Test button to verify that the specified encoding can be written and that its available on the system. If this option isnt set, the setting in the previous Output character encoding field is used. For Internet Explorer, encoding behavior varies according to Microsoft Windows updates and security settings, which might need to be modified. UTF-16 and the default system encoding should be supported regardless. If the test fails, you might need to enable the ADODB.Stream object. See "How to disable the ADODB.Stream object from Internet Explorer" at http://support.microsoft.com/default.aspx?kbid=870 669 and reverse the instructions to enable it.
Add character encoding to XML declarations
Adds the encoding, specified in the Instead encode XML files as field, to the XML declaration. For example, if UTF-8 is specified, the XML declaration would look like this:
<?xml version="1.0" encoding="UTF-8" ?>
Give DOM focus to newly added GUI objects Warn before dereferencing a project resource file Warn before removing documents from the local XML cache
Specifies whether to assign focus to a new object in the Component Hierarchy palette and the work area after its created. Specifies whether to display a warning dialog before a file is dereferenced in the Project Files palette. Specifies whether to display a warning dialog before a document is dereferenced in the Local Data Cache palette.
IDE Settings Dialog 39
Field Warn before deleting objects from the Component Hierarchy Open last project when launching General Interface Builder Snap-to spacing
Description Specifies whether to display a warning dialog before a component is recycled in the Component Hierarchy palette. Specifies to open the last project when General Interface Builder is launched.
Specifies the grid pixel size. Used when repositioning objects in the work area. To enable or disable the snap-to-grid feature, use the Toggle Snap-to Grid button in the Component Hierarchy palette.
IDE Hot Keys Page

The IDE Hot Keys page displays a list of General Interface Builder menus that you can assign keyboard shortcuts to. To assign a keyboard shortcut, double-click a row, press the key combination on the keyboard, and click Save. Restart General Interface Builder for the changes to take effect. Field Menu Key Description The name of the menu command The shortcut key that activates the menu command.
Paths Page
The Paths page allows you to set paths for the workspace and HTTP base. Field Workspace Description A user home directory that contains your projects, custom add-ins and prototypes, and your user settings for General Interface Builder. Browse to an existing directory, create a new one, or accept the default workspace.
40
| Chapter 3
Field HTTP Base
Description The base URI for the General Interface directory on a local HTTP server that hosts the TIBCO General Interface installation. The HTTP server must serve your workspace directory and your General Interface directory. In addition, the relative path between the two directories must be the same on the HTTP server as on disk.
Buttons
The following buttons are on the bottom right of the IDE Settings dialog. Button Apply Save Cancel Description Applies the changes but doesnt close the dialog. Saves the changes and closes the dialog. Cancels any changes and reverts back to the last saved version.
Project Settings Dialog 41
Project Settings Dialog

The Project Settings dialog contains settings for configuring project deployment, add-ins, class path, and legacy settings. To open the Project Settings dialog, choose Project > Project Settings. For more in-depth discussion of some of these options, see Setting Preferences in TIBCO General Interface Builder Getting Started Guide.
Deployment Page
The Deployment page has settings for application deployment. For more information, see Deploying Applications in TIBCO General Interface Builder Getting Started Guide. Field Caption Namespace Description The text to display in the browser title bar while the application is running. Each General Interface application has a single instance. The application namespace is a unique identifier for this single jsx3.app.Server instance. All objects in a General Interface application are governed by this server instance and uniquely located using the application namespace. The dot symbol (".") is supported in the namespace. For example, eg.chart.APP. Initial Component The path to the component to automatically load when the application initializes at runtime. The path is relative to the project directory. For example, components/appCanvas.xml. Specifies whether to trap errors and display them in the System Log palette. If checked, JavaScript errors are routed to the System Log palette in General Interface Builder. If unchecked, JavaScript errors are routed to the browser.
jsx3.app.Server
Cancel Error
42
| Chapter 3
Field Cancel Right-Click
Description Specifies whether to trap the right-click event. If checked, developers can replace the browser right-click menu with a custom menu. If unchecked, right-click events are routed to the browser.
Mode
The deployment mode for the deployed application used by the jsx3.net.Service class.
Live Mode An online mode where the application is connected over HTTP/S to a back-end server, allowing access to online data. When requests for data are made by the application, the request goes out over HTTP/S and data is returned and rendered. Static Mode An offline mode where the application is not connected to a server. Data is static and is referenced using static URLs stored in rules files. When a request for data is made by the application, the request is routed to a local static XML document. That static data is returned as if it came from a server and is rendered in the application.
Select this mode when developing an application offline or disconnected from the server. This is useful when applications and back ends, such as web services, are in development simultaneously or a back end is currently unavailable. Body Hot Keys Specifies whether to route key events that bubble up to the window from an application keyboard shortcut. If checked, the keyboard shortcut event bubbles up to the HTML body element and is then sent to the application. Check this option for deployment of standalone console applications. If unchecked, keyboard shortcuts only function if the focus is in the General Interface application. This option should be unchecked for deployment of non-console applications that are a portion of a web page.
Project Settings Dialog 43
Field Overflow
Description Determines how the application container behaves when movable objects, such as dialogs and CDF drag masks, are moved off the edge of the container.
Scroll Movable objects cause the container to scroll. Expand Movable objects can leave the container. Hidden Movable objects are invisible.
Default Locale
Specifies the locale of the localized application. Enter the two letter ISO 639 language code and the optional, two letter ISO 3166 country code. The format is ll or ll_CC.For example, fr for French or fr_fr for French in France. If this field is empty, the locale is determined by the browser.
onLoad Script
JavaScript code to execute when the application initializes.
Add-Ins Page
Select which add-ins to load for the project, such as Charting or custom add-ins. Restart TIBCO General Interface Builder for changes to take effect. For more information on the Charting add-in, see Working with Charts in TIBCO General Interface Builder Getting Started Guide. Field Charting Description If selected, TIBCO General Interface Builder charting components display in the Component Libraries palette.
44
| Chapter 3
Classpath Page
The project class path is used by the JSX runtime to find custom classes that are dynamically loaded by your application. This accelerates load time for your application. See Class Loading in TIBCO General Interface Builder Getting Started Guide. For naming conventions for dynamically loaded classes, see Class Naming Conventions in TIBCO General Interface Builder Getting Started Guide. Field Path Description The path to the custom classes. The class path is relative to the project directory. For example, entering js/ as the path would load the specified classes in the workspace/JSXAPPS/project_dir/js directory. The name of the package. Wildcards (*) are allowed.
Package
Legacy Page
The Legacy page has the following options: Field Project Version Description A version number for the project. When a resource in the project is accessed, the string ?jsxversion=<project_version> is appended to the name of the resource. This is useful for reloading cached files each time the project is modified. Specifies the event protocol for the project. The options include 3.1 (default) and 3.0 (deprecated).
Event Protocol
Buttons
The following buttons are on the bottom right of the Project Settings dialog: Button Apply Save Cancel Description Applies the changes but doesnt close the dialog. Saves the changes and closes the dialog. Cancels any changes and reverts back to the last saved version.
Color Picker Tool 45
Color Picker Tool

The Color Picker allows you to select colors to copy and paste into TIBCO General Interface Builder. To open the Color Picker, choose Tools > Color Picker. To navigate in the Color Picker, use the arrow keys to move the slider, scroll through hex values in the Hex field, and move between radio buttons. Field Color palette Color slider Preview color box Description Click in the color palette to select a color. Use the slider to change color spectrum in the Color palette. The box at the lower right displays the currently selected color. Click in this box to copy the hexadecimal (hex) color value to the clipboard. Specifies the color hue or gradation. Specifies the color saturation, which is the intensity or purity of a specific hue. Specifies the color brightness or strength. Specifies the red portion of the RGB value. After specifying a value, press the Enter key to view the updated hex equivalent. Specifies the green portion of the RGB value. After specifying a value, press the Enter key to view the updated hex equivalent. Specifies the blue portion of the RGB value. After specifying a value, press the Enter key to view the updated hex equivalent. The hex value for the selected color.
H (Hue) S (Saturation) B (Brightness) R (Red)
G (Green)
B (Blue)
Hex
46
| Chapter 3
Deployment Utility
Use the Deployment Utility to create a launch page for your application, a launch link, or an inline div element. For more information, see Deploying Applications in TIBCO General Interface Builder Getting Started Guide. To open the Deployment Utility, choose Project > Deployment Utility.
HTML Page
Select this tab to create an HTML or XHTML page that launches the deployed application as a standalone application. Command XHTML Description If checked, XHTML markup is generated for the the launch page. XHTML launch pages are used for applications that run in XHTML pages, such as portlet applications. Creates the HTML or XHTML page for launching the deployed application.
Create
Launch Link Page

Select this tab to generate a hyperlink that launches the application in a new browser window. Copy and paste the link into your HTML page and modify as desired. This hyperlink requires the file install_dir\shell.html to be deployed also. Button Description Copies the contents of the textbox to the clipboard which you can then paste into your HTML page.
Deployment Utility 47
Inline Div Page

Select this tab to generate an inline DIV for your HTML page. Use this option when running multiple applications in the same browser window. Copy and paste the inline DIV into your HTML page and modify as desired. Button Description Copies the contents of the textbox to the clipboard which you can then paste into your HTML page.
48
| Chapter 3
Find and Replace Tool

To open Find and Replace, choose Tools > Find and Replace. Field Find Case Sensitive Regular Expression Description Enter the text string to search for in the active open text file in the project. If checked, finds only exact case matches to the string entered in the Find field. If checked, JavaScript regexp syntax is supported in the Find field. For more information, see Help > Internet Resources > Regular Expressions Guide (Mozilla). Enter a replacement text string for the found text in the active open text file in the project. Replaces the found text string with the replacement string. Replaces all occurrences of the text string with the replacement string. Finds the next occurrence of the text string. Closes the dialog.
Replace Replace Replace All Find Cancel
JavaScript Test Utility 49
JavaScript Test Utility

Use the JavaScript Test Utility to test your JavaScript code. To open the JavaScript Test Utility, choose Tools > JavaScript Test Utility. Field Upper text area Return Value (if applicable) Description Enter or paste the JavaScript code to be tested. To access a list of methods, press Ctrl+spacebar. Return values, if any, display in this area.
50
| Chapter 3
XML Mapping Utility

The XML Mapping Utility provides a visual environment for configuring and testing data services. For more information, see Data Connection and Mapping in TIBCO General Interface Builder Getting Started Guide. To open the XML Mapping Utility, choose Tools > Communication > XML Mapping Utility. The XML Mapping Utility has several panels: Rules Tree, Rule Profile panel. Settings panel, and Mapper Log. When you open the XML Mapping Utility from the Tools menu, the first page displayed allows you to select the file(s) to open. Field / Button WSDL XML/HTML/ Schema URL Description Select this option if a WSDL is available for generating the mapping rules. Select this option if XML, HTML, or schema are available for generating the mapping rules. If WSDL is selected, choose the URL for the WSDL to be used for generating the mapping rules. If XML/HTML/Schema is selected, enter the URLs for the outbound and inbound document(s). Documents that are created are "outbound," while documents that are processed are "inbound." Parse Document Parses the selected document(s).
Rules Tree Panel

The Rules Tree panel of the XML Mapping Utility contains the structures defined in the rules file displayed in a hierarchical format. It provides a visual interface for creating bindings and for testing data services. Right-click a node to see whats available on the context menu.
XML Mapping Utility 51
Rule Profile Panel

The Rule Profile panel has two views: one for viewing the WSDL source and one for editing the rule node. Radio Button Original Schema Source Rule Node Profile Description Displays the original schema or XML node used to generate the selected rule. Displays name-value pairs in the rules file for the selected node. Many of the fields of the Rule Node Profile are editable.
52
| Chapter 3
Settings Panel
The fields displayed in the Settings panel on the right side of the XML Mapping Utility depend on the type of node selected in the Rules Tree. The examples discussed in the Field Description column refer to the AddressLookup Service discussed in Chapter 5 Tutorial: Communicating with Data Services in TIBCO General Interface Builder Getting Started Guide. Selected Rules Tree Node Field Description
Endpoint URL This the URL for the service to contact. It can either be absolute (http/https) or relative (that is, /services/address.asmx). To override this setting at runtime, call setEndpointURL on the Service instance. Method to transport the call. The most common methods are POST and GET. While the former is used for sending actual content (XML) with the request, the latter merely calls the given URL. To override this setting at runtime, call setMethod on the Service instance. HTTP Headers Each HTTP request can send different types of information. Sometimes data is sent as an XML document (POST). Sometimes the URL is overloaded with data of its own (GET or POST). And sometimes HTTP headers are used to convey information about the content and purpose of the request itself. The HTTP headers listed in this field are automatically generated during the initial parse. If additional headers are needed, they can be added statically to this field, or they can be added at runtime on the service instance by calling setRequestHeader for each additional header that should be added. Other headers not listed will also be sent, including the content-length and any cookies used by the Service. When making a Service call, the jsx3.net.Request class is actually used
Operation Nodes
Selected Rules Tree Node
Field Description
Stub URL Typically used in conjunction with Stub Path to support SOAP-based web services. When SOAP is used, each request document is encapsulated by a SOAP Envelope. The Mapper treats the Envelope as a static document into which the actual request will be placed. For example, the default stub used by the Mapper is as follows:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoa p.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoa p.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XML Schema-instance" xmlns:xsd="http://www.w3.org/2001/XML Schema"> <SOAP-ENV:Body> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Input Nodes
This document is generic enough to encapsulate the majority of SOAP messages. However, if this default document does not contain enough information (perhaps the Envelope must also include a SOAP Header in addition to a SOAP Body element), then the developer can specify the URL for a static stub of their own. If a custom document is used, do note that the Mapper assumes the following namespaces and prefixes, meaning even customized Envelopes must adhere to the following: Prefix URI
SOAP-ENV http://schemas.xmlsoap.org/ so SOAP-ENC http://schemas.xmlsoap.org/ soap/envelope/ xsi http://www.w3.org/2001/XMLS chema-instance xsd http://www.w3.org/2001/XMLS chema
ap/encoding/
This value can be updated at runtime using the API call, setOutboundStubURL.
54
| Chapter 3
Field Description
Stub Path Used in conjunction with Stub URL. It should contain a valid XSL query that will describe where in the Stub document the actual generated document should be placed. For example, the following document is generated when the ReturnCityState operation of the AddressLookup service is called:
<jsx1:ReturnCityState xmlns:jsx1="http://ws.cdyne.com/"> <jsx1:zipcode>20012</jsx1:zipcode> <jsx1:LicenseKey>0</jsx1:LicenseKey> </jsx1:ReturnCityState>
However, the combination of the default Stub URL() and Stub Path (JSX/addins/mapping/xml/stubs/soap.xml) results in the following document being sent:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoa p.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoa p.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XML Schema-instance" xmlns:xsd="http://www.w3.org/2001/XML Schema"> <SOAP-ENV:Body> <jsx1:ReturnCityState xmlns:jsx1="http://ws.cdyne.com/"> <jsx1:zipcode>20012</jsx1:zipcode> <jsx1:LicenseKey>0</jsx1:LicenseKey> </jsx1:ReturnCityState> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
This value can be updated at runtime using the API call, setOutboundStubPath.
Field Description
onBeforeSend Whatever JavaScript is entered into this field will execute immediately before the request message is sent. This script executes in context of the Service instance, meaning the key word, this, will refer to the Service instance. For example, if a developer wanted to output the XML request to the System log immediately before sending it, they would enter:
jsx3.log(this.getOutboundDocument().g etXML());
Stub URL The Mapper provides a static mode, allowing users to test against a typical Service response. This is useful in situations where the Service is not yet built or is inaccessible. To use this feature, you should save a valid XML document (the typical response) and then enter the URL in this field. Next, change the Mode option on the Deployment page of the Project Settings dialog from Live to Static. See Deployment Page on page 41. Finally, refresh the browser to reload the project. Now when transactions are run by a Service, a request won't even be sent. Instead the sample document will be processed as if the remote service had actually returned it. Note that this URL can also be set at runtime using the API call, setInboundURL. onAfterReceive Whatever JavaScript is entered into this field will execute immediately after the response message has been received, before the mappings are applied. This script executes in context of the Service instance, meaning the key word, this, will refer to the Service instance. For example, if you want to output the XML response to the System log each time the Service responded, you could write:
jsx3.log(this.getInboundDocument(). getXML());
Output Nodes
56
| Chapter 3
Field Description
Mappings The Mappings table is where the actual work is done. When a request message is being generated or a response message is being processed, each mapping listed in this table is run sequentially for the given rule. Different mapping types exist, but they all do the same thing, namely, provide a map between objects in the application (textbox, JavaScript variable, CDF attribute, and so on) and nodes in the Rules tree. Restrictions When Schema or WSDL are used as the input for the Mapper, any restrictions will appear in this list. Developers also have the option to place additional restrictions on a rule. For example, a developer might decide that a given mapping may only be equal to dog or cat. To restrict such input the developer would add two new Enumeration restrictions to the rule: one for cat, the other for dog. At runtime, these restrictions can be used to validate the request document as it is being created node-by-node. Refer to the ON_INVALID subscription for the Service class for more information about the relevant information that is published when a node value doesn't adhere to its restrictions. Repeat When As long as the JavaScript in this field evaluates to true, the rule (along will all descendant rules) will be run again. This means that simply entering true in this field would result in an infinite loop. Also note that CDF mappings automatically repeat when necessary. For more information on CDF GUI components, see Mapping Response Data to CDF GUI Components, page 118 in TIBCO General Interface Builder Getting Started Guide.
Rule Nodes
Mapper Log
The Mapper Log displays information about the outcome of parsing the starting point document and testing mappings. Field Text area Description Displays the utility log messages according to the selected log level.
Test Interface Tool

The Test Interface Tool of the XML Mapping Utility is designed to guide you through the test sequence. The Create, Send, Receive, and Apply tabs correspond to phases of sending and receiving XML messages. Clicking a tab displays data that is relevant to the current test phase. To use the Test Interface Tool, click the Test button on the Rules Tree toolbar. Each page of the Test Interface Tool contains this drop-down list: Field Select Description Select the operation to test from the drop-down list.
Create Page Mappings for the outbound message display on this page. Field Rule Name Type Path/Value Post-Mapping Filter/Handler Description Name of the element. Type of object that is mapped. GUI component name or any associated JavaScript code for this mapping. Filter code to execute before sending this message.
58
| Chapter 3
Send Page The outbound message displays on this page. Field URL HTTP Headers Name Password Method Description URL specified in the WSDL file. Header content for the message. The header text can be edited. User name used for authentication if required. Password used for authentication if required. Method for contacting the Service. The most common are GET and POST.
Receive Page The Service response displays on this page. Field HTTP Headers HTTP Status Response Description Header content for the response message. Status of message, such as 200, 404, and so on. Response message.
Apply Page The inbound mappings display on this page. Field Pre-Mapping Filter/Handler Inbound Mappings Description Filter code to execute on the inbound document. Mappings of response nodes to application objects.
XML/XSL Merge Tool 59
XML/XSL Merge Tool

Use the XML/XSL Merge Tool for testing the XML and HTML output from a merge operation. For more information, see Data and Cache Management in TIBCO General Interface Builder Getting Started Guide. To open the XML/XSL Merge Tool, choose Tools > XML/XSL Merge Tool. Field URL Cache Script Source Description The location of the XML or XSL file, either on an accessible file system or on a web server. The name of the XML or XSL file in browser cache, as displayed in the Local Data Cache palette. JavaScript code that produces an XML document or a node in an XML document as output. XML or XSL code typed directly into the tool dialog. If URL, Cache, or Script is used to specify the XML or XSL source, this field displays the file contents. In the case of XSL, modifications can be made before the merge operation. Merges the XML document with the XSLT filter document and displays the results. Displays the result of the merge operation as rendered XML or HTML (as it would appear in a browser). Displays the result of the merge operation as XML or HTML.
Merge Documents Rendered Output Raw Output
60
| Chapter 3
| 61
Chapter 4
Prototype Components
This chapter describes the System components of TIBCO General Interface Builder prototype components.
Topics
Blocks, page 62 Containers, page 64 Form Elements, page 65 Matrix, page 67 Menus and Toolbars, page 89 Miscellaneous, page 90
62
| Chapter 4
Blocks
A block component is a generic container that displays HTML, including text and images. A block is rendered on-screen as an HTML span element, although other HTML types are supported. A block can serve as a background or as a divider for areas of the application with a common function. Blocks can also display images or text in other components. To avoid unexpected layout behavior in deployed applications, its recommended to use Block as a container only if it meets one of these requirements: The Block is owned by a layout manager, such as LayoutGrid, Tab, Stack, and Splitter. The Block is relatively positioned and has a width of 100%. The Block is absolutely positioned. Description A simple, relatively positioned block that fills the entire component area. Useful as a container or background for other components. An absolutely positioned block that is positioned at the top left of the parent GUI component. An absolutely positioned block that can display XML data. An XSL file can be specified to filter and modify the XML. A relatively positioned image from a file. The file is referenced using the Tag Name property. The path to the image is defined by the src attribute in the Attributes Editor. A relatively positioned text label. Useful as a label for a Text Box component. A relatively positioned text area that is useful for larger blocks of text.
Name Block - 100%
Block Absolute BlockX Image
Label Text
Cross-browser Box Model

With the introduction of the new cross-browser box model in TIBCO General Interface 3.2, padding, margin, and border properties are managed by the system, not the browser.
Blocks 63
The new box model rules that relate to left, top and margin are as follows: If position is absolute, left and top will be honored. Margin will not. If position is relative, margin will be honored. Left and top will not.
64
| Chapter 4
Containers
A container component is a component that does not display data, serving as a container for other components. Name Dialog Layout (Side/Side) Layout (Top/Over) Splitter - H Splitter - V Stack Group - H Description A block with a border and caption bar. The caption bar has Minimize and Close buttons. A background with two vertical panes that fills the entire component area. A background with two horizontal panes that fills the entire component area. A horizontal divider that splits a pane into two areas. Users can click and drag the divider vertically. A vertical divider that splits a pane into two areas. Users can click and drag the divider horizontally. A background with two horizontal, sliding panes that fills the entire component area. Each pane has a caption bar and double-clicking the caption bar displays the area. A background with two vertical, sliding panes that fills the entire component area. Each pane has a caption bar and double-clicking the caption bar displays the pane. A horizontal sliding pane with a caption bar for a stack group. A vertical sliding pane with a caption bar for a stack group. A tab for a tabbed pane. A pane with three tabs. Each tab has a caption and clicking the caption displays the pane.
Stack Group - V
Stack Item - H Stack Item - V Tab Tabbed Pane
Form Elements 65
Form Elements
Form elements are GUI components for collecting user input. Name Button Button ImageButton Description A button with text. To define button behavior, configure the Execute event. A button with an image instead of text. You can assign an image for the button as well as images for over, down, on, and disabled. To define button behavior, configure the Execute event. A checkbox field that can be selected or unselected. An HSB color picker control, an instance of
jsx3.gui.ColorPicker.
Checkbox Color Picker Date Picker
A text field that when clicked displays a calendar control for selecting a date value. The date value is automatically specified in the correct format. To select a date format, specify a value for the Format property by selecting from the lookup menu. A radio button with text label. To define button behavior, configure the Select event. To define a group of radio buttons as mutually exclusive, specify the same value for the Group Name property. A non-editable drop-down where only one option can be selected. Options are XML elements (CDF format) referenced by the XML Cache Id, XML (String), or XML URL property. A combination text field and drop-down list. Typing in the text field narrows the list to display only possible matching values. The jsxid attribute of the select is persisted in the CDF data model while the jsxtext attribute is displayed in the combo box. A horizontal slider control. A multi-line text field with a scrollbar.
Radio Button
Select
Select - Combo
Slider Text Area
66
| Chapter 4
Name Text Box Text Box Password Time Picker
Description A simple text field. A text box for entering sensitive values. Alphanumeric characters are represented by bullet characters. A clock for selecting the hour, minute, and AM or PM. Seconds, milliseconds, and a 24 hour clock can also be displayed.
Matrix 67
Matrix
The Matrix component replaces Grid, List, and Column, which are deprecated. Matrix combines the features of a grid, list, and tree in a single component. A matrix, which is similar to a spreadsheet, has a tabular structure with rows that can be selected and cells that can be editable. Matrix components also provide built-in support for large data set scrolling and pagination. The Matrix components include jsx3.gui.Matrix and
jsx3.gui.Matrix.Column.
For more information, see Using Matrix Components in TIBCO General Interface Builder Getting Started Guide.
Matrix
The Matrix components include the following prototypes: Name Grid Description A grid view with editable cells, a 2-pass paging model, and single cell selection. This paging model renders the outer container first, and the entire data set is rendered in a second pass. A list view with columns and sample data. List items are XML elements (CDF format) referenced by the XML Cache Id, XML (String), or XML URL property. Users can sort data by clicking a column header. This list uses the 2-pass paging model and supports multiple row selection. A matrix that allows one or more items in a list to be selected and is rendered using a 2-pass paging model. To define the list of items, associate it with an XML string, file, or cache document.
List
MultiSelect
68
| Chapter 4
Name Paginated List
Description A matrix with a list and a paged paging model. This model renders the outer container first. The first and last panels are rendered during a second pass. As the user scrolls, relevant panels are added and unused panels are collected. During scrolling, information is displayed using the Scroll Info property. Note: The row height must be fixed. This prototype also uses paging tuners to optimize performance, such as number of pooled panels, rows per panel, and number of panels in the paint queue.
Tree
A tree view that supports drag and drop and has a stepped paging model. Data is only painted when the state of the on-screen parent row is toggled to open. Use the Matrix tree for a more robust component and faster rendering. Use the lightweight Tree component (Miscellaneous > Tree) for simpler trees that arent deeply nested and all data is painted on loading.
Matrix Column
The Matrix Column components include the following prototypes: Name Button Button - Delete Description A column of buttons. To define button behavior, configure the Execute event in the Events Editor palette. A column of Delete buttons with a delete icon. When a Delete button is clicked, the CDF record is deleted from the matrix. Note the Execute event assigned to the ImageButtonMask in the Events Editor palette. A column of buttons with icons. Use the Image property to specify the path to an icon file. To define button behavior, configure the Execute event in the Events Editor palette. A column of toolbar buttons with icons. Use the Image property to specify the path to an icon file. To define button behavior, configure the Execute event in the Events Editor palette.
Button ImageButton Button ToolbarButton
Matrix 69
Name Checkbox
Description A column of checkboxes that can be selected or unselected. A checked checkbox updates the CDF checked attribute to 1. An unchecked checkbox evaluates to 0. A column of dates. Renders a date according to a configurable date format. The data model can store the dates as epoch seconds, a string parsable by the column date format, or a format recognized by the JavaScript Date.parse() method. Extends the Date column with a DatePicker edit mask, which is a text field that when clicked displays a calendar control for selecting a date value. The date value is automatically specified in the correct format. To select a date format, specify a value for the Date Format property by selecting from the lookup menu. A column of HTML images. Use the Path property to specify the image attribute. Example of using a block as an edit mask for a Matrix column. A block with a single child of type jsx3.gui.Form is supported out-of-the-box. For more complex behavior, implement the methods getMaskValue(), setMaskValue(), and getMaskFirstResponder(). See the API documentation for jsx3.gui.Matrix.BlockMask. Example of using a dialog as an edit mask for a Matrix column. Displays a column of menus, each menu with a drop-down list of options. Options are XML elements (CDF format) referenced by the XML Cache Id, XML String, or XML URL property. A column of radio buttons. Only one row may be selected at a time. Sets the CDF attribute specified in the Path property to radioed (1) when checked. Honors the @jsxdisabled CDF attribute.
Date
Date Picker
Image Mask - Block
Mask - Dialog Menu
Radio Button
70
| Chapter 4
Name Select
Description A column of drop-down lists. Options in the list are XML elements in the CDF document referenced by the Path property. The jsxid attribute of the select is persisted in the CDF data model while the jsxtext attribute is displayed in the matrix cell. A column of combination text fields and drop-down lists. Typing in the text field narrows the list to display only possible matching values. The jsxid attribute of the select is persisted in the CDF data model while the jsxtext attribute is displayed in the matrix cell. A column of text fields. A column that renders a CDF attribute as raw HTML. Uses the Format Handler property @unescape for Firefox support and the Value Template property @unescape for Internet Explorer support. A column that formats a number according to a number format. Supported format handlers include @number, @number,integer, @number,percent, and
@number,currency.
Select - Combo
Text Text - HTML
Text - Number
Text Area Text Field Time
A column of multi-line editable text fields with scrollbars. The edit mask can be larger than the data cell. A column of editable text fields. Data specified in a field updates the CDF attribute referenced by the Path property. Renders a time according to a configurable date format. The data model can store the dates as epoch seconds or a string format recognized by the JavaScript Date.parse() method. Extends the Time column with a TimePicker edit mask, which renders a clock for selecting the hour, minute, and AM or PM. Seconds, milliseconds, and a 24 hour clock can also be displayed.
Time Picker
Matrix 71
Properties
This section discusses properties that can be configured for the Matrix and Matrix Column components. Matrix Properties The following properties can be configured for Matrix components: Property Name Rendering Model Description The name of the matrix in the Component Hierarchy palette. The rendering model of the matrix, such as shallow, deep, and hierarchical. Shallow and deep are flat models, while hierarchical models are rendered as trees. Shallow only paints direct children of the context node. Deep paints all descendants. Hierarchical paints all children but can also be performance-tuned to paint a given number of generations at a time. Because this allows nodes to be fetched only when a user expands a given branch, application performance is faster. For more information, see Rendering Models in TIBCO General Interface Builder Getting Started Guide. Rendering Ctx The rendering context (jsxid) of the parent record whose children or descendants will be painted. The context node, the reference or starting point to begin rendering, isnt rendered. The selection model, such as single row, multiple rows, and not selectable. The paging model for how and when objects are rendered on-screen, such as No Paging, 2-pass, Chunked, Paged, and Stepped (Hierarchical). For more information, see Paging Models in TIBCO General Interface Builder Getting Started Guide. The maximum allowed number of pooled panels when the rendering model is Paged. The number of rows in a panel when the rendering model is Paged.
Selection Model Paging Model
Panel Pool Size Rows Per Panel
72
| Chapter 4
Property Panel Queue Size Scroll Info Header Height Row Height
Description The maximum allowed number of panels in the paint queue when the rendering model is Paged. The info label to display when scrolling a paged instance. The height of the header in implied pixels. Set to 0 if the column doesnt use a header. The height of the data rows. The paging model, Paged, supports only fixed row height. All other paging models support fixed and flexible heights. If a row height isnt specified (null), the default height (Matrix.DEFAULT_ROW_HEIGHT) is used. If the specified row height is 0, flexible height is used. For a fixed row height, specify a positive integer in implied pixels, such as 14. The border for the header row. The border for the body. To set the border for an individual column, update the APIs for the given column. Whether or not the column width should be scaled to fit in the visible region or if a horizontal scrollbar should be used. The Matrix automatically provides a horizontal scrollbar when the aggregate width of its columns is greater than the overall Matrix width. A scale width flag can also be set to reduce column widths until the content fits exactly within the view port constraints. When rendering with a scaled width, its often useful to include a wild card width (*) on those columns whose width should be flexible. Percentage and pixel values are also supported. Note that the unit identifier for pixels is implied and should not be specified as px.
Header Border Body Border
Scale Width
Hide H-Scroller Hide V-Scroller
true
Whether or not to hide the horizontal scrollbar. Set to to hide it.
Whether or not to hide the vertical scrollbar. Set to true to hide it.
Matrix 73
Property Render Nav Close Icon
Description In a hierarchical tree view, whether or not to render the navigation controls on the first column. In a hierarchical tree view, the 16x16 transparent GIF used to signal that clicking the item collapses its contents. In a hierarchical tree view, the 16x16 transparent GIF used to signal that clicking the item expands its contents. The icon to display in a hierarchical tree view. The attribute path to sort on, such as @jsxtext. The type of data for columns in this list or grid, such as text or a number. Whether to sort in ascending (a-z) or descending (z-a) order. Whether or not the column can be sorted when a column header is clicked. Whether or not the columns is resizable. Whether or not the columns can be reordered. The index of the first column that can be reordered. All columns of a lesser index cant be reordered. If Enabled, this object supports drag events and allows any contained item to be dragged and dropped onto another container supporting drop. If Enabled, this object can be the target of drop events. If true, this object can be spyglassed. A spyglass displays HTML returned from the jsxspy event when a row in the Matrix is hovered over. A menu to display when a user right-clicks on a row in the Matrix. Specify the jsxname, the name of the menu component as displayed in the Component Hierarchy palette.
Open Icon Icon Sort Path Sort Data Type Sort Direction Sortable Resizable Reorderable Fixed Columns Can Drag From
Can Drag On Can Spy
Bound Menu
74
| Chapter 4
Property Tab Index Focus Style Selection BG
Description Sets the tab index. When tabbing between controls, the index group that this component belongs to. The CSS styles to apply to a cell when it has cursor focus. For example, color:red. The URL of the background image to apply to the background of the selected cell or row to show that its selected. For example,
jsx:///images/matrix/select.gif.
Spy Styles XML Cache Id
The CSS styles to apply to a cell when the mouse hovers over the cell and a spyglass is applied. The string identifier of the cached CDF document with data. This string, which is the XML document name, displays in the Local Data Cache palette. The XML string (CDF) with data. The URL of the CDF document with data. The file can be local or remote. Paths can be relative or absolute. A comma-separated list of XSLT transformers. The source XML is transformed in a series by each of the transformers listed here before being placed in the XML cache. Specify each transformer as a URI to an XSLT file or the XML cache ID of an XSLT document. Whether to delete the associated CDF document when the component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The annotation comment visible in a spyglass when you hover the mouse over the component in the Component Hierarchy palette.
XML (String) XML URL XML Transformers
Share Resources
Annotation
Matrix 75
Matrix Column Properties The following properties can be configured for Matrix Column components: Property Att Name Att Type Sort Att Name Sort Att Type Triggers Description The named attribute whose content will be displayed on-screen, such as jsxtext. The data type for the path (jsxpath), such as text or number. The attribute path to sort on, such as jsxtext. The data type for the sort path (jsxsortpath), such as text or number. A comma-separated list of named attributes that when modified by another column will trigger this column's related cell to repaint. Whether or not this column is sortable. Whether or not this column is resizable. The width of the column as implied pixels or a percentage. Wildcards(*) are also supported. Note: Integer values take precedence over percentages. The XSL template to generate the cell content. It must be a valid XSL template or a system-defined template identified by one of these @image (jsximg), @unescape, @empty, or @default. For more information, see Content Formatting and Localization in TIBCO General Interface Builder Getting Started Guide. The reformatting method to use on the cell data after it has been painted on-screen. You can also point to a named reformatter, including @unescape, @lookup, @message, @datetime, @date, @time, and @number. For more information, see Content Formatting and Localization in TIBCO General Interface Builder Getting Started Guide. Sets the CSS display property. When set to None, the column isnt rendered. The label for the column header.
Sortable Resizable Width
Value Template
Format Handler
Display Caption
76
| Chapter 4
Property Word Wrap Font Name Font Size Font Weight Color
Description Whether the text wraps or not. Setting to true, wraps the text. The name of the font for rendering the label. The point size of the font for rendering the label. The weight of the font for rendering the label, either bold or normal. The default value is Normal. The color of the font for rendering the text. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The RGB value of the background fill. Specify the value as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000. The CSS background definition. For example,
background-image:url(abc.gif);background-repeat :repeat-x.
BG Color
Background
Padding
The CSS padding value between the border and the contents of the cell. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The valid CSS border definition. Specified as one or four value sets (top, right, bottom, and left). Specified as: style width color. For example, solid 1px red;dashed 2px red;double 3px black; solid 1px red;. The alignment of any contained object or text, such as Left, Center, and Right. The valid CSS vertical alignment definition. The valid CSS cursor definition, such as default, wait, or col-resize. A menu to display when a user right-clicks on the header with the mouse. Specify the jsxname, the name of the menu component as displayed in the Component Hierarchy palette.
Border
Text Align V-Align Cursor Bound Menu
Matrix 77
Property Tooltip Annotation
Description The text to display when the mouse hovers over this header. Only text is supported. The annotation comment visible in a spyglass when you hover the mouse over the component in the Component Hierarchy palette.
78
| Chapter 4
Events
This sections discusses events for all Matrix and Matrix Column components. Matrix Events The following events can be configured for all Matrix components: Name Execute Description Fires when a user double-clicks with the mouse or presses Enter. Parameters:
this {jsx3.gui.Matrix}
- the current Matrix object. the browser event that
objEVENT {jsx3.gui.Event}
triggered the model event.

strRECORDID {String} - the value of the jsxid attribute of the clicked CDF record. When more than one row is executed this variable is set to just one of the executed records. Use strRECORDIDS when the list is multi-selected. strRECORDIDS {Array <String>}
Select
- the values of the jsxid
attributes of the affected rows. Fires after a user selects a row. Parameters:

strRECORDID {String}
- the value of the jsxid attribute of - the values of the jsxid - the column child
the clicked record.

strRECORDIDS {Array <String>}
attributes of the affected rows.

objCOLUMN {jsx3.gui.Matrix.Column}
that owns the selected cell in the row.
Matrix 79
Name Change
Description Fires after the selected rows have changed. Parameters:

triggered the model event. Drop Fires before a drop event. Parameters:
- the current Matrix object. the browser event that - the JSX object where the

objSOURCE {jsx3.gui.Block}
drag began.
strDRAGTYPE {String} strDRAGID {String}
- the type of drag - JSXDragType.
- CDF record ID of the dragged record. - an array of CDF record IDs for the - CDF record ID for the row that - the column that
strDRAGIDS {String}
dragged rows.
received the drop.

received the drop.

bALLOWADOPT {boolean} - whether the source of the dragged
CDF record will allow the adoption.
80
| Chapter 4
Name Ctrl Drop
Description Fires before a drop event when the Ctrl key is held down. Parameters:
objEvent {jsx3.gui.Event}

drag began.
- CDF record ID of the dragged record.
strDRAGIDS {String}
- an array containing the CDF record IDs for the dragged rows. - CDF record ID for the row that - the column that
received the drop.

received the drop.

CDF record will allow the adoption. Adopt Fires before a record from this object is adopted by another object. Parameters:
this {jsx3.gui.Matrix} - the current Matrix object and source of the adopted record. objEVENT {jsx3.gui.Event}
the browser event that

- CDF record ID of the record to - JSX object instance and the
adopt.
objTARGET {jsx3.gui.Matrix}
target of adopted record.

bCONTROL {boolean} false
- true if Control drop is used and
otherwise.
Matrix 81
Name Change
Description Fires after the selected rows have changed. Parameters:

triggered the model event. Drop Fires before a drop event. Parameters:

drag began.
- CDF record ID of the dragged record. - an array of CDF record IDs for the - CDF record ID for the row that - the column that
strDRAGIDS {String}
dragged rows.
received the drop.

received the drop.

CDF record will allow the adoption.
82
| Chapter 4
Name Ctrl Drop
Description Fires before a drop event when the Ctrl key is held down. Parameters:
objEvent {jsx3.gui.Event}

drag began.
- CDF record ID of the dragged record.
strDRAGIDS {String}
- an array containing the CDF record IDs for the dragged rows. - CDF record ID for the row that - the column that
received the drop.

received the drop.

CDF record will allow the adoption. Adopt Fires before a record from this object is adopted by another object. Parameters:
this {jsx3.gui.Matrix} - the current Matrix object and source of the adopted record. objEVENT {jsx3.gui.Event}

- CDF record ID of the record to - JSX object instance and the
adopt.
target of adopted record.

- true if Control drop is used and
otherwise.
Matrix 83
Name Spyglass
Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters:

- the CDF record ID for the spied - the column that
row.
received the spy action. Menu Fires just before a right-click menu for the matrix is displayed. If the function evaluates to false, no menu displays. Parameters: Redorder

- the CDF record ID for the affected - the column that
row.
received the menu action.

objMENU {jsx3.gui.Menu}
- the menu to display.
Fires after the columns have been reordered. Parameters:


intOLDINDEX {int}
- the index of the column before it was - the index of the column after it was
reordered.
intNEWINDEX {int}
reordered.
84
| Chapter 4
Name Before Sort
Description Fires before the columns are sorted. Parameters:

- the current Matrix object. the browser event that - the column just

clicked.
strSORTPATH {String}
- the CDF attribute that the matrix is type assumed for the sort (jsxtext="Text") or
sorted on.
strSORTTYPE {String} - the data jsx3.gui.Matrix.Column.TYPE_TEXT (jsxtext="Numerical").
jsx3.gui.Matrix.Column.TYPE_NUMBER
After Sort
Fires after the columns are sorted. Parameters:

- the current Matrix object. the browser event that - the column that

the Matrix was sorted on.

strSORTPATH {String}
- the CDF attribute that the matrix is type assumed for the sort (jsxtext="Text") or
sorted on.
strSORTTYPE {String} - the data jsx3.gui.Matrix.Column.TYPE_TEXT (jsxtext="Numerical").
jsx3.gui.Matrix.Column.TYPE_NUMBER
Before Resize
Fires before the columns are resized. Parameters:


intCOLUMNINDEX {int}
- the index value of the column just
clicked.
Matrix 85
Name After Resize
Description Fires after the columns are resized. Parameters:


intCOLUMNINDEX {int}
- the index value of the column just
clicked.
vntWIDTH {int | String}
- the width for the column in implied pixels or percentage.
Before Edit
Fires before cell editing begins. Parameters:


- the CDF record ID for the affected - the column.
row.
After Edit
Fires after cell editing begins and before the edit is committed. Parameters:

row.
objCOLUMN {jsx3.gui.Matrix.Column} strNEWVALUE {String}
- the new value for the cell.
86
| Chapter 4
Name After Commit
Description Fires after an edit is committed. Parameters:


row.
objCOLUMN {jsx3.gui.Matrix.Column} strVALUE {String}
- the new value for the cell.
Toggle
Fires when a node is toggled when rendering in hierarchical mode. Parameters:


- the CDF record ID for the affected - the CDF node for the
row.
objRECORD {jsx3.xml.Entity}
toggled item. bOPEN {boolean} - the new open value for the toggled item.
Scroll
Fires when the data area of this matrix scrolls. Parameters:


strDIRECTION {String}
- the direction of the scrolling, such
as horizontal or vertical.
intPOSITION {int}
- the position of the scrollbar in implied
pixels.
Matrix 87
Name Destroy
Description Fires when the Matrix component is removed from the component hierarchy. Parameters:
- the current Matrix object that is
being destroyed.
objPARENT {jsx3.app.Model} - the parent object of this matrix in the component hierarchy.
Matrix Column Events The following events can be configured for all Matrix Column components: Name Adopt Description Fires before a record from this object is adopted by another object. Parameters:
this {jsx3.gui.Matrix.Column} Matrix.Column
- the current object and source of the adopted the browser event
record.
that triggered the model event.

- CDF record ID of the record - JSX object instance
to adopt.
and the target of adopted record.

- true if Ctrl+drop is used and
otherwise.
88
| Chapter 4
Name Menu
Description Fires just before a right-click menu for the column header is displayed. If the function evaluates to false, no menu displays. Parameters:
- the current
object. the browser event

- the CDF record ID for the - the
affected row.
column that received the menu action.

Destroy
Fires when the Matrix Column component is removed from the component hierarchy. Parameters:
- the current object that is being destroyed.
objPARENT {jsx3.app.Model} - the parent object of this matrix in the component hierarchy.
Menus and Toolbars 89
Menus and Toolbars

Menus and toolbars are GUI components for executing commands or JavaScript functions. Name Menu Description A menu with a drop-down list of options. Options are XML elements (CDF format) referenced by the XML Cache Id, XML String, or XML URL property. A generic background for multiple menus. A taskbar with icons for maximized and minimized dialogs. A generic background for multiple toolbar buttons. A toolbar button with an image and label. To define button behavior, configure the Execute event. To define a group of buttons as mutually exclusive, specify the same value for the Group Name property.
Menu Bar Taskbar Toolbar Toolbar Button
90
| Chapter 4
Miscellaneous
The Miscellaneous component include the following: Name Sound Sound Button Tree Description A sound component that can be played programmatically in a TIBCO General Interface application. A button that plays a sound when pressed. A hierarchical tree control with custom icons. Trees are hierarchical structures with nodes that can be expanded or collapsed. Items are XML elements (CDF format) referenced by the XML Cache Id, XML String, or XML URL property. Use this lightweight component for simple trees that arent deeply nested and all data is painted on loading. Use the Matrix tree for a more robust component and faster rendering. The Matrix tree supports dynamically loaded data, as well as drag and drop.
| 91
Chapter 5
Charting Components
This chapter contains reference information for chart prototype components.
Topics
Overview, page 92 Area Chart, page 93 Area Series, page 96 Bar Chart, page 103 Bar Series, page 107 Bubble Series, page 112 Category Axis, page 117 Chart Label, page 122 Column Chart, page 126 Column Series, page 130 Grid Lines, page 135 Legend, page 139 Line Chart, page 145 Line Series, page 149 Linear Axis, page 155 Logarithmic Axis, page 160 Pie Chart, page 165 Pie Series, page 169 Plot Chart, page 174 Point Series, page 178
92
| Chapter 5
Charting Components
Overview
To have access to the charting components, the Charting add-in must be enabled in your project. For more information, see Enabling the Charting Add-in on page 157 in TIBCO General Interface Builder Getting Started Guide. For more information on the Charting add-in, see Working with Charts in TIBCO General Interface Builder Getting Started Guide.
Area Chart 93
Area Chart
This section describes properties and events shared by all Area chart components, including Area, Area - LinearX, Area - Stacked, and Area - Stacked 100%.
Properties
The following properties can be configured for all Area chart components: Property Name Left Description The name of the chart in the Component Hierarchy palette. The size of the blank space, in pixels, to leave at the left edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The size of the blank space, in pixels, to leave at the top edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The chart width in implied pixels or as a percentage. For example, 100 or 25%. The chart height in implied pixels or as a percentage. For example, 100 or 25%. Whether to use relative or absolute positioning for the chart in relation to its container. The default value is Relative. The type of area chart, either overlay, stacked, or
stacked 100%.
Top
Width Height Relative XY
Type XML Cache Id
The string identifier of the cached CDF file with chart data. This string is displayed in the Local Data Cache palette. The XML string (CDF) with chart data. The URL of the CDF file with chart data. The file can be local or remote. Paths can be relative or absolute.
XML (String) XML URL
94
| Chapter 5
Charting Components
Property Share Resources
Description Whether to delete the associated CDF document when the chart component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The RGB value of the chart background fill. Specify the value as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000. The alpha value (opacity) of the chart background fill. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The RGB color of the chart border. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The width, in pixels, of the chart border. The default value is 1. The alpha value (opacity) of the chart border. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The CSS padding value between the chart border and the contents of the chart. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The CSS padding value for the data area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The default value is 0. The location of the chart title, one of top, right, bottom, left. The default value is top. The location of the legend, one of top, right, bottom, left. The default value is right.
BG Color
BG Alpha
Border Color
Border Width Border Alpha
Padding
Data Area Padding
Title Placement Legend Placement
Area Chart 95
Property Bound Menu
Description A menu to display when a user right-clicks on the chart with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Events
The following events can be configured for all Area chart components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.AreaChart}
- the current AreaChart
object.
triggered the model event. Fires just before a right-click menu for the chart is displayed. If the function evaluates to false, no menu displays. Parameters: Destroy
object.

Fires when the chart component is removed from the component hierarchy. Parameters:
object that is being destroyed.

objPARENT {jsx3.app.Model} - the parent object of this chart
in the component hierarchy.
96
| Chapter 5
Charting Components
Area Series
This section describes properties and events for Area series components.
Properties
The following properties can be configured for Area series components: Property Name Series Name X Field Y Field Min Field Type Description The name of the series in the Component Hierarchy palette. The name of the series. This value is displayed as a text entry in the chart legend. The name of the attribute in each CDF record containing x-coordinate values. The name of the attribute in each CDF record containing y-coordinate values. The CDF record attribute containing the minimum y-value of the area. This field is optional. The form of the area series, which defines how to connect data points. The type, segment, draws straight lines between points. step draws the horizontal portion and then the vertical portion of the space between points. reverseStep draws the vertical portion and then the horizontal portion of the space between steps. The default value is segment. The vector fill to use for the series. The syntax is:
color [alpha] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. alpha is an optional float value between 0.0 and 1.0.
Fill
Area Series 97
Property Stroke
Description The vector stroke to use for the series. The syntax is:
Fill Gradient
The vector fill gradient used for points in the series. The syntax is:
color2 [angle [alpha2 [percent stop_color,]*]]
The gradient is rendered starting from the main fill color/fill alpha and ending at color2/alpha2 along the specified angle. Optional intermediate colors along the way are defined by percent and stop_color pairs. Pairs are separated by commas. For example, red 0 1 50% white, 75% black.
color2 is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. angle specifies the angle of the gradient vector measured
in degrees (between 0 and 360) counter-clockwise from 12 o'clock.

alpha2 is an optional float value between 0.0 and 1.0.
Point Renderer
The optional shape displayed at each data point, in front of the line connecting the data points. Either select one of the default shapes (circle, cross, diamond, box, or triangle) from the property menu, or type the name of a custom point renderer. The radius of the shapes to draw at each data point. The default value is 4. The vector fill to use for points. The syntax is:
Point Radius Point Fill
98
| Chapter 5
Charting Components
Property Stroke
Fill Gradient
The vector fill gradient used for points in the series. The syntax is:

Point Renderer
The optional shape displayed at each data point, in front of the line connecting the data points. Either select one of the default shapes (circle, cross, diamond, box, or triangle) from the property menu, or type the name of a custom point renderer. The radius of the shapes to draw at each data point. The default value is 4. The vector fill to use for points. The syntax is:
Area Series 99
Property Point Stroke
Description The vector stroke to use for points. The syntax is:
color [width [alpha]]
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the point in pixels. alpha is an optional float value between 0.0 and 1.0. Point Gradient The vector fill gradient to use for points. The syntax is:
The gradient is rendered starting from the main fill color/fill alpha and ending at color2/alpha2 along the specified angle. Optional intermediate colors along the way are defined by percent and stop_color pairs. Pairs are separated by commas. For example, red 0 1 50% white, 75% black. color2 is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. angle specifies the angle of the gradient vector measured in degrees (between 0 and 360) counter-clockwise from 12 o'clock. alpha2 is an optional float value between 0.0 and 1.0. Color Function A static function used to color per-category regions in a series. A category corresponds to one row in a CDF document. Whether the series displays in the chart. The default value is block, which specifies to display the series. If none is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default value varies according to series type. A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Display
Tooltip Function Bound Menu
100
| Chapter 5
Events
Charting Components
The following events can be configured for Area series components. If no record corresponds to the region that is clicked, both intINDEX and strRECORDID arguments are null. Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.AreaSeries} AreaSeries
- the current

intINDEX {int} - the index value of the clicked record
in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file. Select
strRECORDID {String} - the value of the jsxid attribute of the clicked record.
Fires when a user clicks with the mouse on the series. Parameters:
- the current

in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file.
Area Series 101
Name Spyglass
- the current

in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file. Menu
Fires just before a right-click menu for the chart is displayed. If the function evaluates to false, no menu displays. Parameters:
- the current

102
| Chapter 5
Charting Components
Name Destroy
Description Fires after the series component is removed from the component hierarchy. Parameters:
objPARENT {jsx3.app.Model} - the parent object of this series in the component hierarchy.
Bar Chart 103
Bar Chart
This section describes properties and events shared by all Area chart components, including Bar, Bar- LinearY, Bar- Stacked, and Bar - Stacked 100%.
Properties
The following properties can be configured for all Bar chart components: Property Name Left Description The name of the chart in the Component Hierarchy palette. The size of the blank space, in pixels, to leave at the left edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The size of the blank space, in pixels, to leave at the top edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The chart width in implied pixels or as a percentage. For example, 100 or 25%. The chart height in implied pixels or as a percentage. For example, 100 or 25%. Whether to use relative or absolute positioning for the chart, in relation to its container. The default value is Relative. The type of bar chart, either clustered, stacked, or stacked 100%. The default value is clustered. The ratio of each bar or column that overlaps with the adjacent bar or column in the same category. If this value is negative, a gap is inserted between adjacent bars or columns. The default value is 0.0. The ratio of the width of each category that is occupied by bars. Specify a value between 0.0 and 1.0. If this value is less than 1.0, bars are centered horizontally in the category.
Top
Type Bar Overlap
Bar Coverage
104
| Chapter 5
Charting Components
Property XML Cache Id
Description The string identifier of the cached CDF file with chart data. This string is displayed in the Local Data Cache palette. The XML string (CDF) with chart data. The URL of the CDF file with chart data. The file can be local or remote. Paths can be relative or absolute. Whether to delete the associated CDF document when the chart component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The RGB value of the chart background fill. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The alpha value (opacity) of the chart background fill. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The RGB color of the chart border. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The width, in pixels, of the chart border. The default value is 1. The alpha value (opacity) of the chart border. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The CSS padding value between the chart border and the contents of the chart. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The CSS padding value for the data area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The default value is 0.
XML (String) XML URL Share Resources
BG Color
BG Alpha
Border Color
Padding
Data Area Padding
Bar Chart 105
Property Title Placement Legend Placement Bound Menu
Description The location of the chart title, one of top, right, bottom, left. The default value is top. The location of the legend, one of top, right, bottom, left. The default value is right. A menu to display when a user right-clicks on the chart with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Events
The following events can be configured for all Bar chart components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.BarChart} - the current BarChart
object.
the browser event
that triggered the model event. Fires just before a right-click menu for the chart is displayed. If the function evaluates to false, no menu displays. Parameters:
object.
the browser event

106
| Chapter 5
Charting Components
Name Destroy
Description Fires when the chart component is removed from the component hierarchy. Parameters:

objPARENT {jsx3.app.Model} - the parent object of this chart in the component hierarchy.
Bar Series 107
Bar Series
This section describes properties and events for Bar series components.
Properties
The following properties can be configured for Bar series components: Property Name Series Name X Field Y Field Min Field Bar Height Fill Description The name of the series in the Component Hierarchy palette. The name of the series. This value is displayed as a text entry in the chart legend. The name of the attribute in each CDF record containing x-coordinate values. The name of the attribute in each CDF record containing y-coordinate values. The CDF record attribute containing the minimum x-value of the bar. This field is optional. For linear and logarithmic axes, the height of each bar in pixels. The vector fill used for shapes in the series. The syntax is:
color [alpha]
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. alpha is an optional float value between 0.0 and 1.0. If no value is specified, the default coloring scheme is used.
108
| Chapter 5
Charting Components
Property Stroke
Description The vector stroke for outlining shapes in the series. The syntax is:
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the stroke in pixels. alpha is an optional float value between 0.0 and 1.0. Fill Gradient The fill gradient used for shapes in the series. The syntax is:
The gradient is rendered starting from the main fill color/fill alpha and ending at color2/alpha2 along the specified angle. Optional intermediate colors along the way are defined by percent and stop_color pairs. Pairs are separated by commas. For example, red 0 1 50% white, 75% black. color2 is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. angle specifies the angle of the gradient vector measured in degrees (between 0 and 360) counter-clockwise from 12 o'clock. alpha2 is an optional float value between 0.0 and 1.0. Color Function A static function used to color per-category regions in a series. A category corresponds to one row in a CDF document. Whether the series displays in the chart. The default value is Block, which specifies to display the series. If None is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default function displays the x- and y-coordinates of the bar, along with the minimum x-value.
Display
Tooltip Function
Bar Series 109
Property Bound Menu
Description A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Events
The following events can be configured for Bar series components: Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.BarSeries} BarSeries
- the current

- the current

110
| Chapter 5
Charting Components
Name Spyglass
- the current
object.
objEVENT {jsx3.gui.Event} - the browser event that

intINDEX {int}
- the index value of the clicked record in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file.
Menu
Fires just before a right-click menu for the series is displayed. If the function evaluates to false, no menu displays. Parameters:
- the current

Bar Series 111
Name Destroy
112
| Chapter 5
Charting Components
Bubble Series
This section describes properties and events for Bubble series components.
Properties
The following properties can be configured for Bubble series components: Property Name Series Name X Field Y Field Magnitude Field Renderer Fill Description The name of the series in the Component Hierarchy palette. The name of the series. This value is displayed as a text entry in the chart legend. The name of the attribute in each CDF record containing x-coordinate values. The name of the attribute in each CDF record containing y-coordinate values. The CDF record attribute containing the magnitude value. The point renderer to use. The vector fill used for shapes in the series. The syntax is:
color [alpha] coloris specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. alpha is an optional float value between 0.0 and 1.0. If no value is specified, the default coloring scheme is used.
Stroke
The vector stroke for outlining shapes in the series. The syntax is:
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the stroke in pixels. alpha is an optional float value between 0.0 and 1.0.
Bubble Series 113
Property Fill Gradient
Description The vector fill gradient used for shapes in the series. The syntax is:
The gradient is rendered starting from the main fill color/fill alpha and ending at color2/alpha2 along the specified angle. Optional intermediate colors along the way are defined by percent and stop_color pairs. Pairs are separated by commas. For example, red 0 1 50% white, 75% black. color2is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. angle specifies the angle of the gradient vector measured in degrees (between 0 and 360) counter-clockwise from 12 o'clock. alpha2 is an optional float value between 0.0 and 1.0. Color Function A static function used to color per-category regions in a series. A category corresponds to one row in a CDF document. Whether the series displays in the chart. The default value is Block, which specifies to display the series. If None is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default function displays the x- and y-coordinates of the bubble, along with the magnitude. A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Display
Tooltip Function
Bound Menu
114
| Chapter 5
Events
Charting Components
The following events can be configured for Bubble series components: Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.BubbleSeries} BubbleSeries
- the current
object.

intINDEX {int}-
the index value of the clicked record in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file.
Select
- the current
object.

intINDEX {int}-
Bubble Series 115
Name Spyglass
- the current
object.

intINDEX {int}-
Menu
- the current

116
| Chapter 5
Charting Components
Name Destroy
Category Axis 117
Category Axis
This section describes properties and events for Axis - Category components.
Properties
The following properties can be configured for Axis - Category components: Property Name Orientation Width Description The name of the axis in the Component Hierarchy palette. The axis orientation, either horizontal (x-axis) or vertical (y-axis). The default value is Horizontal. For vertical axes, the horizontal space in pixels between axis ticks, between ticks and tick labels, and between labels. The CDF record attribute to use as the value of each category. This value can be further transformed by the Label Function property. The number of category widths to use for padding the axis before the first category. This value is usually between 0.0 and 1.0. The number of category widths to use for padding the axis after the last category. This value is usually between 0.0 and 1.0. Specifies to display one major tick mark for each category, with the category and its axis label centered on the tick. If this value is Between, each category and its axis label are aligned between two major ticks. The result is one more major tick mark than there are categories. The default value is Between. If Aligned is specified, there is one major tick mark for each category and the category and its axis label are centered on the tick.
Label Field
Padding Low
Padding High
Mj Tick Alignment
118
| Chapter 5
Charting Components
Property Show Axis
Description Whether to display the line representing the axis. The default value is true. If false is specified, only axis tick marks and labels, if specified, are displayed. The vector stroke to use to render the line along the axis. The syntax is:
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0. The default value is black 1 1.
Axis Stroke
Mj Tick Length Mj Tick Stroke
The length of each major tick in pixels. The default value is 0. The vector stroke to use to render major tick marks. The syntax is:
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0.
Mj Tick Placement
The location of major tick marks in relation to the line of the axis. A value of outside draws a tick from the axis line toward the quadrant of the axis, Inside draws a tick from the axis line away from the quadrant of the axis, Cross draws a tick centered on the axis line, and None draws no major ticks. The length of each minor tick in pixels. The default value is 0.
Mn Tick Length
Category Axis 119
Property Mn Tick Stroke
Description The vector stroke to use to render the minor tick marks. The syntax is:
Mn Tick Placement
The location of minor ticks relative to the axis line. See the Mj Tick Placement property for details. The default value is none. The number of minor tick divisions between each major tick. The actual number of minor ticks between major ticks is one fewer than this value. The default value is 0. Whether to display axis labels at each major tick. If false is specified, only axis tick marks and the axis line, if specified, are displayed. The number of pixels between major ticks and major tick labels. The default value is 0. The location of major tick labels. A value of axis displays labels next to the axis line, low displays labels outside of the data area in the quadrant of the axis, and high displays labels outside of the data area in the quadrant opposite the axis. The default value is axis.
Mn Tick Divisions
Show Labels
Label Gap Label Placement
120
| Chapter 5
Charting Components
Property Label Function
Description A function that converts an axis value, string or number, to an axis label string. This value is a string value that evaluates to a function, but quotation marks are not necessary. If no function is specified, the axis value is converted to a string and displayed. Specify a user-defined or a default function. User-defined functions must be in the following format:
function (x) { return x; }
For example:
function degreeLabel(value) { return value + "°"; }
The following functions are provided:

Axis.percent
appends the % character to a linear axis value formats a linear axis value in
Axis.scientific
scientific notation When programmatically setting this property using JavaScript, specify the argument to Axis.setLabelFunction() as a string that evaluates to a function in the required format. Label CSS Class Label CSS Styles Bound Menu The CSS class to apply to each major tick label. The CSS style attribute to apply to each major tick label. Multi-line text is not recommended. A menu to display when a user right-clicks on the axis with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Category Axis 121
Events
The following events can be configured for Axis - Category components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.CategoryAxis} CategoryAxis
- the current
object.
- the current

Fires when the axis component is removed from the component hierarchy. Parameters:
objPARENT {jsx3.app.Model} - the parent object of this axis in the component hierarchy.
122
| Chapter 5
Charting Components
Chart Label
This section describes properties and events for Chart Label components.
Properties
The following properties can be configured for Chart Label components: Property Name Width Height Text/HTML Rotation Type string int int string int Description The name of the label in the Component Hierarchy palette. The optional, manually set width of the label in pixels. The optional, manually set height of the label in pixels. The text to render in the label. The angle for rendering the label, one of and COUNTERCLOCKWISE. The default value is NONE.
NONE, CLOCKWISE,
If CLOCKWISE or COUNTERCLOCKWISE is specified, the label text should display on a single line. Font Name Font Size Font Weight string string string The name of the font for rendering the label. The point size of the font for rendering the label. The weight of the font for rendering the label, either bold or normal. The default value is Normal. The color of the font for rendering the label. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000.
Color
string
Chart Label 123
Property CSS Class BG Color
Type string string
Description The CSS class to use to render the label text. The fill color of the background rectangle. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The vector stroke for the outline of the background rectangle. The syntax is:
Border Stroke
VectorStroke
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0. BG Alpha float The alpha value (opacity) of the background rectangle. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The alignment of label text in the background rectangle, one of center, left, or right. The CSS padding string specifying the space between the label background and the label text in pixels. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. Whether the label displays in the chart. The default value is Block, which specifies to display the label. If None is selected, the label is not displayed in the chart but remains in the Component Hierarchy palette.
Text Align
string
Padding
string
Display
string
124
| Chapter 5
Charting Components
Property Bound Menu
Type string
Description A menu to display when a user right-clicks on the label with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Events
The following events can be configured for Chart Label components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.ChartLabel} ChartLabel
- the current
object.
triggered the model event. Fires just before a right-click menu for the chart is displayed. If the function evaluates to false, no menu displays. Parameters:
- the current

Chart Label 125
Name Destroy
Description Fires when the label component is removed from the component hierarchy. Parameters:
objPARENT {jsx3.app.Model} - the parent object of this label in the component hierarchy.
126
| Chapter 5
Charting Components
Column Chart
This section describes properties and events shared by all Column chart components, including Column, Column- LinearX, Column- Stacked, and Column - Stacked 100%.
Properties
The following properties can be configured for all Column chart components: Property Name Left Description The name of the chart in the Component Hierarchy palette. The size of the blank space, in pixels, to leave at the left edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The size of the blank space, in pixels, to leave at the top edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The chart width in implied pixels or as a percentage. For example, 100 or 25%. The chart height in implied pixels or as a percentage. For example, 100 or 25%. Whether to use relative or absolute positioning for the chart, in relation to its container. The default value is Relative.
stacked 100%.
Top
Type Column Overlap
The type of column chart, clustered, stacked, or The default value is clustered.
The ratio of each bar or column that overlaps with the adjacent bar or column in the same category. If this value is negative, a gap is inserted between adjacent bars or columns. The default value is 0.0.
Column Chart 127
Property Column Coverage
Description The ratio of the width of each category that is occupied by bars or columns. Specify a value between 0.0 and 1.0. If this value is less than 1.0, columns are centered horizontally in the category. The string identifier of the cached CDF file with chart data. This string is displayed in the Local Data Cache palette. The XML string (CDF) with chart data. The URL of the CDF file with chart data. The file can be local or remote. Paths can be relative or absolute. Whether to delete the associated CDF document when the chart component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The RGB value of the chart background fill. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The alpha value (opacity) of the chart background fill. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The RGB color of the chart border. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The width, in pixels, of the chart border. The default value is 1. The alpha value (opacity) of the chart border. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The CSS padding value between the chart border and the contents of the chart. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0.
XML Cache Id
XML (String) XML URL Share Resources
BG Color
BG Alpha
Border Color
Padding
128
| Chapter 5
Charting Components
Property Data Area Padding
Description The CSS padding value for the data area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The default value is 0. The location of the chart title - top, right, bottom, left. The default value is top. The location of the legend, one of top, right, bottom, left. The default value is right. A menu to display when a user right-clicks on the chart with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Title Placement Legend Placement Bound Menu
Events
The following events can be configured for all Column chart components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters:
this {jsx3.chart.ColumnChart} ColumnChart
- the current
object.
Column Chart 129
Name Menu
Description Fires just before a right-click menu for the chart is displayed. If the function evaluates to false, no menu displays. Parameters:
- the current

Destroy
130
| Chapter 5
Charting Components
Column Series
This section describes properties and events for Column series components.
Properties
The following properties can be configured for Column series components: Property Name Series Name X Field Y Field Min Field Column Width Fill Description The name of the series in the Component Hierarchy palette. The name of the series. This value is displayed as a text entry in the chart legend. The name of the attribute in each CDF record containing x-coordinate values. The name of the attribute in each CDF record containing y-coordinate values. The CDF record attribute containing the minimum y-value for the column. This field is optional. The width of each column in pixels. This value is used only if the x-axis of the chart is linear or logarithmic. The fill used for shapes in the series. The syntax is:
color [alpha]
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. alpha is an optional float value between 0.0 and 1.0. If no value is specified, the default coloring scheme is used.
Column Series 131
Property Stroke
Description The stroke for outlining shapes in the series. The syntax is:
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the stroke in pixels. alpha is an optional float value between 0.0 and 1.0.
Fill Gradient
The fill gradient used for shapes in the series. The syntax is:

Color Function
A static function used to color per-category regions in a series. A category corresponds to one row in a CDF document. Whether the series displays in the chart. The default value is Block, which specifies to display the series. If None is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default function displays the x- and y-coordinates of the column, along with the minimum x-value.
Display
Tooltip Function
132
| Chapter 5
Charting Components
Property Bound Menu
Description A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Events
The following events can be configured for Column series components: Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.ColumnSeries} ColumnSeries
- the current
object.

intINDEX {int}-
Select
- the current
object.

Column Series 133
Name Spyglass
- the current
object.

intINDEX {int}-
Menu
- the current

134
| Chapter 5
Charting Components
Name Destroy
Grid Lines 135
Grid Lines
This section describes properties and events for Grid Lines components.
Properties
The following properties can be configured for Grid Lines components: Property Name Draw in Foreground Layering Description The name of the grid lines component in the Component Hierarchy palette. Whether to render grid lines in front of any data series. The default value is false. Whether horizontal fills, major ticks, and minor ticks and rendered above vertical equivalents. The default value is Horizontal Above Vertical. The vector stroke to use for outlining the data area. The syntax is:
Border
Ver Fill
The vector fill between vertical major tick marks. The syntax is:
You can also specify a comma-separated list of values. For example, red .5, blue .5, green 1. The fill cycles through the values in the array at each major tick.
136
| Chapter 5
Charting Components
Property Ver Major Stroke
Description The vector stroke to use between vertical major tick lines. The syntax is:
color [width [alpha]] color isspecified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the tick line in pixels. alpha is an optional float value between 0.0 and 1.0.
You can also specify a comma-separated list of values. For example, red 1 .5, blue 2 .5, green 1 1. The fill cycles through the values in the array at each major tick. Ver Minor Stroke The vector stroke to use between minor vertical tick lines. The syntax is:
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the tick line in pixels. alpha is an optional float value between 0.0 and 1.0.
You can also specify a comma-separated list of values. For example, red 1 .5, blue 2 .5, green 1 1. The fill cycles through the values in the array at each minor tick. Hor Fill The vector fill between horizontal major tick marks. The syntax is:
You can also specify a comma-separated list of pair values. For example, red .5, blue .5, green 1. The fill cycles through the values in the array at each major tick.
Grid Lines 137
Property Hor Major Stroke
Description The vector stroke to use between horizontal major tick lines. The syntax is:
You can also specify a comma-separated list of values. For example, red 1 .5, blue 2 .5, green 1 1. Major tick lines cycle through the values in the array. Hor Minor Stroke The vector stroke to use to mark the minor horizontal tick lines. The syntax is:
You can also specify a comma-separated list of values. For example, red 1 .5, blue 2 .5, green 1 1. Minor tick lines cycle through the values in the array. Display Whether grid lines display in the chart. The default value is Block, which specifies to display grid lines. If None is selected, grid lines are not displayed in the chart, but the component remains in the Component Hierarchy palette. A menu to display when a user right-clicks on the grid line with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Bound Menu
138
| Chapter 5
Events
Charting Components
The following events can be configured for Grid Lines components: Event Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.GridLines} GridLines
- the current
object.
- the current

Fires when the grid lines component is removed from the component hierarchy. Parameters:
objPARENT {jsx3.app.Model} - the parent object of this grid lines in the component hierarchy.
Legend 139
Legend
This section describes properties and events for Legend components.
Properties
The following properties can be configured for Legend components: Property Name Width Description The name of the legend in the Component Hierarchy palette. The horizontal space to dedicate to the legend and its margin. This value is used only if the Legend Placement property for the chart has a value of right or left. The vertical space to dedicate to the legend and its margin. This value is used only if the Legend Placement property for the chart has a value of top or bottom. The diameter of the colored boxes to render for each legend entry in pixels. The vertical space to use for each legend entry in pixels. The CSS class to apply to each legend entry. The CSS style attribute to apply to each legend entry. The CSS padding string specifying the space between the legend background and the legend content in pixels. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. Margin The CSS margin string specifying the space between the legend background and its bounding area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0.
Height
Box Height Line Height Label CSS Class Label CSS Styles Padding
140
| Chapter 5
Charting Components
Property Background Fill
Description The vector fill for the background of the legend. The syntax is:
Background Stroke
The vector stroke for the background of the legend. The syntax is:
Display
Whether the legend displays in the chart. The default value is Block, which specifies to display the legend. If None is selected, the legend is not displayed in the chart but remains in the Component Hierarchy palette. A menu to display when a user right-clicks on the legend with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Bound Menu
Legend 141
Events
The following events can be configured for Legend components. If the cursor is not on a legend entry, the objSERIES argument (Cartesian charts) or intINDEX and strRECORDID arguments (radial charts) are null. Name Execute Description Fires when a user double-clicks with the mouse on the legend. Parameters:
this {jsx3.chart.Legend}
- the current Legend
object.
triggered the model event. For Cartesian charts:

objSERIES {jsx3.chart.Series} - the series that is the target of the event if the event occurs on a legend entry and this legend displays series.
For radial charts:

intINDEX {int}- the index value of the clicked category in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file. strRECORDID {String} - the value of the jsxid attribute of the clicked category.
142
| Chapter 5
Charting Components
Name Select
Description Fires when a user clicks with the mouse on the legend. Parameters:
object.

For radial charts:

intINDEX {int}- the index value of the clicked category in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file. strRECORDID {String} - the value of the jsxid attribute of the clicked category.
Legend 143
Name Spyglass
object.

For radial charts:

intINDEX {int}
- the index value of the clicked category in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file.
strRECORDID {String} - the value of the jsxid attribute of the clicked category.
144
| Chapter 5
Charting Components
Name Menu
Description Fires just before a right-click menu for the chart is displayed. If the function evaluates to false, no menu displays. Parameters:
- the current Legend the browser event
object.

For Cartesian charts:

For radial charts:

intINDEX {int} - the index value of the clicked category in the set of CDF records. CDF records are indexed sequentially according to the order they occur in the file. strRECORDID {String} - the value of the jsxid attribute of the clicked category.
Destroy
Fires when the legend component is removed from the component hierarchy. Parameters:

objPARENT {jsx3.app.Model} - the parent object of this legend in the component hierarchy.
Line Chart 145
Line Chart
This section describes properties and events shared by all Line chart components, including Line, Line - LinearX, Line - Stacked, and Line - Stacked 100%.
Properties
The following properties can be configured for all Line chart components: Property Name Left Description The name of the chart in the Component Hierarchy palette. The size of the blank space, in pixels, to leave at the left edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The size of the blank space, in pixels, to leave at the top edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The chart width in implied pixels or as a percentage. For example, 100 or 25%. The chart height in implied pixels or as a percentage. For example, 100 or 25%. Whether to use relative or absolute positioning for the chart, in relation to its container. The default value is Relative.
stacked,
Top
Type XML Cache Id
The type of line chart. Possible values are overlay, and stacked 100%.
The string identifier of the cached CDF file with chart data. This string is displayed in the Local Data Cache palette. The XML string (CDF) with chart data. The URL of the CDF file with chart data. The file can be local or remote. Paths can be relative or absolute.
XML (String) XML URL
146
| Chapter 5
Charting Components
Property Share Resources
Description Whether to delete the associated CDF document when the chart component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The RGB value of the chart background fill. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The alpha value (opacity) of the chart background fill. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The RGB color of the chart border. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The width, in pixels, of the chart border. The default value is 1. The alpha value (opacity) of the chart border. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The CSS padding value between the chart border and the contents of the chart. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The CSS padding value for the data area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The default value is 0. The location of the chart title, one of top, right, bottom, left. The default value is top. The location of the legend, one of top, right, bottom, left. The default value is right.
BG Color
BG Alpha
Border Color
Padding
Data Area Padding
Line Chart 147
Property Bound Menu
Events
The following events can be configured for all Line chart components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.LineChart} LineChart
- the current
object.
- the current

148
| Chapter 5
Charting Components
Name Destroy
Line Series 149
Line Series
This section describes properties and events for Line series components.
Properties
The following properties can be configured for all Line series components: Property Name Series Name X Field Y Field Type Description The name of the series in the Component Hierarchy palette. The name of the series. This value is displayed as a text entry in the chart legend. The name of the attribute in each CDF record containing x-coordinate values. The name of the attribute in each CDF record containing y-coordinate values. The form of the line series, which defines how to connect data points. segment draws straight lines between points. horizontal draws only the horizontal distance between points at the y-coordinate of the second point. vertical draws only the vertical distance between points at the x-coordinate of the second point. step draws the horizontal portion and then the vertical portion of the space between points. reverseStep draws the vertical portion and then the horizontal portion of the space between steps. The default value is segment. Whether to display a continuous line when data points are missing. If false is specified, the line is discontinuous over missing data points. The default value is false.
Interpolate Values
150
| Chapter 5
Charting Components
Property Stroke
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the point in pixels. alpha is an optional float value between 0.0 and 1.0.
Point Renderer
The optional shape displayed at each data point, in front of the line connecting the data points. Either select one of the default shapes (circle, cross, diamond, box, or triangle) from the property menu, or type the name of a custom point renderer object. The radius of the shapes to draw at each data point. The default is 4. The vector fill to use for points. The syntax is:
Point Stroke
The vector stroke to use for points. The syntax is:

color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the point in pixels. alpha is an optional float value between 0.0 and 1.0.
Line Series 151
Property Point Gradient
Description The gradient to use for points. The syntax:


Color Function
A static function used to color per-category regions in a series. A category corresponds to one row in a CDF document. Whether the series displays in the chart. The default value is Block, which specifies to display the series. If None is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default function displays the x- and y-coordinates of the data point. A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Display
Tooltip Function
Bound Menu
152
| Chapter 5
Events
Charting Components
The following events can be configured for all Line series components. If no record corresponds to the region that is clicked, both intINDEX and strRECORDID arguments are null. Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.LineSeries} LineSeries
- the current
object.

intINDEX {int}-
Select
- the current
object.

intINDEX {int}-
Line Series 153
Name Spyglass
- the current
object.

intINDEX {int}-
Menu
- the current

154
| Chapter 5
Charting Components
Name Destroy
Linear Axis 155
Linear Axis
This section describes properties and events for Axis - Linear components.
Properties
The following properties can be configured for Axis - Linear components: Property Name Orientation Width Description The name of the axis in the Component Hierarchy palette. The axis orientation, either horizontal (x-axis) or vertical (y-axis). The default value is Horizontal. For vertical axes, the horizontal space in pixels between axis ticks, between ticks and tick labels, and between labels. Whether to adjust the displayed Minimum Value, Maximum Value, and Interval properties according to the chart data. Only values not explicitly set will be automatically calculated. The default value is true. Whether to base the axis range at zero when the Auto Adjust property is set to true. If this value is true and all the data points are either greater than zero or less than zero, then one end of this axis will be zero. The default value is true. The manually set minimum value to display on the axis. Intervals always begin from this value. The manually set maximum value to display on the axis. The manually set interval value. The axis displays major ticks at min + n * interval. Whether to display the line representing the axis. The default value is true. If false is specified, only axis tick marks and labels, if specified, are displayed.
Auto Adjust
Base At Zero
Minimum Value Maximum Value Interval Show Axis
156
| Chapter 5
Charting Components
Property Axis Stroke
Description The vector stroke to use to render the line along the axis. The syntax is:
color [width [alpha]] color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0. The default value is black 1 1.
Mj Tick Length Mj Tick Stroke
The length of each major tick in pixels. The default value is 0. The vector stroke to use to render major tick marks. The syntax is:
Mj Tick Placement
The location of major tick marks in relation to the line of the axis. A value of outside draws a tick from the axis line toward the quadrant of the axis, inside draws a tick from the axis line away from the quadrant of the axis, cross draws a tick centered on the axis line, and none draws no major ticks. The length of each minor tick in pixels. The default value is 0. The vector stroke to use to render the minor tick marks. The syntax is:
Mn Tick Length Mn Tick Stroke
Linear Axis 157
Property Mn Tick Placement
Description The location of minor ticks relative to the axis line. See the Mj Tick Placement property for details. The default value is none. The number of minor tick divisions between each major tick. The actual number of minor ticks between major ticks is one fewer than this value. The default value is 0. Whether to display axis labels. If false is specified, only axis tick marks and the axis line, if specified, are displayed. The number of pixels between major ticks and major tick labels. The default value is 0. The location of major tick labels. A value of axis displays labels next to the axis line, low displays labels outside of the data area in the quadrant of the axis, and high displays labels outside of the data area in the quadrant opposite the axis. The default value is axis.
Mn Tick Divisions
Show Labels
158
| Chapter 5
Charting Components
For example:
The following functions are provided:

Axis.percent appends the % character to a linear
axis value
Axis.scientific
formats a linear axis value in
scientific notation When programmatically setting this property using JavaScript, specify the argument to Axis.setLabelFunction() as a string that evaluates to a function in the required format. Label CSS Class Label CSS Styles Bound Menu The CSS class to apply to each major tick label. Uses the The CSS style attribute to apply to each major tick label. Multi-line text is not recommended. A menu to display when a user right-clicks on the axis with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Linear Axis 159
Events
The following events can be configured for Axis - Linear components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.LinearAxis} LinearAxis
- the current
object.
- the current

160
| Chapter 5
Charting Components
Logarithmic Axis
This section describes properties and events for Axis - Logarithmic components.
Properties
The following events can be configured for Axis - Logarithmic components: Property Name Orientation Width Description The name of the axis in the Component Hierarchy palette. The axis orientation, either horizontal (x-axis) or vertical (y-axis). The default value is Horizontal. For vertical axes, the horizontal space in pixels between axis ticks, between ticks and tick labels, and between labels. Whether to adjust the displayed Minimum Exponent and Maximum Exponent properties according to the chart data. Only values not explicitly set will be automatically calculated. The default value is false. Whether to set Minimum Exponent equal to 0 when the Auto Adjust property is set to true. The manually set minimum exponent to display on the axis. The minimum displayed value is the Exponent Base value raised to the power of Minimum Exponent. The manually set maximum exponent to display on the axis. The maximum displayed value is the Exponent Base value raised to the power of Maximum Exponent. The base of the exponent to use. Whether to display the line representing the axis. The default value is true. If false is specified, only axis tick marks and labels, if specified, are displayed.
Auto Adjust
Base At Zero Exponent Minimum Exponent Maximum Exponent Exponent Base Show Axis
Logarithmic Axis 161
Property Axis Stroke
Description The vector stroke to use to render the line along the axis. The syntax is:
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0. The default value is black 1 1. Mj Tick Length Mj Tick Stroke The length of each major tick in pixels. The default value is 0. The vector stroke to use to render major tick marks. The syntax is:
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0. Mj Tick Placement The location of major tick marks in relation to the line of the axis. A value of outside draws a tick from the axis line toward the quadrant of the axis, inside draws a tick from the axis line away from the quadrant of the axis, cross draws a tick centered on the axis line, and none draws no major ticks. The default value is outside. The length of each minor tick in pixels. The default value is 0. The vector stroke to use to render the minor tick marks. The syntax is:
Mn Tick Length Mn Tick Stroke
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the line in pixels. alpha is an optional float value between 0.0 and 1.0.
162
| Chapter 5
Charting Components
Property Mn Tick Placement Mn Tick Divisions
Description The location of minor ticks relative to the axis line. See the Mj Tick Placement property for details. The default value is none. The number of minor tick divisions between each major tick. The actual number of minor ticks between major ticks is one fewer than this value. The default value is 0. Whether to display axis labels. If false is specified, only axis tick marks and the axis line, if specified, are displayed. The number of pixels between major ticks and major tick labels. The default value is 0. The location of major tick labels. A value of axis displays labels next to the axis line, low displays labels outside of the data area in the quadrant of the axis, and high displays labels outside of the data area in the quadrant opposite the axis. The default value is axis.
Show Labels
Logarithmic Axis 163
For example:
The default functions are:

Axis.percent
appends the % character to a linear formats a linear axis value in
axis value
Axis.scientific
scientific notation When programmatically setting this property using JavaScript, specify the argument to Axis.setLabelFunction() as a string that evaluates to a function in the required format. Label CSS Class Label CSS Styles Bound Menu The CSS class to apply to each major tick label. The CSS style attribute to apply to each major tick label. A menu to display when a user right-clicks on the axis with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
164
| Chapter 5
Events
Charting Components
The following events can be configured for Axis - Logarithmic components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.LogarithmicAxis}
- the current
LogarithmicAxis object.
this {jsx3.chart.LogarithmicAxis} LogarithmicAxis
- the current

this {jsx3.chart.LogarithmicAxis} LogarithmicAxis
Pie Chart 165
Pie Chart
This section describes properties and events shared by all Pie chart components, including Pie and Pie - Doughnut.
Properties
The following properties can be configured for all Pie chart components: Property Name Left Description The name of the chart in the Component Hierarchy palette. The size of the blank space, in pixels, to leave at the left edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The size of the blank space, in pixels, to leave at the top edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The chart width in implied pixels or as a percentage. For example, 100 or 25%. The chart height in implied pixels or as a percentage. For example, 100 or 25%. Whether to use relative or absolute positioning for the chart, in relation to its container. The default value is Relative. The radius of the inner circle of the chart as a ratio of the radius of the outermost series. Specify a value from 0.0 to 1.0. The default value is 0.0. The amount of padding between series, as a ratio of the width of a series. The default value is 0. The angle, in degrees, equal to 100% of the sum of the values in a series. A value of 360 renders a traditional pie chart, and smaller values render a pie chart with a slice missing. A series can override this value using the series Total Angle property. The default value is 360.
Top
Width Height Relative XY Inner Radius
Series Padding Total Angle
166
| Chapter 5
Charting Components
Property Start Angle
Description The initial angle of the first slice in each series. A value of 0 points north and increasing values continue clockwise. A series can override this value using the series Start Angle property. The default value is 0. The name of the attribute in each CDF record containing category values. These values are displayed as entries in a legend. A comma-separated array of vector fill values used to color in the slices in each series. The syntax for each value is:
color [alpha]
Category Field
Colors
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. alpha is an optional float value between 0.0 and 1.0. If no value is specified, the default coloring scheme is used. A series can override this value using the series Colors property. Series Stroke The vector stroke for outlining each series. The syntax is:
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the stroke in pixels. alpha is an optional float value between 0.0 and 1.0. A series can override this value using the series Stroke property. Color Function A function, specified instead of the series Colors property, that returns a VectorFill for a particular slice. A series can override this value using the series Color Function property. If no value is specified, the default coloring scheme is used. The string identifier of the cached CDF file with chart data. This string is displayed in the Local Data Cache palette. The XML string (CDF) with chart data.
XML Cache Id XML (String)
Pie Chart 167
Property XML URL Share Resources
Description The URL of the CDF file with chart data. The file can be local or remote. Paths can be relative or absolute. Whether to delete the associated CDF document when the chart component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The RGB value of the chart background fill. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The alpha value (opacity) of the chart background fill. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The RGB color of the chart border. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The width, in pixels, of the chart border. The default value is
1.
BG Color
BG Alpha
Border Color
The alpha value (opacity) of the chart border. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The CSS padding value between the chart border and the contents of the chart. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The CSS padding value for the data area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The default value is 0. The location of the chart title, one of top, right, bottom, left. The default value is top. The location of the legend, one of top, right, bottom, left. The default value is right.
Padding
Data Area Padding
168
| Chapter 5
Charting Components
Property Bound Menu
Events
The following events can be configured for all Pie chart components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.PieChart} - the current PieChart
object.
object.
the browser event


Pie Series 169
Pie Series
This section describes properties and events for Pie series components.
Properties
The following properties can be configured for all Pie series components: Property Name Series Name Field Description The name of the series in the Component Hierarchy palette. The name of the series. The attribute of the CDF record containing the value, which is the size of a slice relative to other slices in this series. The angle equal to 100% of the sum of the values in a series, in degrees. This value overrides the chart Total Angle property for this series. The initial angle of the first slice in each series. This value overrides the chart Start Angle property for this series. A comma-separated array of vector fill values used to color in the slices in each series. This value overrides the chart Colors property for this series. The vector stroke for outlining each series. The syntax is:
Total Angle
Start Angle Colors
Stroke
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the stroke in pixels. alpha is an optional float value between 0.0 and 1.0. This value overrides the chart Series Stroke property for this series.
170
| Chapter 5
Charting Components
Property Color Function
Description A function, specified instead of the series Colors property, that returns a VectorFill for a particular slice. This value overrides the chart Color Function for this series. For an example, see JSXAPPS/samples/chart. The quadrant for rendering the chart label, if any. Valid values are top, right, bottom, and left. The default value is bottom. The number of pixels of offset from the outside edge of the series to the inside edge of the label. The default value is 0. Whether the series displays in the chart. The default value is Block, which specifies to display the series. If None is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default function displays the value of the category as a percent rounded to the nearest integer. A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Label Placement
Label Offset Display
Tooltip Function
Bound Menu
Pie Series 171
Events
The following events can be configured for Pie series components: Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.PieSeries} PieSeries
- the current
object.

- the current
object.

172
| Chapter 5
Charting Components
Name Spyglass
- the current
object.

this {jsx3.chart.PieSeries} AreaSeries
- the current

Pie Series 173
Name Destroy
174
| Chapter 5
Charting Components
Plot Chart
This section describes properties and events shared by all Plot chart components, including Plot - Bubble and Plot - Point.
Properties
The following properties can be configured for all Plot chart components: Property Name Left Description The name of the chart in the Component Hierarchy palette. The size of the blank space, in pixels, to leave at the left edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The size of the blank space, in pixels, to leave at the top edge of the bounding box. If absolutely positioned, the default is 0. If relatively positioned, the default is empty. The chart width in implied pixels or as a percentage. For example, 100 or 25%. The chart height in implied pixels or as a percentage. For example, 100 or 25%. Whether to use relative or absolute positioning for the chart, in relation to its container. The default value is Relative. The largest point radius to display in the chart. Any point that exceeds this size is constrained to this value. The default value is 30. For points in a series (Plot - Point charts) or a category (Plot - Bubble charts), whether point magnitude is proportional to the chart radius, chart diameter, or the area of a point. The string identifier of the cached CDF file with chart data. This string is displayed in the Local Data Cache palette.
Top
Max Radius
Magnitude Method
XML Cache Id
Plot Chart 175
Property XML (String) XML URL Share Resources
Description The XML string (CDF) with chart data. The URL of the CDF file with chart data. The file can be local or remote. Paths can be relative or absolute. Whether to delete the associated CDF document when the chart component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. The RGB value of the chart background fill. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The alpha value (opacity) of the chart background fill. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The RGB color of the chart border. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. The width, in pixels, of the chart border. The default value is 1. The alpha value (opacity) of the chart border. Specify a value from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 1.0. The CSS padding value between the chart border and the contents of the chart. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The CSS padding value for the data area. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. The default value is 0. The location of the chart title, one of top, right, bottom, left. The default value is top.
BG Color
BG Alpha
Border Color
Padding
Data Area Padding
Title Placement
176
| Chapter 5
Charting Components
Property Legend Placement Bound Menu
Description The location of the legend, one of top, right, bottom, left. The default value is right. A menu to display when a user right-clicks on the chart with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Events
The following events can be configured for all Plot chart components: Name Spyglass Description Fires when a spyglass window is displayed. The function must evaluate to the HTML content for displaying in the spyglass. If the function evaluates to false, no spyglass window displays. Parameters: Menu
this {jsx3.chart.PlotChart} PlotChart
- the current
object.
- the current

Plot Chart 177
Name Destroy
178
| Chapter 5
Charting Components
Point Series
This section describes properties and events for Point series components.
Properties
The following properties can be configured for all Point series components: Property Name Series Name X Field Y Field Magnitude Renderer Fill Description The name of the series in the Component Hierarchy palette. The name of the series. This value is displayed as a text entry in the chart legend. The name of the attribute in each CDF record containing x-coordinate values. The name of the attribute in each CDF record containing y-coordinate values. The magnitude of each point in the series. The name of the point renderer to use. The vector fill used for shapes in the series. The syntax is:
color [alpha]
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. alpha is an optional float value between 0.0 and 1.0. If no value is specified, the default coloring scheme is used. Stroke The vector stroke for outlining shapes in the series. The syntax is:
color is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. width is an optional integer value specifying the width of the stroke in pixels. alpha is an optional float value between 0.0 and 1.0.
Point Series 179
Property Fill Gradient
Description The fill gradient used for shapes in the series. The syntax is:
The gradient is rendered starting from the main fill color/fill alpha and ending at color2/alpha2 along the specified angle. Optional intermediate colors along the way are defined by percent and stop_color pairs. Pairs are separated by commas. For example, red 0 1 50% white, 75% black. color2 is specified as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. angle specifies the angle of the gradient vector measured in degrees (between 0 and 360) counter-clockwise from 12 o'clock. alpha2 is an optional float value between 0.0 and 1.0. Color Function A static function used to color per-category regions in a series. A category corresponds to one row in a CDF document. Whether the series displays in the chart. The default value is Block, which specifies to display the series. If None is selected, the series is not displayed in the chart but remains in the Component Hierarchy palette. A function that generates mouse-over tooltips for series shapes. The default function displays the x- and y-coordinates of the point. A menu to display when a user right-clicks on the series with the mouse. Specify the name of the menu component as displayed in the Component Hierarchy palette.
Display
Tooltip Function
Bound Menu
180
| Chapter 5
Events
Charting Components
The following events can be configured for all Point series components: Name Execute Description Fires when a user double-clicks with the mouse on the series. Parameters:
this {jsx3.chart.PointSeries} PointSeries
- the current
object.

- the current
object.

Point Series 181
Name Spyglass
- the current
object.

- the current

182
| Chapter 5
Charting Components
Name Destroy
| 183
Index
A
add-ins, Charting 43 Attributes Editor palette toolbar 19
D
deployment settings 41 Deployment Utility fields 46 dialog field descriptions 33
B E
Block components 62 box model, cross-browser 62 event protocol 44
C
Charting add-in, enabling 43, 92 Charting components 91 class loading 44 class paths 44 Color Picker Tool fields 45 Component Hierarchy palette toolbar 20 Component Libraries palette toolbar 21 components Block 62 Charting 91 Containers 64 Form Elements 65 Matrix 67 Menus and Toolbars 89 Miscellaneous 90 Sound 90 Tree 90 Container components 64 context menus 9 customer support xi
F
File menu 3 File Profile dialog 34 Find and Replace Tool fields 48 Form Elements components 65
H
Help menu 8
I
IDE Settings dialog 37
J
JavaScript Step-Through Debugger Utility toolbar 28 JavaScript Test Utility fields 49
184
| Index
JavaScript Test Utility toolbar 27
S
Sound components 90 support, contacting xi System Log toolbar 25
L
legacy settings 44 Local Data Cache palette toolbar 22
T M
Mapper Log toolbar 30 Matrix components 67 menus context menu commands 9 menu commands 1 Menus and Toolbars components 89 Miscellaneous components 90 Taskbar toolbar 32 technical support xi Test Interface toolbar 31 TIBCO General Interface Builder setting IDE preferences 37 tool field descriptions 33 toolbar commands 17 Tools menu 6 Tree component 90 typographical conventions ix
P
Palettes menu 7 preferences IDE settings 37 Project Files palette toolbar 23 Project menu 2 Project Settings dialog 41 project version 44 projects add-ins 43 deployment settings 41 settings 41 workspace 39
W
work area toolbar 18 workspace 39
X
XML Mapping Utility fields 50 XML Mapping Utility toolbar 29 XML/XSL Merge Tool fields 59 XSL Parameters palette toolbar 26
R
Recycle Bin palette toolbar 24 Rules Tree toolbar 29

Tib Gi Pe Ui Reference

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Tib Gi Pe Ui Reference

Hochgeladen von

Copyright:

Verfügbare Formate

TIBCO General Interface Builder GUI Reference

Professional Edition Software Release 3.2 November 2006

Chapter 1 Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2 Toolbar Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 3 Dialogs and Tools Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Color Picker Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

XML/XSL Merge Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Chapter 4 Prototype Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Chapter 5 Charting Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

TIBCO General Interface Builder GUI Reference

TIBCO General Interface Builder GUI Reference

TIBCO General Interface Documentation

TIBCO General Interface Builder GUI Reference

bold code font

TIBCO General Interface Builder GUI Reference

Table 2 Syntax Typographical Conventions Convention

Use An optional item in a command or code syntax. For example:

bold code font

TIBCO General Interface Builder GUI Reference

How to Contact TIBCO Customer Support

TIBCO General Interface Builder GUI Reference

| How to Contact TIBCO Customer Support

TIBCO General Interface Builder GUI Reference

TIBCO General Interface Builder GUI Reference

Recent Projects User Projects

Run Project from HTTP

TIBCO General Interface Builder GUI Reference

JavaScript File CSS File

Dynamic Properties File

TIBCO General Interface Builder GUI Reference

Command Open Recent Files

Save Save to Cache

TIBCO General Interface Builder GUI Reference

Command Save and Reload

Save As Save a Copy to Disk Save All

TIBCO General Interface Builder GUI Reference

TIBCO General Interface Builder GUI Reference

TIBCO General Interface Builder GUI Reference

Help Contents TIBCO Developer Network

About TIBCO General Interface License Agreement

TIBCO General Interface Builder GUI Reference

Palette Context Menus

Component Hierarchy Palette Context Menu Submenu Command

Repaint Re-Fetch Data and Repaint Persistence Transitory

TIBCO General Interface Builder GUI Reference

Submenu Command Embedded

TIBCO General Interface Builder GUI Reference

Submenu Command Referenced Asynchronous

Recycle Descendants Copy Name to Clipboard Copy Getter Code to Clipboard

Component Libraries Palette Context Menu

Command Copy Path

TIBCO General Interface Builder GUI Reference

Auto Load Dereference Load/Reload

TIBCO General Interface Builder GUI Reference

Command Copy Path

TIBCO General Interface Builder GUI Reference

Work Area Context Menus

TIBCO General Interface Builder GUI Reference

Taskbar Context Menu

XML Mapping Utility Context Menu

TIBCO General Interface Builder GUI Reference

Submenu Command Element Attribute

Sample Message Execute (Quick Test)