Macromedia ColdFusion Builder - 2.0 Instruction Manual

Using

ADOBE® COLDFUSION® BUILDER™ 2.0

Legal notices

For legal notices, see http://help.adobe.com/en_US/legalnotices/index.html.

Last updated 5/9/2011

Chapter 1: What’s New in ColdFusion Builder 2.0

ColdFusion Builder 2.0 Express Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Getting started experience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Editor enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Code Assist enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Code folding enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Code Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Quick Fix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

ColdFusion Builder Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Keyboard shortcut enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Navigation enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Extension enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Other enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

iii

Chapter 2: Introduction

ColdFusion and ColdFusion Builder documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

ColdFusion and ColdFusion Builder learning resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 3: About ColdFusion Builder

ColdFusion Builder configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Activating ColdFusion Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Installing third-party Eclipse plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Getting started experience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

ColdFusion Builder Help System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Getting started with ColdFusion Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 4: ColdFusion Builder Workbench Basics

About the workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Workbench menus and toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

About ColdFusion Builder perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

ColdFusion Builder Development perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

ColdFusion Debugging perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Add views to the workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

ColdFusion Builder editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Customizing a perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Chapter 5: Code Editing in ColdFusion Builder

CFML Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Code Assist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Select tag blocks of your choice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Jump to matching tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Quick Fix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Code Formatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Last updated 5/9/2011

USING COLDFUSION BUILDER

Contents

Auto-formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Code colorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

SQL Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Code folding and unfolding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Syntax checking and highlighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Navigate through code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Code refactoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Typing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

CFML Editor keyboard shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

ColdFusion Builder Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Add tasks to Task View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 6: Managing Servers

Understanding web server terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Adding ColdFusion servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Using Servers View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Import RDS server settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Chapter 7: Managing Projects

About projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Creating a ColdFusion project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Configure properties for projects and servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Add ColdFusion pages, interfaces, and components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Create CFM/CFC files outside the workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Set Launch Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Set URL Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Import, export, and delete projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Cloak projects and files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Link to resources outside the workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Deploy projects over FTP and Secure FTP connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Import Ajax libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Working with Flash Builder projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Developing AIR applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 8: Debugging Applications

Using ColdFusion debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Debugging your application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Debugging remote applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Chapter 9: ColdFusion Builder Extensions

About extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

What's new with extensions in ColdFusion Builder 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Developing extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Creating user interfaces for extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Create views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Specifying callback commands from handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Using the Extensions view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Last updated 5/9/2011

USING COLDFUSION BUILDER

Contents

Use ColdFusion Builder Extension Creator to create and package extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Contribute to Code Assist from extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Extension support for setting Launch Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Chapter 10: Using Extensions

Adobe CFC Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

AS Class Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Last updated 5/9/2011

Chapter 1: What’s New in ColdFusion Builder 2.0

ColdFusion Builder 2.0 Express Edition

Use a feature-limited Express Edition of ColdFusion Builder after the trial expires. Till you purchase a license, you can continue to use the basic features such as editor, code assist, and syntax highlighting. See

Builder” on page 8.

Getting started experience

A dynamic getting started experience that invites access to tutorials, workflows, movies, notifications, tips and tricks, and useful resources any time you start ColdFusion Builder. See

“Getting started experience” on page 10.

“Activating ColdFusion

Editor enhancements

Add tasks to Task View

If you define tasks as CFML comments, the Task View displays them based on the priority you set. The tasks are listed with the default

Select tag blocks of your choice

The enclosing tag block from the caret position can be selected using the shortcut Ctrl+Alt+B (Windows) or Command+Option+B (Mac). Retain the selection and then repeat the shortcut for cumulative selection of code. “Select tag blocks of your choice” on page 44.

Jump to matching tag

Move the caret position from beginning to end or end to beginning of a tag block using the shortcut Ctrl+Alt+M (Windows) or Command+Option+M (Mac). See

TODO and FIXME tags or the custom task tag prefix. See “Add tasks to Task View” on page 60.

“Jump to matching tag” on page 45.

Code Assist enhancements

Auto-insert required attributes

Auto-insert required attributes based on preference (the default option). If preference is not set, instead of insertion, attributes are only proposed. See

“Auto-insertion of required attributes” on page 43.

Shows separate list of required and optional tag attributes

Prompts you with a list of attributes showing required attributes at the top of the proposal list with check marks to indicate that the attributes are mandatory. A line separates the mandatory and optional attributes. See

required and optional attributes” on page 43.

Last updated 5/9/2011

“Separate list of

USING COLDFUSION BUILDER

What’s New in ColdFusion Builder 2.0

Lists proposals for createObject

Proposes all objects (and the corresponding arguments) supported by the function createObject. See “Proposals for

createObject” on page 43.

Cyclic Code Assist proposals

Use Ctrl+<Space> to cycle through your Code Assist proposal. You can switch from one proposal group at a time to the next, for example from variables to function. See

Filter proposals containing text

Filter proposals based on the text you specify. All proposals that contain the filter text are listed with selection set to the proposal that starts with the specified text. See

Datatype-aware Code Assist

Shows Code Assist proposals based on expected data types. See “Datatype-aware Code Assist” on page 44.

Auto-insertion of function arguments

When you insert a function, all required arguments are automatically inserted. See “Auto-insertion of function

arguments” on page 44.

“Cyclic Code Assist proposals” on page 43.

“Filter proposals containing text” on page 44.

Function context assist enhancements

• Displays function context assist whenever you load Code Assist inside function parameters

• Highlights the parameter that you currently edit in bold

• Displays the optional parameters inside [].

See “Function context assist” on page 44.

Smart Code Assist for connection attributes

Displays connection variables created for tags such as cfexchangeconnection and cfftp. See “Smart Code Assist for

connection attributes” on page 44.

Usage-based Code Assist for cfloop

Based on the type of loop, the required attribute is auto-inserted. See “Usage-based Code Assist for cfloop” on page 44.

Code folding enhancements

Hide and display code blocks of your preference (Ctrl+Alt+F (Windows) or Command+Option+F (Mac)). The code folding that you define is saved and is available for future sessions. See

“Code folding and unfolding” on page 50.

Code Formatting

Code formatter

Change the look of your CFML code by standardizing indentation, line length, and the case of tags and attribute names (Ctrl+Shift+F (Windows) or Command+Shift+F (Mac)). Code formatter formats both tag and script-based syntax. Code Formatter provides an off-the-shelf set of preferences. You can customize, import, and export the preferences.

“Code Formatter” on page 46.

See

Last updated 5/9/2011

USING COLDFUSION BUILDER

What’s New in ColdFusion Builder 2.0

Auto-formatting

Automatically indents lines of code and adjusts the ending tag. See “Auto-formatting” on page 48

Quick Fix

When you open/edit a file, ColdFusion Builder automatically identifies the function calls, CFCs, and CFMs that are not defined. A bulb icon appears in the left margin of the editor which, if clicked, prompts you to perform the appropriate quick fix. See

“Quick Fix” on page 45.

ColdFusion Builder Search

Specialized find and replace functionality (Ctrl+F (Win) or Command+F (Mac)) that searches text or tag in the current and open documents, selected resource, project, working set, workspace, local directory, FTP location, and RDS location. Regular expressions and multi-line search are also supported. To save time, you can run remote search in the background and continue with other tasks. ColdFusion Builder search applies to the following file types: CFC, CFM, HTML, XML, CSS, and JS. See

“ColdFusion Builder Search” on page 58.

Keyboard shortcut enhancements

• Use a Quick Assist that displays a catalog of shortcuts related to wizards, tags, and custom shortcuts

• Create custom keyboard shortcuts

• Modify and remove shortcuts

• Search shortcuts for specific action based on filter text

• Export shortcuts in CSV format and import

• Restore defaults shortcut settings

See “CFML Editor keyboard shortcuts” on page 57.

Default keyboard shortcut changes

Action Default shortcut in ColdFusion Builder Default shortcut in ColdFusion Builder 2.0

Insert cfabort Ctrl+Shift+A Ctrl+T,A

Insert cfdump Ctrl+Shift+D Ctrl+T,D

Insert CFScript block Ctrl+Alt+R Ctrl+T,S

Insert cfset Ctrl+= Ctrl+T,=

Access tag editor Ctrl +T Ctrl+Shift+T

Wrap/Unwrap ColdFusion comment

Ctrl+Shift+M Ctrl+T,M

Last updated 5/9/2011

USING COLDFUSION BUILDER

What’s New in ColdFusion Builder 2.0

Action Default shortcut in ColdFusion Builder Default shortcut in ColdFusion Builder 2.0

Wrap in ## Ctrl+Shift+H Ctrl+T,H

Wrap in cfoutput Ctrl+Shift+O Ctrl+T,O

Wrap in try/catch Ctrl+Shift+T Ctrl_T,T

Navigation enhancements

Code navigation

Navigate from a user-defined function to the next or previous one or (in CFC files) to the top-level members of the CFC (Ctrl + Shift + Up arrow/Down arrow key (Windows) or Command + Shift + Up/Down arrow key (Mac)). For flow-control statements provided in CFScript, in both CFC page and CFM page, navigate to the next or previous code blocks if the caret position is within any of these statements. See

Smart tab navigation

Quickly navigate to the next (use Ctrl + ] on Windows/ Command + ] on Mac) and previous (use Ctrl + [ on Windows/Command + [ on Mac) function argument or tag attribute. Smart tab navigation is applicable to cffunction arguments also in the case of function definition. See

“Smart tab navigation” on page 54.

“Code navigation” on page 53.

Extension enhancements

Specifying callback commands from handlers

You can complete the following operations in the execution phase: refresh file, folder, or project; open file or insert text; get a list of servers or data sources; get details of tables; search and return content of a file; and list the functions and variables in a file. See

Create views

Create views and specify and toolbar items for the view you create using extensions. This helps you use the IDE features concurrently while seeing the data. See

Contribute to Code Assist from extensions

Add proposals to Code Assist from extensions. See “Contribute to Code Assist from extensions” on page 111.

Extension support for setting Launch Page

Dynamically generate Start Page URL for framework applications using extensions. ColdFusion Builder features such as ColdFusion Debugger, Use External Browser, and Run as ColdFusion Application use this URL as the Start Page URL. The generated URL can also have query param added to it. See page 112.

Version and server details

ideeventinfo.xml sent to Handler CFM files from ColdFusion Builder will have ColdFusion Builder version information and server details such as hostname and port number. See

handler communication” on page 97.

“Specifying callback commands from handlers” on page 104.

“Create views” on page 102.

“Extension support for setting Launch Page” on

“Understanding ColdFusion Builder and

Last updated 5/9/2011

USING COLDFUSION BUILDER

What’s New in ColdFusion Builder 2.0

Other enhancements

Create CFM/CFC files outside the workspace

Create CFM/CFC files outside the workspace using the File view. See “Create CFM/CFC files outside the workspace” on page 74.

Set Launch Page

Designate a specific file as the Launch Page for your project. This page is loaded when you run/debug a file. See “Set

Launch Page” on page 74.

Help improvements

• Context-sensitive Help is displayed on mouse hover. This applies to functions, tags, and UDFs. For UDFs, the value

of the hint attribute is displayed in the Help window.

• Context-sensitive Help is available when you run Code Assist and then highlight a parameter or attribute.

Additional resources

• What's new in ColdFusion Builder 2

In this article, Ramchandra Kulkarni provides an overview of the ColdFusion Builder 2 features, to help you take full advantage of all the productivity tools provided in ColdFusion Builder 2.

• Getting started with ColdFusion Builder 2

In this Adobe TV video tutorial, Adobe Platform Evangelist Terry Ryan shows you how to use the newest features in ColdFusion Builder 2.

• ColdFusion Builder team blog

Provides latest news, updates, and other helpful information from the ColdFusion Builder team.

Last updated 5/9/2011

Chapter 2: Introduction

Adobe® ColdFusion® Builder™ is an integrated development environment (IDE) for developing Adobe® ColdFusion®applications.

There are various resources to help you get started and become proficient in using ColdFusion Builder. Depending on your background and what you want to accomplish with ColdFusion Builder, take a few minutes to read through the appropriate documentation resources.

New to ColdFusion

❖ It is most useful if you have basic ColdFusion experience before you start using ColdFusion Builder. You can start

by viewing the Getting Started experience, which is available from the ColdFusion Administrator.

Experienced ColdFusion developers

• ColdFusion Builder is built on Eclipse™(an open source IDE), so you must know specific terms and concepts to

effectively use it. If you are, however, familiar with working in an Eclipse-based environment, you will find that ColdFusion Builder uses similar workbench conventions.

For more information, see “ColdFusion Builder Workbench Basics” on page 15.

• If you have developed code using a text editor in the past, you will find that ColdFusion Builder provides enhanced

functionality that makes developing code much easier. For more information, see page 8.

• For a quick overview of the features that are available with ColdFusion Builder, see “Getting started with

ColdFusion Builder” on page 13.

• To successfully develop ColdFusion applications using ColdFusion Builder, use CFML Reference and ColdFusion

Developer Guide. The CFML Reference contains detailed information on the CFML language elements and is available from the ColdFusion Builder Help system. For more information, see page 12.

• For information about the complete documentation available for ColdFusion and ColdFusion Builder, see

“ColdFusion and ColdFusion Builder documentation” on page 6.

“About ColdFusion Builder” on

“Display CFML Reference Help” on

ColdFusion and ColdFusion Builder documentation

All ColdFusion and ColdFusion Builder documentation is accessible from within ColdFusion Builder through the integrated Help system. For more information, see

Go to the ColdFusion Help and Support pages at www.adobe.com/go/learn_cfu_support_en to view the online documentation.

In addition to viewing the documentation, you can also add and view comments to the documentation.

“ColdFusion Builder Help System” on page 10.

Adobe ColdFusion documentation

The ColdFusion documentation set includes the following titles:

Last updated 5/9/2011

USING COLDFUSION BUILDER

Introduction

Manual Description

Installing Adobe® ColdFusion® 9

Adobe ColdFusion® 9 Administrator's Guide Describes how to perform ColdFusion administration tasks such as managing server

Developing Adobe® ColdFusion® 9 Applications

Adobe® ColdFusion® 9 CFML Reference

Describes system installation and basic configuration for Windows, Macintosh, Solaris, Linux, and AIX.

settings, configuring data sources and web servers, managing security, and deploying ColdFusion applications.

This book also provides information about caching, setting up CFX tags, and monitoring server activity using the ColdFusion Server Monitor.

Describes how to develop your dynamic web applications.

This book provides detailed information about using the CFML programming language and ColdFusion features, such as ColdFusion Web Services, ColdFusion Portlets, ColdFusion ORM, Ajax support, Flex and AIR integration, and integration with other products and technologies such as Microsoft Office, OpenOffice, and SharePoint.

Provides descriptions, syntax, usage, and code examples for all ColdFusion tags, functions, and variables.

Adobe ColdFusion Builder documentation

The ColdFusion Builder documentation set includes the following titles:

Manual Description

Installing Adobe® ColdFusion® Builder 2.0

Describes ColdFusion Builder installation, as a standalone installation or as a set of plug-ins within an existing Eclipse workbench, for Windows and Macintosh platforms.

Using ColdFusion® Builder 2.0

Describes how to use ColdFusion Builder as an integrated development environment (IDE) for developing applications using ColdFusion.

ColdFusion and ColdFusion Builder learning resources

The following additional online resources are available for learning ColdFusion and ColdFusion Builder:

Resource Link

ColdFusion Help and Support www.adobe.com/go/learn_cfu_support_en

ColdFusion Developer Center www.adobe.com/go/learn_cfu_cfdevcenter_en

Adobe ColdFusion online forums www.adobe.com/go/learn_cfu_forums_en

Last updated 5/9/2011

Chapter 3: About ColdFusion Builder

Adobe® ColdFusion® Builder™ is built on top of Eclipse™, an open-source IDE (Integrated Development Environment). An IDE contains most of the tools that developers need within a single application. ColdFusion Builder provides tools for editing and validating code, managing files and projects, and debugging. The plug-in architecture of ColdFusion Builder lets you extend the functionality for your own needs.

ColdFusion Builder runs on Microsoft® Windows® and Apple® Macintosh platforms. The installation configuration options let you install ColdFusion Builder as a standalone installation or as a set of plug-ins within an existing Eclipse workbench installation. For more information, see Installing Adobe ColdFusion Builder.

ColdFusion Builder configurations

The ColdFusion Builder installer provides the following two configuration options:

Standalone ColdFusion Builder IDE Installation Installs ColdFusion Builder as a standalone IDE (Integrated

Development Environment) built on Eclipse™ 3.6.2

ColdFusion Builder plug-ins within Eclipse IDE Installs ColdFusion Builder as a plug-in within an existing Eclipse or

Adobe® Flash® Builder™ installation. This configuration is for users who already use the Eclipse workbench and want to add ColdFusion Builder plug-ins to their toolkit of Eclipse plug-ins.

Note: You must have Eclipse 3.6.2 or higher installed on your computer to install the plug-in configuration of ColdFusion Builder.

If you are not sure which configuration to use, follow these guidelines:

• If you already use and have Eclipse 3.6.2 or higher installed, select the plug-in configuration.

• If you do not have Eclipse 3.6.2 or higher installed, select the standalone configuration. This configuration also

allows you to install other Eclipse plug-ins, so you can expand the scope of your development work in the future.

The two configurations provide the same functionality. However, some menu names and the ways to access the menu commands sometimes differ slightly in the plug-in configuration.

Activating ColdFusion Builder

When you start ColdFusion Builder, you are prompted to enter the product serial number. When you enter a valid product serial number, activation happens in the background the first time the software detects an Internet connection. For more information, visit the Adobe Product Activation Center at

If you do not enter the product serial number when you start ColdFusion Builder, you can use the trial version of the full-featured ColdFusion Builder 2.0 for 60 days. After the trial expires, you need to purchase a license to continue using all the features. If not, ColdFusion Builder switches to a feature-limited Express Edition.

www.adobe.com/go/activation.

ColdFusion Builder 2 Express Edition

The Express Edition lets you use ColdFusion Builder with the basic features such as editor, code assist, and syntax highlighting.

Last updated 5/9/2011

USING COLDFUSION BUILDER

About ColdFusion Builder

But the following key features are not available in the Express Edition:

• Code assist for extensions

• Code insight

• Extension callback

• Connection to remote server

• Quick fix

• Debugging remote projects

• Refactoring

• ColdFusion search

• Code formatting

• FTP support

• Log viewer

• Local file browser

• Code hyperlinks

• Hover help

You can convert the Express Edition to a full-featured version by purchasing the license and specifying the product serial number.

Managing ColdFusion Builder licenses

If you are a single-license user you can use ColdFusion Builder on up to two computers. To use your ColdFusion Builder license on a different computer than your original two computers, deactivate the ColdFusion Builder license on one of the two computers. After which, you can use it on another computer.

To deactivate the ColdFusion Builder license, select Help > Adobe ColdFusion Builder Deactivation.

Note: If you are uninstalling ColdFusion Builder, Adobe recommends that you first deactivate your license and then uninstall ColdFusion Builder.

Installing third-party Eclipse plug-ins

ColdFusion Builder provides integration with third-party Eclipse plug-ins that let you extend or customize your development environment. You can install the third-party Eclipse plug-ins on Windows and Mac OS X platforms.

Note: To ensure that the plug-in installs correctly, add the Helios Update Site URL

http://download.eclipse.org/releases/helios (or an equivalent Eclipse update site URL).

1 In Adobe ColdFusion Builder, select Help > Install New Software.

2 Click Add.

3 Enter the name and URL of the plug-in to install. For example, to install Subclipse version 1.0, enter the following

http://subclipse.tigris.org/update_1.6.x

URL:

4 Select the plug-ins to Install.

5 Click Next and follow the instructions in the Install wizard.

6 Click Finish.

Last updated 5/9/2011

USING COLDFUSION BUILDER

About ColdFusion Builder

Getting started experience

ColdFusion Builder presents a dynamic getting started experience. Any time you start ColdFusion Builder, the Getting Started screen invites access to:

• Getting started tutorials

• Workflows

• Movie tutorials

• Notifications such as What is new in a release and details of ColdFusion and ColdFusion Builder releases and hot fixes

• Tips and tricks

• Useful resources

• Most used options such as Recently Open Files, Links to Open Project Wizard, Add server, Recommended

extensions, and Install Extensions

You can choose to hide the Getting Started screen, and then later display it again.

Display the Getting Started screen

❖ Select Help > Getting Started with ColdFusion Builder

Hide the Getting Started screen

❖ Do either of the following:

• Select the Don't Show Again option on the Getting Started screen

• Uncheck the option Show welcome page on startup in the Preferences dialog box (Window > Preferences >

ColdFusion > Startup)

Additional resources

• ColdFusion Builder Start Page

ColdFusion Builder engineering team member Sandeep Paliwal elaborates on the getting started experience.

ColdFusion Builder Help System

While you work in ColdFusion Builder, you can display context-sensitive Help for specific user interface elements of the workbench (views and dialog boxes) and language-reference help for code elements.

Adobe Community Help Client

Adobe Community Help client (CHC) is an AIR application that displays help content for ColdFusion Builder. The Help content is served directly from the web. When you open the CHC for the first time, an Internet connection is needed. You can then download the Help content to your desktop to use and search offline.

To open and view the ColdFusion Builder Help system, select Help > ColdFusion Builder Help.

Use context-sensitive Help

1 Select a view, dialog box, or any other user interface element in the workbench.

Last updated 5/9/2011

USING COLDFUSION BUILDER

About ColdFusion Builder

2 Press F1 (Windows) to open the associated Help page in the Community Help Client.

To use context-sensitive Help on Mac OS, set a keyboard shortcut to the Dynamic Help command. To specify a keyboard shortcut for the Dynamic Help command, do the following:

1 Select Adobe ColdFusion Builder > Preferences.

2 In the tree view, select General > Keys.

3 Select the Dynamic Help command.

4 Press the key binding combination that you want to set. For example, to enter Ctrl+Shift+1, press and hold the keys

Ctrl and Shift and then press 1. A plus sign (+) between the keys indicates that you must press the keys in succession.

Community Help Client Preferences

You can set CHC preferences to control the Help content display.

1 In the CHC, select Edit > Preferences.

2 In the Preferences dialog box, set the following options, as required.

General Settings

• You can select a light or dark theme for the CHC. A theme is a formatting choice that determines the appearance

of the CHC. For example, when you apply a dark theme, the CHC has a dark background and theme-specific fonts.

• The CHC is launched as an AIR application, by default. You can, however, choose to launch the CHC in your web

browser. To do so, select On (Launch Help In Browser).

Download Preferences

You can select the products and Help packages that you want to have available for offline use.

Updater Settings

CHC provides content updates and feature enhancements without reinstalling the AIR application. Select Notify Me When Updates Are Available to be prompted for new updates when you either open or close the CHC. You can also choose to manually search and install updates.

Local Content

You can manually delete the Help packages that you downloaded to your desktop.

Search and Filter options

CHC lets you search across different Help packages and search locations.

Click Search Options to display the following Search locations.

Local Help Searches the Help package downloaded to your desktop for offline viewing. Click Filter Results to narrow

down your search results to a specific book in the Help package.

Adobe.com Searches up-to-date definitive reference content across all online resources available on adobe.com,

including Developer Center articles, tutorials, and knowledgebase articles.

Community Help This search is cumulative of all the resources available on adobe.com as well as the most relevant

content contributed by experts from the Adobe community.

Code Search The integrated code search lets you search through relevant code snippets available on adobe.com

Last updated 5/9/2011

USING COLDFUSION BUILDER

About ColdFusion Builder

Dynamic navigation

CHC provides dynamic navigation based on search results to find related content. All related content appears in the Related Topics tab.

Feedback and rating

You can comment on, rate, and contribute to Help content if you have a valid Adobe ID. If you do not have an Adobe ID, you can get one by registering yourself at

https://www.adobe.com/membership.

Click Feedback And Rating in the bottom left-corner of the CHC, and provide your feedback. You can provide feedback in the form of a tip, example, or by suggesting a link to a relevant online resource.

Eclipse Help System

The Eclipse Help system displays CFML reference Help for code elements. The Eclipse Help system also displays Help for any third-party plug-ins that you install or that come packaged with ColdFusion Builder.

To open and view the Eclipse Help system, select Help > Help Contents.

Display CFML Reference Help

The CFML Reference is integrated into ColdFusion Builder, letting you quickly review the reference Help for a CFML tag or function.

• To open the Help topic for a CFML tag or function, do the following:

1 In the CFML editor, select a CFML tag element or function by highlighting or placing the pointer on the built-

in tag or function name.

2 Press F1 (Windows) or the equivalent keyboard shortcut for Mac OS. A link to the Help page for the selected

tag is displayed in the docked Help window.

Note: In Mac OS, when you press Command+Shift+/ to view Help for a CFML tag or function, generic editor Help appears in the docked Help window. To see the tag or function-specific Help, click the selected tag or function name in the CFML Editor again.

3 Click the Help page link. The Help page for the selected tag or function is displayed.

Set Help Preferences

You can set Help preferences to control how Help is displayed in the Eclipse Help system.

1 In ColdFusion Builder, select Window > Preferences.

2 In the Preferences dialog box, you see a tree-view structure on the left side. Select Help.

3 Set the following options, as required.

Open help search Determines whether to display the help search in the Dynamic Help view window or in a

browser. By default, in the Dynamic Help is selected.

Open help view documents Determines where to display documents that are opened from links in Dynamic Help.

By default, In-place is selected, and Help documents open in the Dynamic Help view window. To open Help documents in the ColdFusion Builder IDE editing area, select In the editor area.

Open help contents Lets you display help in a web browser of your choice. By default, the embedded browser of the

IDE displays Help. Select In an external browser and then select the Web Browser link to select your web browser.

Open window context help Determines how to display context-sensitive Help links for an open window. By

default, context-sensitive Help links are displayed in the Dynamic Help view which, when opened, is docked into

Last updated 5/9/2011

USING COLDFUSION BUILDER

About ColdFusion Builder

the current perspective like all other views. To display context-sensitive Help links in an infopop (similar to a tooltip), select In An Infopop.

Open dialog context help Determines how to display context-sensitive Help links for an open dialog box. By

default, Help is displayed in the dialog box. To display context-sensitive Help links in an infopop (similar to a tooltip), select In An Infopop.

Use dynamic Help

Dynamic Help is docked to the current perspective and displays topics for the associated views and dialog boxes.

❖ Select Help > Dynamic Help.

To change the default keyboard shortcut binding, select Window > Preferences > General > Keys, and change the associated binding for the Dynamic Help command. For more information on changing keyboard shortcuts, see “CFML Editor keyboard shortcuts” on page 57.

Getting started with ColdFusion Builder

Using ColdFusion Builder, you can develop ColdFusion applications in a full-featured IDE that lets you complete the following tasks:

Note: Before getting started with the tasks, ensure that you are familiar with the ColdFusion Builder workbench and its capabilities and features. For more information, see

“ColdFusion Builder Workbench Basics” on page 15.

• Create ColdFusion projects: Using the Project wizard, you can create a project and configure a local or remote

server with it. For more information, see

“Creating a ColdFusion project” on page 71.

• Add and manage servers: ColdFusion Builder includes integrated server management that allows you to manage

your ColdFusion servers, the ColdFusion Administrator, and Server Monitor within ColdFusion Builder.

You can configure both JRun and non-JRun servers. To manage your applications efficiently, ColdFusion Builder provides features such as virtual hosts, virtual directories, and URL prefixes.

For more information on using these features and managing your servers, see “Managing Servers” on page 62.

• Deploy remote projects over FTP connection: ColdFusion Builder lets you manage both local and remote servers.

The remote servers can be connected either through RDS (Remote Data Services) or FTP (File Transfer Protocol) connection. For more information about deploying and synchronizing remote projects over FTP connection, see “Deploy projects over FTP and Secure FTP connections” on page 77.

• Create ColdFusion pages, components, and interfaces: ColdFusion Builder provides wizards that let you create

resources such as, ColdFusion pages, ColdFusion components (CFCs), and interfaces. You can associate these resources to a project. For more information, see

“Add ColdFusion pages, interfaces, and components” on page 72.

• Write and edit your ColdFusion application source code using the CFML editor: ColdFusion Builder provides

code editors to edit CFML, HTML, JavaScript, and CSS code. Based on the type of code that you are editing, the appropriate editor is opened. For more information, see

The editors provide many features, including code colorization, code assist, and Outline view, which help you navigate through your code.

“ColdFusion Builder editors” on page 35.

The CFML editor provides features such as code completion, code refactoring, and streamlined code navigation. ColdFusion Builder lets you use different colors and fonts to display your code in the editor. For more information on the complete feature-functionality of the CFML Editor, see

“Code Editing in ColdFusion Builder” on page 37.

Last updated 5/9/2011

USING COLDFUSION BUILDER

About ColdFusion Builder

• Write and edit SQL statements using the SQL Editor: The CFML editor has an integrated SQL editor that lets you

edit and write SQL statements. You can also set code colorization preferences for supported SQL statements. For more information on the SQL Editor, see

“SQL Editor” on page 49.

• Use and create CFML dictionaries: ColdFusion Builder provides built-in CFML dictionaries that assist you with

CFML code completion. CFML dictionaries are supported for ColdFusion versions 7, 8 and 9. You can also create your own custom CFML dictionary. For more information about using and creating dictionaries, see

“CFML

Dictionaries” on page 42.

• Use ColdFusion Builder development views: ColdFusion Builder provides many views that let you develop your

applications easily.

The RDS FileView lets you access and explore file systems on local and remote servers. The RDS DataView lets you access and explore local or remote data sources. For more information, see

“RDS FileView and RDS DataView” on

page 22.

You can also query data on a local or remote data servers using the RDS Query Viewer. For more information, see “RDS Query viewer” on page 23.

The Services Browser view lets you browse through CFCs and their methods within the server web root. You can access both local and remote CFCs and web services. For more information, see

“Services Browser view” on

page 26.

The Snippets view and Outline view let you reuse and streamline your code. For more information, see “Snippets

view” on page 27 and “Outline view” on page 21.

For more information about all the development views, see “ColdFusion Builder Development perspective” on page 21.

• Use the ColdFusion debugger to debug applications: ColdFusion Builder provides an integrated debugger with

debugging views, like the Debug view and the Breakpoints view, which let you debug your applications. For more information about these views, see

“ColdFusion Debugging perspective” on page 29.

You can add breakpoints to your code, step into or over functions, and examine and evaluate expressions. You can debug files on both local and remote servers. For more information, see

“Debugging Applications” on page 81.

The Problems view, TailView view, and Console view detect syntax, server, and compilation errors and display them.

• Use and develop ColdFusion Builder extensions: Use the Extensions view to manage ColdFusion Builder

extensions.

You can develop extensions to generate code, design user interfaces, and perform basic CRUD (Create, Read, Update, and Delete) operations on the database. You can also develop extensions to perform custom actions such as opening files in the CFML Editor or inserting text in an open file. For more information about creating extensions, see

“ColdFusion Builder Extensions” on page 88.

ColdFusion Builder provides the ColdFusion Builder Extension Creator to guide you through the process of creating and packaging extensions. For more information, see

“Use ColdFusion Builder Extension Creator to create

and package extensions” on page 110.

The following extensions come packaged with ColdFusion Builder.

• Adobe CFC Generator

• ActionScript Class Generator

For more information on installing and using these extensions, see “Using Extensions” on page 114.

Last updated 5/9/2011

Chapter 4: ColdFusion Builder Workbench Basics

ColdFusion Builder is an Eclipse-based development environment that allows you to develop Adobe ColdFusion applications and run them on ColdFusion servers. You use it to develop ColdFusion applications using coding and debugging tools.

About the workbench

The ColdFusion Builder workbench is a full-featured environment for developing Adobe ColdFusion applications. Much of the basic functionality of the ColdFusion Builder IDE comes from Eclipse. The ColdFusion Builder plug-ins add features and functionality for creating ColdFusion applications. The plug-ins also provide tools for modifying the IDE user interface and supply some core functionality to support application building.

Workbench The workbench is the ColdFusion Builder development environment. The workbench contains three

primary elements: perspectives, editors, and views. You use all three in various combinations at various points in the application development process. The workbench contains all the tools you use to develop applications.

Perspective A perspective is a group of views, editors, menus, and toolbars in the workbench. Essentially it is a special

work environment that helps you accomplish a specific type of task. For example, ColdFusion Builder contains two perspectives. You use the ColdFusion Builder Development perspective to develop applications and the ColdFusion Debugging perspective to debug them.

For more information about perspectives, see “About ColdFusion Builder perspectives” on page 20.

Editor An editor allows you to edit various types of files. The editors available to you vary according to the number

and types of Eclipse plug-ins installed. ColdFusion Builder contains editors for writing CFML, HTML, JavaScript, and Cascading Style Sheets (CSS) code. For more information about code editing in ColdFusion Builder, see

Builder editors” on page 35 and “Code Editing in ColdFusion Builder” on page 37.

Views A view typically supports an editor. For example, when you edit CFML, the Outline view and Snippet view are

also displayed in the ColdFusion Builder Development perspective. These views support the development of ColdFusion applications and are therefore displayed when a CFML file is opened for editing.

Some views support the core functionality of the workbench itself. For example, the File Explorer view allows you to manage files and folders within the workbench. The RDS Dataview and RDS Fileview display data sources, files, and directories on both remote and local servers.

The term view is synonymous with the term panel as it is used in Adobe Dreamweaver® and other Adobe development tools.

For more information about the views in the ColdFusion Builder Development perspective, see “ColdFusion Builder

Development perspective” on page 21.

For more information about the views in the ColdFusion Debugging perspective, see “ColdFusion Debugging

perspective” on page 29.

“ColdFusion

Workspace Not to be confused with workbench, a workspace is a defined area of the file system. The workspace

contains the resources (files and folders) that make up your application projects. A workspace can contain multiple

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

projects. You can work with only one workspace at a time; however, you can select a different workspace each time you start ColdFusion Builder. For more information, see

Resource The general term resource applies to the files and folders in the projects in a workspace. For more

“Managing Projects” on page 71.

information, see“Add ColdFusion pages, interfaces, and components” on page 72 and “Add other files” on page 74.

Project All the resources that make up your applications are contained within projects. You cannot build an

application in ColdFusion Builder without first creating a project. For more information, see

“Managing Projects” on

page 71.

Workbench menus and toolbars

You access workbench commands through the menu bar, right-click context menus, toolbars, and keyboard shortcuts.

Workbench menus

The ColdFusion Builder workbench contains the following main menus:

File menu

The File menu lets you create, save, close, print, import, and export workbench resources and exit the workbench.

Menu command Description

New Creates a resource. Before you create a ColdFusion component, interface, or page, ensure

Open File Open a file for editing. You can also open files that are not in the workspace.

Close Closes the active editor. You are prompted to save changes before the file closes.

Close All Closes all open editors. You are prompted to save changes before the files close.

Save Saves the content of the active editor

Save As Lets you save the contents of the active editor in a different filename and location

Save All Saves the contents of all open editors.

Revert Replaces the contents of the active editor with the previously saved contents.

Move Moves the currently selected resources to a different project

Rename Lets you change the name of the selected resource

Refresh Refreshes the resource with the contents in the file system

Convert Line Delimiters To Lets you convert line delimiters to the operating system applicable to your development or

that you have created a project to store these resources.

deployment platform:

• Windows (default)

• Unix

• MacOS 9

Print Prints the contents of the active editor

Switch Workspace Opens the Workspace Launcher that lets you switch to a different workspace. When you

switch to a different workspace, the workbench is restarted.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

Menu command Description

Restart Restarts ColdFusion Builder

Import Lets you import resources to the workbench using the Import wizard

Export Lets you export resources from the workbench using the Export wizard

Properties Displays the properties dialog box for the selected resource. The Properties For dialog box

Recent File List A list of the most recently accessed files in the workbench. You can open these files from the

Exit Closes the open resources and exits the workbench

provides information about the path to the resource and the date of the last modification on the resource. It also provides information if the project's resources have inherited their encoding and line delimiters or if they are set to a particular value.

File menu by clicking the filename. You can control the number of files that must appear in this list using the Preferences dialog box.

Navigate menu

The Navigate menu lets you locate and navigate through resources in your workbench.

Menu command Description

Go Into Lets you navigate within hierarchies of resources such that the selected resource is at the

Go To Lets you jump to a specific resource or display the hierarchy that appeared before the

Open Declaration Opens declaration for selected code element.

root. That is, when you select a folder within a project and select Go Into, only the selected folder (and artifacts within the folder) appear in the Navigation view.

This command is useful in navigating through large-sized projects with complex hierarchies.

current display.

For example, select the Go Into command for a resource, and then select Go To > Back. The Back command displays the same hierarchy from which you activated the Go Into command.

Quick Outline Displays a quick view of the Outline view. A hierarchical view of the code structure of the

Open Resource Lets you select a resource in the workspace and open it in an editor using the Open

Show In Lets you find and select the currently selected resource in another view. If an editor is active,

Next Lets you navigate to the next item in a list or table in the active view

Previous Lets you navigate to the previous item in a list or table in the active view

Last Edit Location Lets you jump to the last edit position in the active editor

Go To Line Lets you jump to a specific line in the active editor

Back Lets you move editor focus to a previously opened file.

Forward Lets you return editor focus from the previous file.

page appears in a pop-up menu.

Resource dialog box

these commands are used to select the resource that is currently being edited in another view.

Project menu

The Project menu lets you manage projects in the workbench.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

Menu command Description

Open Project Opens the currently selected project. The selected project must be closed for this command

Close Project Closes the currently open project]

Properties Displays the project properties dialog box

to be available.

Window menu

The Window menu lets you display, hide, and manage the various views, perspectives, and actions in the workbench.

Menu command Description

New Window Opens a new workbench window with the same perspective as the currently open

New Editor Opens an editor that is of the same type as the currently active editor

Open Perspective Opens a new perspective in the workbench

Show View Lets you select the views to display in the workbench

Customize Perspective Lets you customize the currently selected perspective

Save Perspective As Lets you save the currently selected perspective, creating your own customized perspective.

Reset Perspective Lets you reset a customized perspective

Close Perspective Closes the currently open perspective

Close All Perspectives Closes all the open perspectives in the workbench

perspective

Navigation Contains shortcuts to navigate between the views, perspectives, and editors in the

Preferences Lets you set you preferences for using the workbench. There are a number of preferences

workbench

to configure the appearance of the workbench andtheviews and editors contained in the workbench.

Toolbars

Workbench toolbar

The workbench toolbar contains buttons for important and frequently used commands. These commands are also available from various ColdFusion Builder menus.

Workbench toolbar

The following buttons appear in the workbench toolbar (shown left to right):

Button/command Description

New Displays a pop-up menu that displays all the types of projects and documents you can

Save Saves the document that is open in the editor and currently selected

Print Prints the document that is open in the editor and currently selected

create.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

Button/command Description

New ColdFusion Project Opens the wizard to create a ColdFusion project.

Open CFC Lists all the CFCs that are available for projects displayed in the Navigator view.

Debug Uses the project’s currently open file to begin a debugging session. You can also select other

Run Runs the project’s currently open file. You can also select other application files in the

External Tools Selects a custom launch configuration

Search Searches for text strings and filename patterns for files in the project

Next Annotation Allows you to select and move forward to code annotations

Previous Annotation Allows you to select and move backward to code annotations

Last Edit Location Takes you to the code element that you last edited in the currently open file.

Back To Lets you move editor focus to a previously opened file.

Forward To Lets you return editor focus from the previous file.

application files in the project from the attached pop-up menu.

project from the attached pop-up menu.

CFML Editor toolbar

The CFML Editor contains buttons that are user interface shortcuts to frequently used commands. These commands are also available from various ColdFusion Builder menus. Some buttons in the toolbar are shortcuts to frequently used code elements, and are context sensitive to the code that you enter in the CFML Editor.

CFML editor toolbar

Button/command Description

Open Tag Editor Opens the Tag Editor.

For more information about using the Tag Editor, see “Tag Editor” on page 56.

Insert cfabort Inserts the cfabort tag.

This command is context sensitive to the script code.

Insert cfdump Inserts the cfdump tag. This command is context sensitive to the script code.

Wrap in cfoutput Wraps the selected code within the cfoutput tag.

This command is context sensitive to the script code that you enter in the CFML Editor.

Insert cfset Inserts the cfset tag.

Insert cfscript Block Inserts a cfscript code block.

Wrap in cftry/cfcatch Wraps the selected code within the cftry or cfcatch tag, depending on the code.

This command is context sensitive to the script code.

Wrap in ## Wraps the selected code within "#" marks.

Wrap/Unwrap in cfcomment Comments or uncomments the selected code.

Wrap/Unwrap in /* */ Wraps or unwraps the selected code within ""/* */"" marks

Wrap in Single Quotes Wraps the selected code within single quotation marks.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

Button/command Description

Wrap in Double Quotes Wraps the selected within double quotation marks.

To Uppercase Changes the text in the selected code to uppercase.

To Lowercase Changes the text in the selected code to lowercase.

About ColdFusion Builder perspectives

A perspective is a group of editors and views that support the completion of a task. ColdFusion Builder contains two perspectives: the ColdFusion Builder Development perspective and the ColdFusion Builder Debugging perspective.

Open and switch perspectives

When you open a file that is associated with a particular perspective, ColdFusion Builder automatically opens that perspective. That is, perspectives change automatically to support the task at hand. For example, when you create a ColdFusion project, the workbench displays the Development perspective. Similarly, when you start a debugging session, ColdFusion Builder switches to the Debugging perspective.

By default, perspectives open in the same window. To open a perspective in a new window, do the following:

1 Select Window > Preferences

2 In the tree view structure, select General > Perspectives.

3 Under Open a New Perspective, select In The Same Window.

You can manually switch perspectives by doing one of the following:

• Select Window > Open Perspective > Other from the main menu.

• Use the perspective bar in the main workbench toolbar.

Eclipse provides many predefined perspectives. So, if you use the plug-in configuration of ColdFusion Builder, you sometimes have additional perspectives.

You can access the other Eclipse perspectives by doing one of the following:

• Select Window > Open Perspective > Other from the main menu.

• Click in the perspective bar in the main workbench toolbar and select Other.

Set a default perspective

1 Select Window > Preferences.

2 In the tree view structure, select General > Perspectives.

3 Under Available Perspectives, select the perspective that you want to set as the default, and click Make Default.

4 Click OK.

The default perspective has the word "default" in parentheses after the perspective name.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

ColdFusion Builder Development perspective

You use the ColdFusion Builder Development perspective to create, edit, configure, and run ColdFusion applications in ColdFusion Builder. In addition, you can configure and manage local or remote ColdFusion servers.

G I

ColdFusion perspective

A. Outline view B. RDS Dataview C. RDS Fileview D. Perspective Bar E. Navigator view F. File view G. Source view H. Servers view I. Default Browser view J. Console view K. TailView view L. Services Browser M. Extensions view N. Snippets view

L M

The ColdFusion Builder Development perspective includes these views:

Outline view

The Outline view displays a hierarchy of elements in the file that is currently open in the editor. For example, it displays the functions in a CFC file and the tags in an HTML file.

You use Outline view to inspect and navigate the structure of your CFML, HTML, JavaScript, and CSS pages. If a page contains multiple code elements, you can use the Outline view to see a hierarchical view of the code structure of the page.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

You can sort the elements in Outline view alphabetically or in the order of their definition in the page. You can choose to view all the code elements or view only specific code elements.

• The Outline view displays the structure of your CFML code. For example, each item in the Outline view can

represent a CFML tag.

Outline view

• Double-click an element in Outline view to directly go to that element in the editor, instead of scrolling through the

entire code. When you select an item in Outline view, that item is highlighted in the editor, which makes it easier to navigate your code.

• Use the filter to search for a tag or element in the Outline view. Enter the name of the tag or element to search for

in the Filter field. The matching strings are displayed in the Outline view.

To specify the CFML tags to be displayed in an Outline view, select ColdFusion > Editor profiles > Editor > Outline. Then select, add, or remove tags, as required.

RDS FileView and RDS DataView

To use Remote Data Services (RDS), enable RDS while installing the ColdFusion server. ColdFusion Builder provides views to access files and data sources on a remote server.

The RDS FileView displays the files and directories on both remote and local servers. The RDS DataView displays the data sources configured in a remote server.

When you add a ColdFusion server instance in ColdFusion Builder, it automatically becomes available in RDS FileView and RDS DataView.

Configure a remote server for RDS FileView

If you want to configure a remote server manually and then access its files and directories using RDS FileView, do the following:

1 Click RDS FileView in the upper-right corner of the ColdFusion Builder perspective.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

2 Right-click in RDS FileView and select RDS Configuration.

3 Click New.

4 Specify remote server information such as the host name, port number, user name, and password.

5 Select Prompt For Password.

6 Click Test Connection to check that the RDS configuration is correct. Then, click OK.

7 Select the remote server from RDS FileView.

8 Specify the password for the remote server to view its files and directories.

Configure a remote server for RDS DataView

To configure a remote sever and access data sources from the remote server using RDS DataView:

1 Click RDS DataView.

2 Right-click in RDS DataView and select RDS Configuration.

3 Click New.

4 Specify the server information such as host name, port number, remote server user name, and password.

5 Select Prompt for Password.

6 Click Test Connection to check that the RDS configuration is correct. Then, click OK.

7 Expand the new server in RDS DataView to view data sources.

RDS Query viewer

The RDS Query viewer lets you create and run queries on a selected data source.

The RDS Query Viewer is available in the RDS DataView toolbar. To create and execute a query using the RDS Query viewer, do the following:

1 Click in RDS DataView to open RDS Query Viewer area.

2 Type the query in the blank area.

You can also build a query by dragging tables and columns from the RDS DataView view into the RDS Query Viewer.

3 Select the server and data source from the drop-down list.

4 Click Execute Query. The results of the query are displayed in the RDS Query Viewer area.

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

RDS query viewer

Right-click a table in the RDS DataView view and select Show Table Contents. You can view all the records of the selected table in the RDS Query Viewer.

Navigator view

The Navigator view displays ColdFusion projects and other projects, and allows navigation through the project’s files and folders.

File view

The File view displays files and directories on the local computer where ColdFusion Builder is installed and allows you to create new files.

If you edit a file outside ColdFusion Builder, you can automatically refresh the file in ColdFusion Builder. To do so, select Window > Preferences > General > Workspace, and select Refresh Automatically.

The File view also lets you add FTP sites and browse files on the FTP server. ColdFusion projects can be associated with FTP connections so that you can easily upload, download, and synchronize files. For more information, see “Deploy projects over FTP and Secure FTP connections” on page 77.

Servers view

Displays the details of ColdFusion servers including server name, status, description, server type, server host, and port. You can use the Server view to perform these tasks:

• Add and delete a ColdFusion server

• Start and stop a server

Last updated 5/9/2011

USING COLDFUSION BUILDER

ColdFusion Builder Workbench Basics

• Launch Server Monitor

• Launch ColdFusion Server Administrator

• Open server log

For more information, see “Managing Servers” on page 62.

Source view and Default Browser view

The Source view displays the source code for files. The Default Browser View displays the output in an HTML or CFML page.

Console view

The Console view displays the status of the ColdFusion server and any messages from the ColdFusion server.

TailView view

The TailView view displays the Server log and Workspace log, and lets you easily navigate through the logs. To automatically display the logs, RDS must be configured and enabled.

After selecting a server, you can open logs from the shortcut in the button bar of the Server Manager. Select the log to open it in the TailView view. By default, the TailView view opens the Exception log. When you are in Server view, you can open the Exception log by right-clicking and selecting Open Log.

To manually open the logs, right-click in the TailView view and select Add. Browse to and select a log file on your computer’s file system.

TailView view

The Tailview view toolbar contains the following buttons (left to right) that let you manage multiple logs in different tabs.

TailView toolbar

Last updated 5/9/2011

+ 93 hidden pages

Macromedia ColdFusion Builder - 2.0 Instruction Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Legal notices

Contents

Chapter 1: What’s New in ColdFusion Builder 2.0

ColdFusion Builder 2.0 Express Edition

Getting started experience

Editor enhancements

Code Assist enhancements

Code folding enhancements

Code Formatting

Quick Fix

ColdFusion Builder Search

Keyboard shortcut enhancements

Navigation enhancements

Extension enhancements

Other enhancements

Additional resources

Chapter 2: Introduction

ColdFusion and ColdFusion Builder documentation

Adobe ColdFusion documentation

Adobe ColdFusion Builder documentation

ColdFusion and ColdFusion Builder learning resources

Chapter 3: About ColdFusion Builder

ColdFusion Builder configurations

Activating ColdFusion Builder

Installing third-party Eclipse plug-ins

Getting started experience

Additional resources

ColdFusion Builder Help System

Adobe Community Help Client

Use context-sensitive Help

Community Help Client Preferences

Search and Filter options

Dynamic navigation

Feedback and rating

Eclipse Help System

Display CFML Reference Help

Set Help Preferences

Use dynamic Help

Getting started with ColdFusion Builder

Chapter 4: ColdFusion Builder Workbench Basics

About the workbench

Workbench menus and toolbars

Workbench menus

File menu

Navigate menu

Project menu

Window menu

Toolbars

Workbench toolbar

CFML Editor toolbar

About ColdFusion Builder perspectives

Open and switch perspectives

Set a default perspective

ColdFusion Builder Development perspective

Outline view

RDS FileView and RDS DataView

RDS Query viewer

Navigator view

File view

Servers view

Source view and Default Browser view

Console view

TailView view