tib gi pe ui reference

8/2/2019 Tib Gi Pe Ui Reference

1/196

TIBCO General Interface Builder

GUI Reference

Professional EditionSoftware Release 3.2November 2006


2/196

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED 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 BYANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT,THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURINGDOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED INTIBCO GENERAL INTERFACE BUILDER GETTING STARTED GUIDE). USE OF THISDOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOFSHALL 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 copyrightlaws and treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIB, TIBCO, Information Bus, The Power of Now, TIBCO General Interface, and TIBCO GeneralInterface Builder are either registered trademarks or trademarks of TIBCO Software Inc. in theUnited States and/or other countries.

All other product and company names and marks mentioned in this document are the property oftheir 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 ARERELEASED AT THE SAME TIME. PLEASE SEE THE README.TXT FILE FOR THE

AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEMPLATFORM.

THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES 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, DIRECTLYOR 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


3/196

TIBCO General Interface Builder GUI Reference

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

TIBCO General Interface Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Further Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixHow 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Project 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


4/196


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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

IDE Settings Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

IDE Hot Keys Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Paths Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Project Settings Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Deployment Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Add-Ins Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Classpath Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Legacy Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

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

Deployment Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

HTML Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Launch Link Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Inline Div Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Find and Replace Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

JavaScript Test Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

XML Mapping Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Rules Tree Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Rule Profile Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Mapper Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Test Interface Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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


5/196


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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Bubble Series. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Category Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Chart 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


6/196


vi | Contents

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Line Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Linear Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Logarithmic Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Pie 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


7/196


|vii

Preface

TIBCO General Interface Builder is a development environment for building richinternet applications. The object modeling features of General Interface Builderenable developers to quickly create reusable GUI components and assemble theminto full applications or application modules. Applications can be accessed in aweb 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


8/196


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 foroverview information, installation instructions, and information on how to

build TIBCO General Interface applications.

TIBCO General Interface Builder GUI Reference Refer to this manual to learnmore about menus, dialogs, tools, toolbars, and components.

TIBCO General Interface API Reference Refer to this online help content fordescriptions of the TIBCO General Interface JavaScript API functions andmethods.

TIBCO General Interface Release Notes Read the release notes for a list of newand changed features. This document also contains lists of known issues andclosed 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 TIBCODeveloper Network at http://developer.tibco.com, a comprehensive communitythat provides opportunities to increase your understanding of TIBCO GeneralInterface Builder. Among the many resources at this web site you will find:

Video tutorials

Sample projects

Product documentation

Best practices documents

Forums


9/196


Preface | ix

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

code font Code font identifies commands, code examples, filenames, pathnames, andoutput displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code

fontBold code font is used in the following ways:

In procedures, to indicate what a user types. For example: Type the usernameadmin.

In large code samples, to indicate the parts of the sample that are ofparticular 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 Conceptsfor more details.

To introduce new terms For example: A portal page may contain severalportlets. 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: MyCommandpathname

Keycombinations

Key name separated by a plus sign indicate keys pressed simultaneously. Forexample: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after theother. For example: Esc, Ctrl+Q.


10/196


x | 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

fontIn 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 appearwithin each logical group.

For example, the following command requires two parameters, which can beeither param1 and param2 or param3 and param4:

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parametercan 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 thesecond parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}


11/196


Preface |xi

How to Contact TIBCO Customer Support

The Professional Edition of TIBCO General Interface is unsupported. If youwould like support for this product, you may upgrade to the Enterprise Editionand 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 startedwith TIBCO Product Support, visit this site

http://www.tibco.com/services/support.


12/196


xii | How to Contact TIBCO Customer Support


13/196


|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 itscomponents, see Interface Basics in TIBCO General Interface Builder Getting StartedGuide.

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
http://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdf


14/196


2 | Chapter 1 Menu Commands

Project Menu

The Project menu includes the following commands.

Command Description

New Project Displays a prompt to create a new project andopens the new project in the same browserwindow. A default project directory structure isalso created on the file system.

Recent Projects Displays a list of the last ten projects that wereopened. Clicking a project name opens the project.

User Projects Displays a list of all projects in theworkspace/JSXAPPS folder. Clicking a project nameopens the project.

Project Settings Displays the Project Settings dialog for configuringproject deployment, add-ins, class path, and legacysettings for the open project.

Deployment Utility Displays the Deployment Utility which is used togenerate code for deploying the application in abrowser. Create an HTML or XHTML launch pagefor standalone applications or generate HTML

code to insert applications into an existing webpage.

Run Project Runs the current project configuration in a newbrowser window to simulate the runtimeenvironment. The project runs in the same modeasTIBCO General Interface Builder, such as HTMLor XHTML.

Run Project from HTTP Runs the project in a new browser window on alocal HTTP server as specified on the Paths page ofthe IDE Settings dialog. If the HTTP server isntconfigured, you are prompted to configure it.

Fil M |3


15/196


File Menu |3

File Menu

The File menu includes the following commands.

CommandSubmenuCommand

Description

New Creates a new, empty tab in the work area forthe selected file type.

GUIComponent

Creates an empty GUI component file. Savewith the .xml extension in the componentsdirectory of the project.

XMLDocument

Creates an empty XML file for content data,such as default values, for the application.Save with the .xml extension in the xmldirectory of the project.

XSLDocument

Creates an empty XSL file for transformingXML files containing application data. Savewith the .xsl extension in the xsl directory ofthe project.

JavaScriptFile

Creates an empty JavaScript file. Save with a.js extension in the js directory of the project.

CSS File Creates an empty CSS file for definingapplication styles. Save with a .css extensionin the css directory of the project.

DynamicPropertiesFile

Creates an empty dynamic propertiesresource file. Save with the .xml extension inthe jss directory of the project. See DynamicProperties Files in TIBCO General Interface

Builder Getting Started Guide.

MappingRule

Creates an empty mapping rules file forconnecting to web services. Save with the.xml extension in the rules directory of theproject. See Mapping Components to XMLNodes in TIBCO General Interface BuilderGetting Started Guide.

http://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdf


16/196



Open Displays the File dialog for opening an

existing file for use in the application.

Recent Files Displays a list of recently created files.Clicking a file name opens that file in theproject.

Close Closes the active tab. If the file containsunsaved changes, you are prompted to save

the file.

Close All Closes tabs for all open files. If a file containsunsaved changes, you are prompted to savethe file.

Revert Displays a Confirm Revert dialog where youcan choose to revert the active file to the last

saved state.After reloading, any recycled objects arecleared from the Recycle Bin and cannot berecovered.

Revert All Displays a Confirm Revert dialog where youcan choose to revert all open files to the lastsaved state.

After reloading, any recycled objects arecleared from the Recycle Bin and cannot berecovered.

Save Saves the active file.

Save to Cache For an XML document, saves the active fileto the in-memory, local data cache.


Description

File Menu |5


17/196


File Menu |5

Save and

Reload

Saves the active file to disk and reloads the

file appropriate to the file type. For example,JavaScript files (.js) are reloaded into thebrowser memory space to reflect the updatedcode.

After reloading, any recycled objects arecleared from the Recycle Bin and cannot berecovered.

This menu isnt available for open data cachefiles.

Save As Saves the active file with a different filename.

Save a Copy toDisk

For a cache document, opens the Save Filedialog where you can enter a new file name

and save the file to disk.

Save All Saves all open files in the project.


Description



18/196



Tools Menu

For more information on tools, see Tools in TIBCO General Interface Builder GettingStarted Guide.

Command Description

XML/XSL Merge Tool Displays the XML/XSL Merge utility, whichdisplays the results of applying an XSLTdocument. You can open multiple instances of this

tool.

Communications Displays a list of TIBCO General Interfacecommunications add-ins that have been installed,such as the XML Mapping Utility.

Color Picker Displays the Color Picker utility for choosing colorvalues.

JavaScript Test Utility Displays the JavaScript Test Utility for testingJavaScript code.

Find and Replace Displays a search dialog for searching andreplacing text in open text files.

IDE Settings Displays a dialog for setting preferences for thevisual authoring environment, such as IDEsettings, IDE hot keys, and paths.

Palettes Menu |7


19/196


|

Palettes Menu

The Palettes menu includes the following palettes. Each of these palettes has acontext menu. See Palette Context Menus on page 9.

For more information on palettes, see Object Modeling Palettes in TIBCO GeneralInterface Builder Getting Started Guide.

Command DescriptionKeyboardShortcut

Component Hierarchy Displays or hides the ComponentHierarchy palette.

Ctrl+1

Properties Editor Displays or hides the PropertiesEditor palette.

Ctrl+2

Events Editor Displays or hides the Events Editorpalette.

Ctrl+3

Attributes Editor Displays or hides the AttributesEditor palette.

Ctrl+4

XSL Parameters Displays or hides the XSLParameters palette.

Ctrl+5

Component Libraries Displays or hides the Component

Libraries palette.

Ctrl+6

Local Data Cache Displays or hides the Local DataCache palette.

Ctrl+7

Project Files Displays or hides the Project Filespalette.

Ctrl+8

Recycle Bin Displays or hides the Recycle Bin

palette. Objects that have beendeleted using the ComponentHierarchy palette can be recoveredfrom the Recycle Bin.

Ctrl+9

System Log Displays or hides the System Logpalette.

Ctrl+l(lowercase L)



20/196


|

Help Menu

The Help menu includes the following commands.

Command Description

APIDocumentation

Provides full documentation of the TIBCO GeneralInterface APIs organized by class. You can view the APIdocumentation in a dialog, a separate window, or theHTML version in a browser window.

Help Contents Opens the TIBCO General Interface Builderdocumentation in a web browser.

TIBCO DeveloperNetwork

Provides a link to TIBCO Developer Network athttp://developer.tibco.com for TIBCO General Interfacefeature updates, discussion forums, tips, samples,tutorials, and documentation to assist the applicationdevelopment process.

Internet Resources Provides links to JavaScript, XSLT, DHTML, and VMLreference resources on the Microsoft DevelopersNetwork web site, as well as to the Regular ExpressionsGuide at Mozilla.

About TIBCOGeneral Interface

Provides version information for TIBCO GeneralInterface and TIBCO General Interface Builder, as well asimportant legal notices.

LicenseAgreement

Displays the License Agreement for the product.

Context Menus |9


21/196


|

Context Menus

To access a context menu, right-click an area of the user interface or right-click anobject in a palette, such as a file name in the Project Files palette. For Mac, useCtrl+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

Component Hierarchy Palette Context Menu

Command Description

Remove Attribute Removes the selected attribute.


Description

Clone Creates an exact copy of the selected objectand any children. The new object is added asthe last child of the selected objects parent

object.

Repaint Repaints the Live Component view in thework area to reflect changes.

Re-FetchData andRepaint

Refreshes the data in the cache and repaintsthe Live Component view in the work area.Available for objects that implement

jsx3.xml.Cacheable.

Persistence Transitory Sets the selected component to transitory.When the component file is saved, thetransitory object is not saved to disk.



22/196


Embedded Embeds the selected component. When the

component file is saved, the embedded objectis saved to disk. By default, components fromthe Component Libraries palette areembedded.

Referenced Sets the selected component to a reference. Areferenced component is a link to acomponent file. For example, . The name of areferenced component in the ComponentHierarchy palette is displayed using blueitalic font.

Referenced -Asynchronous

Sets the selected component to anasynchronous reference. An asynchronous

referenced component is a link to acomponent file that loads asynchronously.For example, . The name of areferenced component in the ComponentHierarchy palette is displayed using greenitalic font.

Import Embedded Imports a copy of a component. When saved,the component is saved to disk.

Referenced Imports a link to a component file, not theactual contents of the component. Forexample, . The name of areferenced component in the ComponentHierarchy palette is displayed using blueitalic font.


Description

Context Menus |11


23/196


Component Libraries Palette Context Menu

Referenced -

Asynchronous

Imports a link to a component file

asynchronously, not the actual component.For example, . The name of areferenced component in the ComponentHierarchy palette is displayed using greenitalic font.

Export As XML Exports the selected DOM branch as an XMLfile, which can then be used in other projects.

As HTML Exports the selected DOM branch as anHTML file. This is useful for testing andprinting.

Recycle Self Moves the selected object to the Recycle Bin.

There is a separate Recycle Bin for each GUIcomponent.

RecycleDescendants

Moves all descendants of the selected objectto the Recycle Bin. There is a separate RecycleBin for each GUI component.

Copy Name

to Clipboard

Copies the objects name to the clipboard.

Copy GetterCode toClipboard

Copies the objects Getter code to theclipboard. For example,myAddressLookup.getJSXByName("block")

.


Description

Command Description

Copy Path Copies the path of the selected component to theclipboard. For example, the path for the Dialogcomponent would be

GI_Builder/prototypes/Containers/Dialog.xml .



24/196


Events Editor Palette Context Menu

To access the context menu in the Events Editor palette, right-click a cell in theValue column.

Local Data Cache Palette Context Menu

Project Files Palette Context Menu

Command Description

Reset/Clear Clears the value field of the selected row.

Command Description

View/Edit Opens the selected cache document in the work area.

View Markup Opens the selected document in the work area as aread-only, formatted file.

Copy Name Copies the name of the document to the clipboard.

Copy Source Copies the selected documents source to the clipboard.

Remove fromCache

Removes and deletes the selected document from thein-memory cache.

Command Description

Edit Opens the selected file in the work area for editing.

Edit Profile Displays the File Profile dialog where you can modify thefile ID, file type, file URI, and whether the file auto loads

or not. See File Profile Dialog on page 34.

Auto Load Sets the selected file(s) to auto load when the applicationruns.

Dereference Dereferences the selected file and removes it from theproject. The file is not deleted from disk.

Load/Reload Loads or reloads selected files from disk into browser

memory.

Context Menus |13


25/196


XSL Parameters Palette Context Menu

Copy Path Copies the file path to the clipboard. For example,js/logic.js.

Command Description

Command Description

RemoveParameter

Removes the selected parameter.



26/196


Work Area Context Menus

The work area context menus include menus for the work area tabs and the workarea editors.

Work Area Tabs Context Menu

The tabs at the top of the work area have a context menu.

Command Description

Close Closes the selected file.

Revert Revert to the previously saved version of the file.

Save Saves the file.

Save to Cache For a cache document, saves it to the cache.

Save and Reload Saves the active file to disk and reloads the fileappropriate to the file type. For example, JavaScript files

(.js) are reloaded into the browser memory space to reflectthe updated code.

After reloading, any recycled objects are cleared from theRecycle Bin and cannot be recovered.

This menu isnt available for open data cache files.

Save a Copy to

Disk

For a cache document, displays the Save File dialog

where you can save the file to disk.

Save As Displays the Save File dialog where you can save the filewith 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


27/196


Work Area Editors Context Menus

For text and XML files, there is a context menu in the work area.

Taskbar Context MenuTo access the taskbar context menu, right-click the project name link at the bottomleft of the TIBCO General Interface Builder user interface.

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 Description

Wrap Text Wraps the text in the work area so all of the text is visiblewithout horizontal scrolling.

Unwrap Text Displays the text without any wrap.

Command Description

Copy Namespaceto Clipboard

Copies the project namespace to the clipboard.

Copy Path toClipboard

Copies the project path to the clipboard. For example,workspace/JSXAPPS/myAddressLookup.

Project Settings Displays the Project Settings dialog where you canmodify project settings, such as deployment, add-ins,class path, and legacy settings. See Project Settings Dialogon page 41.

Run Project Runs the project in a new browser window.


Description

Add New Rule Adds a new rule to the selected rule.



28/196


Element Adds a new element rule to the selected

node.

Attribute Adds a new attribute rule to the selectednode. Attributes associate name-value pairswith elements.

CDATA Adds a new CDATA rule to the selectednode. Text in a CDATA section is ignored by

the XML parser. CDATA sections begin withthe string .

Reparse Reparse the deleted children of a selectedrule node. Displays the Reparse SelectedBranch dialog. Click Reparse to reparse theselected node. Note that reparsing removes

any existing descendants rules of the selectednode.

SampleMessage

Displays a sample input message for theselected request node and a sample outputmessage for the selected response node.

Execute (QuickTest)

Runs a test on the selected operation node inthe Rules Tree.


Description

|17


29/196


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


30/196


Work Area Toolbar

The work area provides several views of the open file. These views are availablefrom the work area toolbar to the lower right of the work area.

Button Description

Displays the active file in Live Component view. This view isavailable for GUI components and dynamic properties files.

Displays the active file in Source XML/Source Text view. This view isavailable for all file types.

Displays the active file in Formatted Source XML view. This view isread-only and is available for XML, XSL, dynamic properties, andGUI component files.

Displays the active file in Rendered HTML view. This view isread-only and is available only for GUI components.

Displays the active file in Component Profile view. This view isavailable only for GUI components. For more information, see WorkArea Views in TIBCO General Interface Builder Getting Started Guide.

Attributes Editor Palette Toolbar |19
http://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdf


31/196


Attributes Editor Palette Toolbar

The Attributes Editor palette toolbar has the following buttons:

Button Description

Controls docking options for the palette, which include thefollowing:

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 asan HTML attribute and value. Type values in the Name and Valuefields and click the Add button to add the attribute. The addition isvisible in the component definition (Source XML view) and in theRendered HTML view in the work area.

For example, .

Press the Enter key to navigate the Attributes Editor palette fields.



32/196


Component Hierarchy Palette Toolbar

The Component Hierarchy palette toolbar has the following buttons:

Button Description




Creates an exact copy of the selected object and any children. Thenew object is added as the last child of the parent of the selectedobject.

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 Componentview in the work area. Available for objects that implementjsx3.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 GUIobjects can be selected in the work area using Ctrl+click. This button

is off by default, because it can interfere with interactions and eventsof the selected objects children.

Toggle snap-to-grid behavior for objects in the work area.

Synchronizes the Component Hierarchy palette with the currentversion of the hierarchy on disk.

Component Libraries Palette Toolbar |21


33/196


Component Libraries Palette Toolbar

The Component Libraries palette toolbar has the following buttons:

Button Description



Floating Floats the palette, which can be moved andminimized.

Close Closes the palette.

Synchronizes the Component Libraries palette with the currentversion of the libraries on disk.



34/196


Local Data Cache Palette Toolbar

The Local Data Cache palette toolbar has the following buttons:

Button Description




Opens the selected file in a tab in the work area, where it can beedited.

Opens the selected file in the Formatted Source XML view.

Removes the selected file from cache.

Project Files Palette Toolbar |23

P j t Fil P l tt T lb


35/196


Project Files Palette Toolbar

The Project Files palette toolbar has the following buttons:

Button Description



Floating Floats the palette, which can be moved and minimized.


Creates a new tab in the work area for the selected file type.

Displays the Open File dialog for adding an existing file to theproject. 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, AutoLoad, and URI values for the selected file. See File Profile Dialog onpage 34.

Removes the selected file from the project. The file is not deletedfrom disk.

Loads or reloads selected file(s) in the work area.

Rescans project files from disk.


Rec cle Bin Palette Toolbar


36/196


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


37/196


System Log Palette Toolbar

The System Log palette toolbar has the following buttons:

Button Description


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.


Clears the contents of the System Log palette.

Controls the message log level. Choose from OFF, FATAL, ERROR, WARN,INFO, DEBUG, or TRACE.


XSL Parameters Palette Toolbar


38/196


XSL Parameters Palette Toolbar

The XSL Parameters palette toolbar has the following buttons:

Button Description




Adds the specified name-value pair to the component definition asan xslparameters element. Type values in the Name field or usethe 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 theparameter. The addition is visible in the component definition

(Source XML view) and the Rendered HTML view in the work area.

For example, .

Press the Enter key to navigate the XSL Parameters palette fields.

JavaScript Test Utility Toolbar |27

JavaScript Test Utility Toolbar


39/196


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 InternetExplorer.

To debug in Firefox, use the Venkman extension. Visithttp://getahead.ltd.uk/dwr/ajax/venkman/.

Displays a history of the ten most recently executed code snippets tochoose from and restore.


JavaScript Step Through Debugger Toolbar


40/196


JavaScript Step Through Debugger Toolbar

The JavaScript Step Through Debugger toolbar has the following buttons:

The JavaScript Step Through Debugger is only supported in Internet Explorer. Todebug in Firefox, use the Venkman extension. Visithttp://getahead.ltd.uk/dwr/ajax/venkman/.

Button DescriptionExecutes only the highlighted line of JavaScript code.

Skips the highlighted line of JavaScript code and advances theselection 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


41/196


pp g y

The XML Mapping Utility has the following buttons on the top toolbar. Otherareas of the XML Mapping Utility also have toolbars.

Rules Tree Toolbar

The Rules Tree toolbar has the following buttons:

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.

Button Name Command Description

Test Launches the Test Interface Toolwhere you can step through andexecute operations in the Rules Tree.

Map Automatically maps nodes to GUIcomponents and CDF elements.

CDF Attribute Creates a CDF attribute mappingusing the rule name as the attributename.

CDF Record Creates a CDF record mapping andattribute mappings for descendant

elements and attributes.


Button Name Command Description


42/196


Mapper Log Toolbar

The Mapper Log toolbar has the following buttons:

DOM (Mapand Create)

Creates a new Form element andadds it to the active selection within

the the DOM palette. Also creates themapping.

Detach Removes selected mappings.

Mappings Removes all mapping rules for the

selected node.Restrictions Removes all restrictions for the

selected node.

Headers Removes all HTTP headers for theselected node.

Delete Deletes a rule or all unselected rules.

Selected Rules Deletes the selected rules from thetree.

UnselectedSibling Rules

Deletes all siblings of the selecteditems from the tree.

Generate Generates JavaScript code for theselected operation and places it onthe clipboard for pasting into aJavaScript file. The rules file must besaved first.

p

Button Description

Clears the mapper log.

XML Mapping Utility Toolbar |31

Button Description


43/196


Test Interface Tool Toolbar

The Test Interface toolbar has the following buttons:

Controls the message log level. Choose from OFF, FATAL, ERROR,WARN, INFO, DEBUG, or TRACE.

Button Description

Resets the tester.

Starts or resumes the test.

Pauses the test.

(Receive tab) Generates alternate inbound message.


Taskbar Toolbar


44/196


The taskbar is located at the at the bottom left of the TIBCO General InterfaceBuilder user interface.

The taskbar toolbar has the following buttons:

Button Description

Opens the project directory in a new

browser window. Right-click thishyperlink to access the taskbar contextmenu. See Taskbar Context Menu onpage 15.

Shows the work area and the palettes.

Shows the work area only and hides allpalettes.

|33

Chapter 3 Dialogs and Tools Field Descriptions


45/196


This chapter describes the fields of TIBCO General Interface dialogs and tools.

For an overview of TIBCO General Interface Builder tools, see Tools in TIBCOGeneral 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 Dialogs and Tools Field Descriptions

File Profile Dialog


46/196


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 buttonon the Project Files palette toolbar.

Command Description

ID ID of the file generated by TIBCO GeneralInterface. This ID can be modified but mustbe unique.

Type Type of file, such as GUI Component,JavaScript, CSS, XML, XSLT, or DynamicProperties

Auto Load Sets how files are loaded. Available optionsvary by file type.

File Profile Dialog |35

Command Description


47/196


Auto Load JavaScript Files For more information on how JavaScriptfiles are loaded, see Class Loading in TIBCO

General Interface Builder Getting Started Guide.Manually/As Needed The JavaScript file isdynamically loaded when its needed.

For the file to be loaded automatically, itmust be registered in a class path on theClasspath page of the Project Settings dialog(Project > Project Settings) or loaded using a

jsx3.require() method call. Otherwise, itcan only be loaded programmatically withthe Server.loadResource() method. If aJavaScript class file is registered on a classpath, it doesnt need to be registered as aproject resource to be dynamically loaded.

At Full Init If the jsxlt parameter is set tofalse

or is missing, the JavaScript file isloaded when the application loads.

At Light Init If the jsxlt parameter is set totrue, the JavaScript file is loaded when theapplication loads.

At Init The JavaScript file is automaticallyloaded when the application initializes.

When this option is selected, the file name inthe Project Files palette is displayed in bold.


d l h f l l d d

Command Description


48/196


ButtonsThe following buttons are on the bottom right of the File Profile dialog:

Auto Load CSS Files

DynamicProperties Files

Mapping RulesFiles

XML and XSLFiles

Manually The file is loadedprogrammatically with the

loadResource() or loadInclude()method.

Note: Its not recommended to load CSSfiles programmatically, because they can bevery slow to load.

XML and XSL files are typically set toManually. They can also be loaded into

cache using the XML URL property in theProperties Editor palette.

Rules files are typically set to Manually.

At Init The file is automatically loaded whenthe application initializes.

GUI Component

Files

The Auto Load option is disabled for GUI

component files. You can specify a GUIcomponent file to automatically load whenthe application initializes in the InitialComponent field on the Deployment pageof the Project Settings dialog.

URI The path of the file relative to the projectfolder.

Button Description

Apply Applies the changes but doesnt close the dialog.Save Saves the changes and closes the dialog.

Cancel Cancels any changes and reverts back to the last saved version.

IDE Settings Dialog |37

IDE Settings Dialog


49/196


In the IDE Settings dialog, you can modify TIBCO General Interface Builder

integrated development environment (IDE) preferences for the visual authoringenvironment. The options in this dialog allow you to customize the IDE, modifyand add keyboard shortcuts for menus, and set paths. Settings in this dialog aresaved to workspace/settings/builder.xml.

For more in-depth discussion of some of these options, see Setting Preferences inTIBCO General Interface Builder Getting Started Guide.

IDE Settings Page

The IDE Settings page displays options for the TIBCO General Interface IDE.

Field Description

Output character

encoding

Specifies the character encoding to use when saving

files, such as UTF-16. If this field is empty, the defaultis used, which is system-dependent.

Click the Test button to verify that the specifiedencoding can be written and that its available on thesystem.

For Internet Explorer, encoding behavior variesaccording to Microsoft Windows updates and security

settings, which might need to be modified. UTF-16and the default system encoding should be supportedregardless. If the test fails for other encodings, youmight need to enable the ADODB.Stream object. See"How to disable the ADODB.Stream object from InternetExplorer" athttp://support.microsoft.com/default.aspx?kbid=870669 and reverse the instructions to enable it.

Output line separator Specifies the line separator by operating system, suchas UNIX, Mac OS, or Microsoft Windows.


Instead encode XML Specifies the character encoding to use when saving

Field Description


50/196


Instead encode XMLfiles as

Specifies the character encoding to use when savingXML files. This setting overrides the XML declaration,

if any. Check the Add character encoding to XMLdeclarations option to modify the encoding in theXML declaration.

Click the Test button to verify that the specifiedencoding can be written and that its available on thesystem.

If this option isnt set, the setting in the previous

Output character encoding field is used.For Internet Explorer, encoding behavior variesaccording to Microsoft Windows updates and securitysettings, which might need to be modified. UTF-16and the default system encoding should be supportedregardless. If the test fails, you might need to enablethe ADODB.Stream object. See "How to disable theADODB.Stream object from Internet Explorer" athttp://support.microsoft.com/default.aspx?kbid=870669 and reverse the instructions to enable it.

Add characterencoding to XMLdeclarations

Adds the encoding, specified in the Instead encodeXML files as field, to the XML declaration. Forexample, if UTF-8 is specified, the XML declarationwould look like this:

Give DOM focus tonewly added GUIobjects

Specifies whether to assign focus to a new object in theComponent Hierarchy palette and the work area afterits created.

Warn beforedereferencing aproject resource file

Specifies whether to display a warning dialog before afile is dereferenced in the Project Files palette.

Warn beforeremoving documentsfrom the local XMLcache

Specifies whether to display a warning dialog before adocument is dereferenced in the Local Data Cachepalette.

IDE Settings Dialog |39

Warn before deleting Specifies whether to display a warning dialog before a

Field Description


51/196


IDE Hot Keys Page

The IDE Hot Keys page displays a list of General Interface Builder menus thatyou can assign keyboard shortcuts to. To assign a keyboard shortcut, double-clicka row, press the key combination on the keyboard, and click Save. Restart GeneralInterface Builder for the changes to take effect.

Paths Page

The Paths page allows you to set paths for the workspace and HTTP base.

Warn before deletingobjects from the

ComponentHierarchy

Specifies whether to display a warning dialog before acomponent is recycled in the Component Hierarchy

palette.

Open last projectwhen launchingGeneral InterfaceBuilder

Specifies to open the last project when GeneralInterface Builder is launched.

Snap-to spacing Specifies the grid pixel size. Used when repositioningobjects in the work area. To enable or disable thesnap-to-grid feature, use the Toggle Snap-to Gridbutton in the Component Hierarchy palette.

Field Description

Menu The name of the menu command

Key The shortcut key that activates the menu command.

Field Description

Workspace A user home directory that contains your projects, customadd-ins and prototypes, and your user settings for GeneralInterface Builder. Browse to an existing directory, create a newone, or accept the default workspace.


HTTP Base The base URI for the General Interface directory on a local

Field Description


52/196


Buttons

The following buttons are on the bottom right of the IDE Settings dialog.

HTTP Base The base URI for the General Interface directory on a localHTTP server that hosts the TIBCO General Interface installation.

The HTTP server must serve your workspace directory and yourGeneral Interface directory. In addition, the relative pathbetween the two directories must be the same on the HTTPserver as on disk.

Button Description

Apply Applies the changes but doesnt close the dialog.

Save Saves the changes and closes the dialog.


Project Settings Dialog |41

Project Settings Dialog


53/196


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 inTIBCO General Interface Builder Getting Started Guide.

Deployment PageThe Deployment page has settings for application deployment. For moreinformation, see Deploying Applications in TIBCO General Interface Builder GettingStarted Guide.

Field Description

Caption The text to display in the browser title bar while the

application is running.

Namespace Each General Interface application has a singlejsx3.app.Server instance. The application namespace isa unique identifier for this single jsx3.app.Serverinstance. All objects in a General Interface application aregoverned by this server instance and uniquely locatedusing the application namespace.

The dot symbol (".") is supported in the namespace. Forexample, eg.chart.APP.

InitialComponent

The path to the component to automatically load when theapplication initializes at runtime. The path is relative to theproject directory. For example,components/appCanvas.xml.

Cancel Error Specifies whether to trap errors and display them in theSystem Log palette.

If checked, JavaScript errors are routed to the System Logpalette in General Interface Builder.

If unchecked, JavaScript errors are routed to the browser.


Cancel Specifies whether to trap the right-click event.

Field Description
http://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdf


54/196


Right-Clickp p g

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 usedby the jsx3.net.Service class.

Live Mode An online mode where the application isconnected over HTTP/S to a back-end server, allowing

access to online data. When requests for data are made bythe application, the request goes out over HTTP/S anddata is returned and rendered.

Static Mode An offline mode where the application is notconnected to a server. Data is static and is referenced usingstatic URLs stored in rules files. When a request for data ismade by the application, the request is routed to a local

static XML document. That static data is returned as if itcame from a server and is rendered in the application.

Select this mode when developing an application offline ordisconnected from the server. This is useful whenapplications and back ends, such as web services, are indevelopment simultaneously or a back end is currentlyunavailable.

Body Hot Keys Specifies whether to route key events that bubble up to thewindow from an application keyboard shortcut.

If checked, the keyboard shortcut event bubbles up to theHTML body element and is then sent to the application.Check this option for deployment of standalone consoleapplications.

If unchecked, keyboard shortcuts only function if the focus

is in the General Interface application. This option shouldbe unchecked for deployment of non-console applicationsthat are a portion of a web page.

Project Settings Dialog |43

Overflow Determines how the application container behaves when

Field Description


55/196


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 moreinformation on the Charting add-in, see Working with Charts in TIBCO GeneralInterface Builder Getting Started Guide.

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 thetwo letter ISO 639 language code and the optional, two

letter ISO 3166 country code. The format is ll orll_CC.For example, fr for French or fr_fr for French inFrance.

If this field is empty, the locale is determined by thebrowser.

onLoad Script JavaScript code to execute when the application initializes.

Field Description

Charting If selected, TIBCO General Interface Builder chartingcomponents display in the Component Libraries palette.


Classpath Page

The project class path is used by the JSX runtime to find custom classes that ared i ll l d d b li ti Thi l t l d ti f


56/196


dynamically loaded by your application. This accelerates load time for your

application. See Class Loading in TIBCO General Interface Builder Getting StartedGuide. For naming conventions for dynamically loaded classes, see Class NamingConventions in TIBCO General Interface Builder Getting Started Guide.

Legacy Page

The Legacy page has the following options:

Buttons

The following buttons are on the bottom right of the Project Settings dialog:

Field Description

Path The path to the custom classes. The class path is relative tothe project directory. For example, entering js/ as the path

would load the specified classes in theworkspace/JSXAPPS/project_dir/js directory.

Package The name of the package. Wildcards (*) are allowed.

Field Description

Project Version A version number for the project. When a resource in theproject is accessed, the string?jsxversion= is appended to the name ofthe resource. This is useful for reloading cached files each

time the project is modified.

Event Protocol Specifies the event protocol for the project. The optionsinclude 3.1 (default) and 3.0 (deprecated).

Button Description

Apply Applies the changes but doesnt close the dialog.

Save Saves the changes and closes the dialog.


Color Picker Tool |45

Color Picker Tool
http://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdfhttp://../gs/tib_gi_pe_gs_guide.pdf


57/196


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, scrollthrough hex values in the Hex field, and move between radio buttons.

Field Description

Color palette Click in the color palette to select a color.

Color slider Use the slider to change color spectrum in the Colorpalette.

Preview color box The box at the lower right displays the currentlyselected color. Click in this box to copy thehexadecimal (hex) color value to the clipboard.

H (Hue) Specifies the color hue or gradation.

S (Saturation) Specifies the color saturation, which is the intensity orpurity of a specific hue.

B (Brightness) Specifies the color brightness or strength.

R (Red) Specifies the red portion of the RGB value. Afterspecifying a value, press the Enter key to view theupdated hex equivalent.

G (Green) Specifies the green portion of the RGB value. Afterspecifying a value, press the Enter key to view theupdated hex equivalent.

B (Blue) Specifies the blue portion of the RGB value. After

specifying a value, press the Enter key to view theupdated hex equivalent.

Hex The hex value for the selected color.


Deployment Utility


58/196


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 Applicationsin 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.

Launch Link Page

Select this tab to generate a hyperlink that launches the application in a newbrowser window.

Copy and paste the link into your HTML page and modify as desired. Thishyperlink requires the file install_dir\shell.html to be deployed also.

Command Description

XHTML If checked, XHTML markup is generated for thethe launch page. XHTML launch pages are usedfor applications that run in XHTML pages, such asportlet applications.

Create Creates the HTML or XHTML page for launchingthe deployed application.

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 optionwhen running multiple applications in the same browser window.


59/196


g p pp

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 youcan then paste into your HTML page.


Find and Replace Tool

To open Find and Replace choose Tools > Find and Replace


60/196


To open Find and Replace, choose Tools > Find and Replace.

Field Description

Find Enter the text string to search for in the active opentext file in the project.

Case Sensitive If checked, finds only exact case matches to the stringentered in the Find field.

Regular Expression If checked, JavaScript regexp syntax is supported inthe Find field. For more information, see Help >Internet Resources > Regular Expressions Guide(Mozilla).

Replace Enter a replacement text string for the found text inthe active open text file in the project.

Replace Replaces the found text string with the replacementstring.

Replace All Replaces all occurrences of the text string with thereplacement string.

Find Finds the next occurrence of the text string.

Cancel Closes the dialog.

JavaScript Test Utility |49

JavaScript Test Utility

Use the JavaScript Test Utility to test your JavaScript code


61/196


Use the JavaScript Test Utility to test your JavaScript code.

To open the JavaScript Test Utility, choose Tools > JavaScript Test Utility.

Field Description

Upper text area Enter or paste the JavaScript code to be tested. Toaccess a list of methods, press Ctrl+spacebar.

Return Value (ifapplicable)

Return values, if any, display in this area.


XML Mapping Utility

The XML Mapping Utility provides a visual environment for configuring and


62/196


The XML Mapping Utility provides a visual environment for configuring and

testing data services. For more information, see Data Connection and Mapping inTIBCO General Interface Builder Getting Started Guide.

To open the XML Mapping Utility, choose Tools > Communication > XMLMapping 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 pagedisplayed allows

tib gi pe ui reference

Documents