P A R A M E T E R    C H E A T    S H E E T
=========================================================================
CodeBrainSnapShot.class

IMPORTANT:  CodeBrainSnapShot.class will function properly off your
disk drive, as is.  To use it on your website, you MUST MUST MUST
get a KEYFILE from www.CodeBrain.com -- or the applet won't run.
The KEYFILE, CodeBrainSnapShot.key, must be in the SAME DIRECTORY
as the CodeBrainSnapShot.class file.

The keyfile is available FREE at http://www.CodeBrain.com ...


GENERAL NOTES
-------------------------------------------------------------------------

CodeBrainSnapShot's code is written protectively -- to make it easy
to set up and get running.  Demos and associated graphics are included,
to get you rolling quickly.

Other than the "Notice" parameter and ImageX parameters, you can leave
out almost any parameter and the applet will still run.  That is, "If
in doubt, leave it out!"  

You can make the applet as simple as you wish, without the clutter and
confusion of a multitude of parameters -- and then gradually build
upward into more complex uses.

Parameter names are as descriptive as we can make them without
having them a mile long, and they ARE case sensitive, so take care.

Keep image files to the smallest size possible to meet the needs
for your application.  Remember, large image files used with the
applet will take longer to load -- even though the CodeBrainSnapShot
class file is itself extremely small!

To get started, place the CodeBrainSnapShot.class file and ALL
files used by the applet in the SAME directory.

IMPORTANT

Check out the demos included, and gradually change parameters
to get a feel for how the applet works.  With any applet, this is the
very best way to get started.  You'll find our demo code very neatly
put together, with no extraneous code cluttering the pages.

Best regards,


CodeBrain  



P A R A M E T E R S
=========================================================================



<param name="Notice"                 value="Applet by www.CodeBrain.com">
-------------------------------------------------------------------------
// MUST be present, EXACTLY, or the applet will not run.  If it is not
// present and correct, the applet will respond with "Notice?".



<param name="BackgroundColor"                        value="rrr,ggg,bbb">
-------------------------------------------------------------------------
// This sets the applet background color.  The default is black.
// Usual RGB format, values 0-255.
// Example: value = "255,0,0" would make the applet background red.



<param name="BackgroundImage"                  value="imagefilename.jpg">
-------------------------------------------------------------------------
// This parameters sets the (optional) image to be used for the applet
// background. Leave this parameter out if you use no image for the
// background.
//
// Images may be .gif or .jpg format; but .jpg's work best for this 
// applet's background image.



<param name="InsetXY"                                      value="60,30">
-------------------------------------------------------------------------
// This is optional, but if you wish, you can have the main ImageX images
// (below) positioned at an inset from the left and top of the applet.
// In the example just above, the images would all come to rest at 60
// pixels from the left and 30 pixels from the top.  Note that this 
// applies to ALL the ImageX images.  (That is, you can NOT set the
// insets separately for each image.



<param name="ClearMode"                                        value="1">
-------------------------------------------------------------------------
// This is an IMPORTANT parameter, even though it is optional.  If you 
// set the value to 0 the images will NOT clear from the applet space
// between displays. If you set it to 1 -- they will.  



<param name="ImageX"                               value="imagename.jpg">
-------------------------------------------------------------------------
// This set of parameters sets the images to be used.  Images may be 
// .gif, or .jpg formats.  (In some cases, transparent .gifs can be
// used; though they tend to slow the applet rendering.)   In general,
// .jpg's work best and fastest with this applet.  
//
// Note that images DO NOT have to be the same size as the applet space.
//
// *** VERY IMPORTANT! ***
//
// ImageX MUST MUST MUST begin with Image0, with no skipped numbers in
// the sequence...
// 
// EXAMPLE:
//
<param name="Image0"                                     value="dog.jpg">
<param name="Image1"                                     value="cat.jpg">
<param name="Image2"                          value="verylargewoman.jpg">
//
// ALL other parameters in this general numbering format can skip numbers
// in the sequence.  Image parameters can NOT NOT NOT!



<param name="LinkX"        value="http://www.sitename.com/pagename.html">
-------------------------------------------------------------------------
// This is the page that a given image will link to when clicked.  It 
// follows the same naming scheme as ImageX.  For instance, Link3 would
// be the page that Image3 would link to when clicked.  If you don't
// want an image to link, leave its LinkX parameter out.  It IS okay
// to skip numbers in the LinkX parameters.



<param name="TargetX"                                       value="_new">
-------------------------------------------------------------------------
// This is the target frame or window that the corresponding image will
// link to.  Again, same numbering scheme as with images.  It IS okay to
// skip numbers in TargetX.  If you don't specify a TargetX, the default
// is _top -- that is, same window.
//
// Just so you don't have to go look it up... TargetX takes the
// same general values that you use in HTML.  Values with an underscore
// usually refer to the browser itself, thus:
//                 _new   - opens a new window
//                 _blank - also a new window
//                 _self  - loads in the same frame
//                 _top   - opens in the same window
// When using a framed page layout, the value for TargetX would be the
// name of the frame where you want the linked page to appear; i.e.,
// main, contents, george -- whatever name you've given the frame.



<param name="DirectionX"                                       value="1">
-------------------------------------------------------------------------
// Same naming scheme, of course... This sets the direction of motion of
// the associate ImageX.  Here are the available values:
//
// 0 = pop on screen
// 1 = left to right
// 2 = right to left
// 3 = top to bottom
// 4 = bottom to top
// 5 = top left to lower right
// 6 = bottom left to upper right
// 7 = top right to lower left
// 8 = bottom right to upper left
// 9 = random choice of 1 through 8



<param name="PauseX"                                        value="1000">
-------------------------------------------------------------------------
// Same naming scheme as the others... the value is in milliseconds.
// This is how long the associated ImageX will pause on the screen.
// It's okay to skip or leave out PauseX's entirely -- the applet has
// an internal default value of 1000 milliseconds (1 second).  Setting
// this value to 0 makes the associated ImageX pause as briefly as
// possible.



<param name="StatusBarTextX"            value="This is your Uncle Harry">
-------------------------------------------------------------------------
// By now it should be getting obvious all these use the same naming
// scheme.  This is the text that will *automatically* appear when each
// image is displayed in the applet.  Leave out the parameter if you
// don't want the status bar to show anything.  Note that this is not
// a mouse-over!  



<param name="StatusBarTextLoading" value="Wait for next image!">
-------------------------------------------------------------------------
// Optional:  This text will show in the status bar between ImageX loads.



<param name="Sound" value="sound.au">
-------------------------------------------------------------------------
// Optional:  This would be the sound file that is triggered when any
// image is clicked.  Leave it out if you don't need it.  Sound files
// must, of course, be in .au or .snd Sun format, as is usual for any
// applet.  Newcomers take note:  .mid and .wav files can NOT be used.



<param name name="SlideSpeed" value="0">
-------------------------------------------------------------------------
// Optional -- and you rarely set it -- so you can leave it out.  You
// can, though, for some effects, set this value.  Nominally it's in
// milliseconds, and the larger the number, the slower the applet runs.



<param name="ClickOverlap"                                    value="10">
-------------------------------------------------------------------------
// This is set in the applet defaults, but you will probably want to 
// use it anyway.  What it does is provide a 'dead zone' between ImageX
// displays when clicking on the applet space.  This allows you to leave
// a safety zone between image displays so that the visitor can't become
// easily confused as to just which image it is that is being clicked.
// The range is 0-100.  Experiment with the values a bit, as they react
// somewhat differently depending on your layout.



G E N E R A L   N O T E S   *** I M P O R T A N T ***
==========================================================================
Remember!!!  Class files must always be sent to your server in binary,
and key files must go up in ASCII.  When you're first setting up any
applet - do it on a blank page with nothing else but the applet so that
other possible problems won't get in the way.  Also be sure to put ALL
files related to the applet in the same directory -- the class file,
the html file that calls it, the keyfile, all images, sound files, etc.
If you need to move resource files to other directories and path to 
them - do that AFTER you get the applet running!!! 



W H E R E   T O   S T A R T
==========================================================================
We suggest you start off with the demos provided with the download kit,
then gradually experiment.  This can be a truly simple applet -- or a
complex, powerful tool - depending on how far you want to take it.  But
like any new one, you need to become familiar with its set-ups.



That's it, that's all there is!  Go to it!

Best regards,


CodeBrain


          







=========================================================================
The CodeBrainSnapShot.class applet is (c) 1999 by CodeBrain.com
All responsibility for use of the applet remains with the user.