Get Started with JSX Prerequisities Download Installation Exploded Installation JAR file Installation Get Started with SynapticFaces Library Dependencies Installation Get Started with SynapticAjax Faces Components Library Dependencies Installation Other Considerations

Get Started with JSX

To get started with the JavaScript Extension toolkit is very easy. There are a couple of prerequisities we assume one already satisfies.

Prerequisities

This documentation has been written with a user that is already familiar with JavaScript, that way he/she can follow the topics here.

Download

The JSX JavaScript library can be downloaded here. Depending on your specific installation scenario, you can download either a .jar or a .zip archive. Beside the archive files that contain the JSX library, you will also find a .war archive that contains configured WEB application showcasing the various JSX components and technologies.

Installation

The installation of JSX is actually quite trivial. There are two installation scenarios.

Exploded Installation

After downloading one of the distribution archives, all a developer needs to do is extract the contents of the archive into the root of your web context.

JAR file Installation

The installation of a .jar file is actually easier than in section above, but it assumes extra configuration.

• Install the .jar file in your web application, simply make sure to place it inside of your WEB-INF/lib directory.
• Configure the web.xml web application configuration file to use a ResourceServlet to access the archive contents.

NOTE: The JSXShowcase.war sample application is configured in this way.

Get Started with SynapticFaces

In this get started section we assume that you already know about J2EE web applications and are familiar with JSF. The SynapticFaces product works and has been tested to work on all major JSF implementations.

Library Dependencies

• jsf-api.jar
• jsp-api.jar
• servlet-api.jar
• JSX

Installation

This section assumes that you have already installed a web server such as Apache Tomcat, or an application server such as JBOSS. An installed server will generally give you access, with the exception of JSF to all prerequisite libraries. JBOSS has the MyFaces implementation of JSF included.

• Complete JSX installation as stated in steps above.
• Place the synapticfaces-x.x.x.jar library into the WEB-INF/lib directory.

If you are using an IDE such as Eclipse to develop your application, some helpful pointers can be found here.

Get Started with SynapticAjax Faces Components

SynapticAjax JSF components are built on top of the foundation of SynapticFaces and JSX. As with SynapticFaces components we assume that you do have some basic understanding of the JSF framework.

Library Dependencies

• jsxtoolkit-x.x.x.jar
• synapticfaces-x.x.x.jar
• log4j
• dom4j

NOTE: Fully installing SynapticFaces will satisfy all other dependencies, therefore those dependencies are not mentioned here.

Installation

The installation of SynapticAjax is not any different from the installation of SynapticFaces.

• unless it is already a part of your web server, download log4j at
• download and install dom4j at
• install JSX following steps above
• install SynapticFaces following above guide
• copy synapticajaxfaces-x.x.x.jar into WEB-INF/lib directory

Other Considerations

The installation instructions for the most part merely show where in your web application to place the library files. Most of the time you will need to develop your application first and will need to adapt the installation steps to your specific development environment and build process.