Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

CFEclipse: The Developer's IDE, Eclipse For ColdFusion

CFEclipse (CFE) is a plug-in developed to integrate into the open platform created by the Eclipse Foundation

Many paths lead developers to ColdFusion. In the past ColdFusion was often viewed as an entry-level language enabling designers and other nonprogrammers to build dynamic sites. Since the release of CFMX it has become more recognized among developers familiar with languages such as Java and PHP.

This is partly due to language enhancements such as CFCs, and partly because it now runs as a Web application on top of a J2EE servlet container, thus allowing it to be used to develop the presentation layer for complex J2EE applications. For both types of developers there are requirements that an IDE must support. Many Web development tools are geared toward the first type of users mentioned above. They include features such as WYSIWYG Design Mode and image mapping functionality. For many developers falling into the second category, the WYSIWYG tools are lacking in the features that they are used to in other IDEs, and the non-WYSIWYG tools are either aging or not geared specifically to ColdFusion development. The goal of the CFEclipse project is to provide a tool for this second type of developer.

CFEclipse (CFE) is a plug-in developed to integrate into the open platform created by the Eclipse Foundation. Eclipse is designed specifically to be flexible enough to be used as a base for an IDE, a simple text editor, Web browser, e-mail client, or practically any other user application you care to mention. Eclipse is often perceived as a Java IDE, but in fact the Java development features are provided by nothing more than a plug-in much the same as (albeit much more mature than) CFEclipse. Eclipse itself is written in Java and runs on just about any platform that has a JVM version 1.4 or later.

Although other ColdFusion IDEs are also under development for use within the Eclipse platform, CFE is set apart by one main difference: the CFE project is an open source development project. The benefits of open source development are beyond the scope of this article; however, it is fundamental to the success of this IDE. Anyone can download the source code for CFE, and with that code add any feature he or she desires. Although this task may seem daunting for some beginners, it is also a very liberating experience. In preparation for this article we polled the CFEclipse users' mailing list (http://cfeclipse.tigris.org/servlets/ProjectMailingListList) to learn which features were other users favorites. One of the features mentioned most was the amazing release cycle. Users really appreciate that their suggestions are taken seriously and implemented quickly. This is due to the nature of open source software; anyone can contribute to the code base, which allows for features to be added quickly.

The concept of synergy is an amazing thing. The idea is that the sum of the contributions of the group exceeds those of individual developers. Think of just a few of the people you know who are passionate about technological advances and the things they can accomplish. Now imagine those people working together under a common banner to achieve a common goal. This is what open source development is about. Closed source development is hard to do without strong financial backing. We are all individuals and don't want to be at the mercy of an independent financial backer. There is also a lot of satisfaction in creating the tool you use to do the majority of your day-to-day work.

So now that you are familiar with the "why" and the "how," let's focus on the "what." CFEclipse is built as a developer's CF tool. CFE includes features that every person who writes CF code needs on a daily basis. All of the standard features you would expect are included. CFE supports syntax highlighting of CF code, CF tag, function insight, and project-based development. Here are some features you'll find in CFE that you won't find in contending tools:

  • Bracket matching: When writing functions or script, it is very easy to get lost in your nested elements. If you place your cursor next to a character that supports matching brackets ( ( ) { } [ ] ), CFE will highlight both the character you are near and its matching character. Never again get lost inside a dateAdd() inside a dateFormat() function!
  • Code folding: Available in CF Studio and Homesite, this feature has been resurrected in CFE and has had some bells and whistles added to it. When working in large files it is often convienent to be able to highlight a section of code and collapse it. This feature adds an icon to the right margin allowing you to expand and collapse this bit of code as you need it. Not only does CFE allow you to add your own collapsed sections, but it can automatically add them to many block-level CFML constructs. By default, when you open a file it will collapse CFML and HTML comments and cffunction blocks that span more than three lines. It will also add folding markers in the right margin for cfquery, cfscript, cfloop, cfif, cfswitch, and cfcase, and blocks that span more than three lines, but these will not be collapsed automatically. These defaults can be customized in the preferences area. A very handy organization feature!
  • Methods view: Since the addition of ColdFusion Components in CFMX, many developers have been wooed by the benefits they provide. When working in CFE you can open a CFC, file, and in the Methods View see a summary of the cffunction tags in your document. You can filter your functions based on type of access (private, package, public, remote) and you can sort them alphabetically. Double-clicking on a method name will move the cursor to that method in the document and expand the method if it is currently collapsed.
  • Outline view: The Methods view is convenient for files such as CFCs, which are mostly made up of cffunction tags. Sometimes it's also nice to have an overview of the structure of normal CFML files. The Outline view is designed to do exactly this. The real benefit is that when working in large files, you can filter your view based on the type of tag. You can filter on the currently selected element, or on a list of predefined tags such as cfmodule, cfset, cfquery, cfinclude, and cfcase. This makes working with long documents much more manageable (see Figure 1).
  • Versioning integration: Although not a ColdFusion-specific feature, the integration with Versioning Systems via other Eclipse plug-ins is incredible. Beyond being able to utilize all the features of CVS and SVN repositories, Eclipse also has a local history. The local history allows you to compare against the versions of the file that Eclipse has kept locally on your computer. So where normally you would need to go to the versioning server to compare previous versions, Eclipse allows you to do this very easily with every saved version of the file. By default Eclipse maintains seven days worth of changes locally.
  • Integrated browser: Many Web-centric IDEs will allow you to launch the page you are currently working on into an external browser. CFEclipse allows you to open a browser window inside the IDE itself. This is very similar to what you get in both DreamWeaver and Homesite. The difference in CFE is that you can specify a single root URL for a project and always have that URL loaded when you fire up the browser. CFE also allows you to have two tabbed browsers active. This allows you to review the page you are working on, as well as keep the Macromedia Livedocs or any other Web site at your fingertips. And all inside the IDE!
  • Scribble pad: At one point or another pretty much every Web developer has created a tmp.cfm file, or something similar, to test some small snippet of code outside the existing project. CFEclipse allows you to designate a file within any project that will act as a "scribble" file. While working in CFE you can activate the scribble pad via a keyboard shortcut. This will open the scribble file and load it into the integrated browser, allowing you to quickly test short snippets of code without having to hunt around in the file system for the last file you used. Using the same keyboard shortcut again will save the scribble file and refresh the integrated browser.
  • Snippets: Reminiscent of the snippets of Homesite , snippets allow you to create blocks of code that can be entered into your document by double-clicking the snippet from the snippet view. A text trigger can also be assigned to a snippet, allowing you to type the text trigger followed by a keyboard shortcut to add the snippet to your document. This approach literally gives you an unlimited number of snippets that can be inserted using only triggers and the keyboard shortcut. The snippets implementation also allows you to use Homesite-style snippet variables of the form $${variable:default} within the snippets. When you insert a snippet of this type you are prompted for the values you would like to use. This is very convenient for creating snippets that contain skeleton code for constructs like CFC getter and setter function pairs.
  • Right-click to open/create file from cfinclude: cfinclude offers many benefits to developers. CFE allows you to right-click on the template attribute of a cfinclude tag and choose the file to include. If the file does not exist, CFEclipse will attempt to create the file in the location you specify.
  • File Explorer: One of the most frequent complaints I have heard of Eclipse-based plug-ins is that there is no way to edit a file that is not part of a project. The File Explorer solves this problem by allowing you to explore your computer and open any file. Another benefit of the File Explorer is that it uses the same split-view approach that Homesite uses, with folders on top and files below. The File Explorer view also allows you to browse FTP sites and edit the files as if they were local, again in the same manner as Homesite (see Figure 2).
  • TODO tasks: Another popular feature is the ability of the IDE to track comments containing TODO items. Any comment that contains the string "TODO:" is tracked globally and can be viewed in the tasks view. When looking at the tasks view you can double-click on a task and the relevant file will be opened with the cursor on the line where the TODO: marker is located. The overview ruler in the right margin also allows you to quickly scan all the TODO tasks for the current document and jump directly to any one of them.
  • Framework support: Currently under development are many enhancements to the CFEclipse IDE that allow specialized functionality based on frameworks such as Mach-ii, Fusebox 3, and Fusebox 4.
  • Problems view: CFEclipse also includes a parser that checks for syntax errors in your ColdFusion document. When problems are found, they are compiled into a list that is tracked globally in the same way as the TODO tasks. In the latest development versions of CFEclipse, parser problems are also underlined in the text of the document. This makes it much easier to see exactly where the parser found a problem and it is usually relatively easy to spot the cause, such as an extra </cfif> tag in a nested set of if statements.

More Stories By Simeon Bateman

Simeon Bateman is director of development for Business Transitions LLC of Portland, OR. Simeon is a Certified Macromedia Coldfusion developer and has been utilizing Macromedia Coldfusion daily for the last 5 years.

More Stories By Stephen (Spike) Milligan

Spike has been working with ColdFusion since 1998, and has worked on some of the largest ColdFusion projects in Europe and Australasia. He is a Macromedia Certified Instructor and member of Team Macromedia for ColdFusion. Originally from Ireland, he has lived and worked in many countries in Europe and traveled the globe in search of new and interesting challenges. He moved to the Pacific Northwest in December 2003, and is currently the lead developer for the CFEclipse project.

Comments (3) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
MXDJ News Desk 08/03/05 10:07:19 AM EDT

CFEclipse: The Developer's IDE, Eclipse For ColdFusion. Many paths lead developers to ColdFusion. In the past ColdFusion was often viewed as an entry-level language enabling designers and other nonprogrammers to build dynamic sites. Since the release of CFMX it has become more recognized among developers familiar with languages such as Java and PHP.

Enterprise Open Source Magazine 08/03/05 08:44:57 AM EDT

CFEclipse: The Developer's IDE, Eclipse For ColdFusion. Many paths lead developers to ColdFusion. In the past ColdFusion was often viewed as an entry-level language enabling designers and other nonprogrammers to build dynamic sites. Since the release of CFMX it has become more recognized among developers familiar with languages such as Java and PHP.

cf 02/23/05 05:09:29 AM EST

gREAT ARTICLE. thank you

@ThingsExpo Stories
"When we talk about cloud without compromise what we're talking about is that when people think about 'I need the flexibility of the cloud' - it's the ability to create applications and run them in a cloud environment that's far more flexible,” explained Matthew Finnie, CTO of Interoute, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
The Internet giants are fully embracing AI. All the services they offer to their customers are aimed at drawing a map of the world with the data they get. The AIs from these companies are used to build disruptive approaches that cannot be used by established enterprises, which are threatened by these disruptions. However, most leaders underestimate the effect this will have on their businesses. In his session at 21st Cloud Expo, Rene Buest, Director Market Research & Technology Evangelism at Ara...
No hype cycles or predictions of zillions of things here. IoT is big. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, Associate Partner at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He discussed the evaluation of communication standards and IoT messaging protocols, data analytics considerations, edge-to-cloud tec...
New competitors, disruptive technologies, and growing expectations are pushing every business to both adopt and deliver new digital services. This ‘Digital Transformation’ demands rapid delivery and continuous iteration of new competitive services via multiple channels, which in turn demands new service delivery techniques – including DevOps. In this power panel at @DevOpsSummit 20th Cloud Expo, moderated by DevOps Conference Co-Chair Andi Mann, panelists examined how DevOps helps to meet the de...
When growing capacity and power in the data center, the architectural trade-offs between server scale-up vs. scale-out continue to be debated. Both approaches are valid: scale-out adds multiple, smaller servers running in a distributed computing model, while scale-up adds fewer, more powerful servers that are capable of running larger workloads. It’s worth noting that there are additional, unique advantages that scale-up architectures offer. One big advantage is large memory and compute capacity...
With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
Amazon started as an online bookseller 20 years ago. Since then, it has evolved into a technology juggernaut that has disrupted multiple markets and industries and touches many aspects of our lives. It is a relentless technology and business model innovator driving disruption throughout numerous ecosystems. Amazon’s AWS revenues alone are approaching $16B a year making it one of the largest IT companies in the world. With dominant offerings in Cloud, IoT, eCommerce, Big Data, AI, Digital Assista...
Artificial intelligence, machine learning, neural networks. We’re in the midst of a wave of excitement around AI such as hasn’t been seen for a few decades. But those previous periods of inflated expectations led to troughs of disappointment. Will this time be different? Most likely. Applications of AI such as predictive analytics are already decreasing costs and improving reliability of industrial machinery. Furthermore, the funding and research going into AI now comes from a wide range of com...
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
We build IoT infrastructure products - when you have to integrate different devices, different systems and cloud you have to build an application to do that but we eliminate the need to build an application. Our products can integrate any device, any system, any cloud regardless of protocol," explained Peter Jung, Chief Product Officer at Pulzze Systems, in this SYS-CON.tv interview at @ThingsExpo, held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA
SYS-CON Events announced today that Ayehu will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara California. Ayehu provides IT Process Automation & Orchestration solutions for IT and Security professionals to identify and resolve critical incidents and enable rapid containment, eradication, and recovery from cyber security breaches. Ayehu provides customers greater control over IT infras...
SYS-CON Events announced today that MobiDev, a client-oriented software development company, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MobiDev is a software company that develops and delivers turn-key mobile apps, websites, web services, and complex software systems for startups and enterprises. Since 2009 it has grown from a small group of passionate engineers and business...
SYS-CON Events announced today that GrapeUp, the leading provider of rapid product development at the speed of business, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Grape Up is a software company, specialized in cloud native application development and professional services related to Cloud Foundry PaaS. With five expert teams that operate in various sectors of the market acr...
SYS-CON Events announced today that Enzu will exhibit at SYS-CON's 21st Int\ernational Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enzu’s mission is to be the leading provider of enterprise cloud solutions worldwide. Enzu enables online businesses to use its IT infrastructure to their competitive advantage. By offering a suite of proven hosting and management services, Enzu wants companies to focus on the core of their ...
SYS-CON Events announced today that Cloud Academy named "Bronze Sponsor" of 21st International Cloud Expo which will take place October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara, CA. Cloud Academy is the industry’s most innovative, vendor-neutral cloud technology training platform. Cloud Academy provides continuous learning solutions for individuals and enterprise teams for Amazon Web Services, Microsoft Azure, Google Cloud Platform, and the most popular cloud com...
SYS-CON Events announced today that IBM has been named “Diamond Sponsor” of SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California.
In his session at Cloud Expo, Alan Winters, an entertainment executive/TV producer turned serial entrepreneur, presented a success story of an entrepreneur who has both suffered through and benefited from offshore development across multiple businesses: The smart choice, or how to select the right offshore development partner Warning signs, or how to minimize chances of making the wrong choice Collaboration, or how to establish the most effective work processes Budget control, or how to ma...
SYS-CON Events announced today that CA Technologies has been named "Platinum Sponsor" of SYS-CON's 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. CA Technologies helps customers succeed in a future where every business - from apparel to energy - is being rewritten by software. From planning to development to management to security, CA creates software that fuels transformation for companies in the applic...
Multiple data types are pouring into IoT deployments. Data is coming in small packages as well as enormous files and data streams of many sizes. Widespread use of mobile devices adds to the total. In this power panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists looked at the tools and environments that are being put to use in IoT deployments, as well as the team skills a modern enterprise IT shop needs to keep things running, get a handle on all this data, and deliver...
In his session at @ThingsExpo, Eric Lachapelle, CEO of the Professional Evaluation and Certification Board (PECB), provided an overview of various initiatives to certify the security of connected devices and future trends in ensuring public trust of IoT. Eric Lachapelle is the Chief Executive Officer of the Professional Evaluation and Certification Board (PECB), an international certification body. His role is to help companies and individuals to achieve professional, accredited and worldwide re...