samples directory

General information > Distribution structure > Directory and file structure > samples directory

samples directory

The samples directory contains the following files:

summary.html

Lists the samples that use a specific class, the topics covered by each sample, and the Rogue Wave JViews classes used in each sample.

summaryindex.html

Lists the samples in alphabetical order with a short description and a graphic representation.

This directory contains a set of subdirectories that group the samples by type. For example the equipment directory contains samples related to the equipment component. These subdirectories contain a subdirectory for each of their samples. For example:

equipment

basic

customClasses

imageRenderer

performance

styling

The common content of these subdirectories is given below.

index.html

Main page containing information about the sample.

build.xml

Ant project file to build and run the sample.

<component>-<sample_name>.jar

Executable archive file.

run.bat

run.sh

Scripts to run the sample on Microsoft® Windows® and UNIX®, respectively.

clean.bat

clean.sh

Scripts to clean the sample on Microsoft Windows and UNIX, respectively.

build.bat

build.sh

Scripts to build the sample on Microsoft Windows and UNIX, respectively.

/src

Subdirectory containing the source code.

/resources

Subdirectory containing the resources used in the sample, for example, image files.

/data

Subdirectory containing business objects and configuration files.

/srchtml

Subdirectory containing the documentation.

/classes

Subdirectory containing the classes used in the sample.