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



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

// CodeBrainYak's code is written protectively -- to make it easy
// to set up and get running.  Demos and associated graphics and sound
// files are included, to get you rolling quickly.
//
// Other than the "Notice" parameter, 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 and sound files to the smallest sizes possible to meet
// the needs for your application.  Remember, a large sound or image
// file used with the applet will take longer to load -- even though
// the CodeBrainYak.class file is itself is extremely small for all it
// can do.
//
// To get started, place the CodeBrainYak.class file and ALL files
// used by the applet in the SAME directory.
//
// Check out the demos included, and gradually add and change the
// parameters to get a feel for how the applet works.
//
// We know you'll find a great number of interesting ways to put the
// CodeBrainYak applet to work on your site.  For a very small,
// simple applet, it's got incredible potential and flexibility.
//
// 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's 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="FontName"                                    value="Dialog">
-------------------------------------------------------------------------
// This is the font to be used by the applet, sometimes called the font
// face.  JAVA applets universally support the following fonts:
//
//                    Dialog
//                    Helvetica
//                    Courier
//                    TimesRoman
//                    Symbol
//
// The default font (if you don't use this parameter) is Dialog.



<param name="FontSize"                                        value="12">
-------------------------------------------------------------------------
// This sets the overall size of the applet font.  Practical sizes range
// from around 10 to 36, though smaller and larger sizes will work.
//
// The default size (if you leave out this parameter) is a compromise 11
// that works well for general use across a variety of screen resolutions.



<param name="FontStyle"                                     value="bold">
-------------------------------------------------------------------------
// This sets the font style for the text.
// JAVA applets universally support the following styles:
//
//                   plain
//                   bold
//                   italic
//                   bolditalic
//
// The default font style (if you don't use this parameter) is plain.



<param name = "Text"                  value="This appears on the Button">
-------------------------------------------------------------------------
// This is the text or 'label' that will appear in the applet space.
// Make sure you've got it positioned within the applet, of course -- and
// the text, obviously, can't be longer than will fit within the applet.
// SPECIAL NOTE:  If you are not using text in the applet, you can leave
// this parameter, all the other parameters whose names begin with 'Text'
// and all of the parameters beginning with 'Font' entirely out.



<param name = "TextXY"                                       value="X,Y">
-------------------------------------------------------------------------
// This sets where the text will appear inside of the applet space.  You
// MUST provide both parameters, comma in between, and they must, of
// course, be within the applet space.  The values are in pixels.
// X sets how far from the applet LEFT edge.  Y sets how far from the
// applet TOP edge.  (You can use negative numbers to move the text off
// the applet space -- for instance, if you want the text to appear in
// the mouseOver mode, but not otherwise.)



<param name = "TextShiftXY"                                  value="X,Y">
-------------------------------------------------------------------------
// This works a little differently than the parameter above, so TAKE
// NOTE.  This is a SHIFT value, NOT an absolute position.  The X value
// is for left-to-right; the Y value is for up-and-down.  The values
// are in pixels, and will SHIFT the position of the text, RELATIVE to
// the values you set in TextXY (above) when the mouse moves over the
// applet.  Negative numbers are perfectly acceptable -- in fact, you'll
// use them often in this parameter.  As a brief example, lets say you
// set X at 50 in TextXY (50 pixels from the left of the applet).  If
// you set X at -10 in TextShiftXY, when the mouse moves over the applet,
// the text will shift left from it's current position to 40 pixels from
// the left of the applet; that is, 50 - 10 = 40.  This is especially
// useful in basic button flip modes (see AnimateMode 4, below), where
// a setting of 1,1, or -1,-1 in TextShiftXY will give the illusion of
// a mechanically active button.



<param name = "TextColor"                                value="0,255,0">
-------------------------------------------------------------------------
// This sets the color of the text for the applet when the mouse is NOT
// over the applet space.
// Usual RGB format, values 0-255.
// Example: value = "0,0,255" would make the text blue.



<PARAM NAME = "TextHotColor"                          VALUE="255,110,10">
-------------------------------------------------------------------------
// This sets the color of the text for the applet when the mouse IS
// over the applet space.
// Usual RGB format, values 0-255.
// Example: value = "255,0,0" would make the text red.



<param name = "StatusBarText"     value="This appears in the Status Bar">
-------------------------------------------------------------------------
// This is what will appear in the browser status bar when you place the
// mouse over the applet space.  (If you don't need it, leave it out.)
// The text is removed from the status bar when you move the mouse out
// of the applet space.



<param name = "BoxMode"                                        value="3">
-------------------------------------------------------------------------
// Make sure you set this correctly, or you'll be wondering where the
// border is...  These are the modes:
//                           0 = no box
//                           1 = box on mouseOver
//                           2 = box on mouseOut
//                           3 = box on both
// To explain a little further, if you set this value to '1', the box
// will only appear when the mouse is over the applet space; with '2',
// only when the mouse is not over it; and with '3', at all times.
// In the last case ('3'), you can set the colors (below) to be different
// depending on whether the mouse is over the applet or not.  It's a
// good idea to set this value to '3' at first -- then fiddle with it
// later.



<param name = "BoxStyle"                                       value="1">
-------------------------------------------------------------------------
// There are basically four 'box' styles for this applet... two of which
// aren't actually boxes (circle, oval), but we had to call them some-
// thing... 
// These are the styles and the mode BoxStyle parameter values:
//                           0 = plain rectangle
//                           1 = rounded rectangle
//                           2 = circle
//                           3 = oval
// The first two are the mot useful; though the circle and oval can often
// be used to good effect in special situations. Make sure you have
// BoxMode (above) set to '1' or higher, of course -- or no box will
// appear.



<param name = "BoxInset"                                       value="2">
-------------------------------------------------------------------------
// This sets how far in from the edge of the applet the box will appear,
// in pixels.  Make sure you have BoxMode (above) set to '1' or higher,
// or no box will appear.




<param name = "BoxThick"                                       value="2">
-------------------------------------------------------------------------
// This sets how thick, in pixels, the box border will be.  Make sure you
// have BoxMode (above) set to '1' or higher, or no box will appear.



<param name="BoxColor"                               value="rrr,ggg,bbb">
-------------------------------------------------------------------------
// This sets the color of the 'box' or border that surrounds the applet
//    at the edge.
// Usual RGB format, values 0-255.
// Example: value = "0,0,255" would make the box blue.
// Make sure you have BoxMode (above) set to '1' or higher, or no box will
// appear -- and take care you haven't set the color to something that
// would not be visible against your graphical content or the applet
// background color.



<param name = "BoxHotColor"                            value="0,255,123">
-------------------------------------------------------------------------
// This sets the color of the 'box' or border that surrounds the applet
//    at the edge -- but for the 'hot' or MouseOver mode.
// Usual RGB format, values 0-255.
// Example: value = "0,255,0" would make MouseOver box green.



<param name = "ImageX"                             value="imagename.gif">
-------------------------------------------------------------------------
// This set of parameters sets the images to be used.  Images may be 
//     .gif, animated .gif, or .jpg formats.  Keep image file sizes and
//     dimensions as small as possible, of course, to keep down loading
//     time and redrawing overhead.  
//
// Note that images DO NOT have to be the same size as the applet space.
//     The applet readily accommodates images of different sizes.
//
// For EACH IMAGE, change the number portion of the parameter.  Numbers
//     should be successive, starting at 1, with no skips in the number
//     sequence.  For example:
//           <param name="Image1" value="horse.jpg">
//           <param name="Image2" value="earth.jpg">
//           <param name="Image3" value="phone.jpg">
//
// CAUTION: Image parameter names MUST start at Image1 and MUST be
// successively numbered.  NO SKIPS in the sequence of numbers are
// allowed!  Have a look at the included demos if you need additional
// examples.



<param name = "AnimateMode"                                    value="3">
-------------------------------------------------------------------------
// This sets how images will behave in the applet.  These are the values:
//                           0 - none
//                           1 - loop on mouseOver
//                           2 - loop on mouseOut
//                           3 - loop always
//                           4 - switch 1 & 2 images
// To make this a little clearer, in mode '0', only Image1 will appear.
// In mode '2', whatever images you have will sequence only when the 
// mouse is over the applet space; but will otherwise stay static.  In
// mode '3' -- just the opposite of '2'... the images will cycle only
// when the mouse is NOT over the applet. Mode '4' turns the applet into
// an image flipper:  No matter how many images you have, it will only
// flip back an forth between Image1 and Image2.  Image1 will show when
// the mouse is over the applet; Image 2 will show when it is not.
// Special Note:  Mode '4' is most useful for making traditional
// mouseOver buttons -- one of the most common uses for this applet.



<param name = "Dwell"                                        value="100">
-------------------------------------------------------------------------
// This sets how long the applet will wait between each image in a
// sequence.  Large values take longer; small ones make the sequence run
// faster.  More or less, it's in milliseconds (thousandths of a second),
// so, say, setting it to 100 would make the images fly by fairly quickly,
// while setting it to 1000 would take about a second between image 
// changes.  Special note:  If you use the applet as a stand-alone image
// animator, you probably want to set this value out fairly long, say,
// around 5000 (about five seconds).



<param name="Sound"                                 value="soundfile.au">
-------------------------------------------------------------------------
// This is the sound file that the applet will play, and is, of course,
// required.  Any standard .au file in usual JAVA format is acceptable.
// The sound file plays on the down-click of the mouse. If you don't need
// sound with the applet -- leave the whole parameter tag out.  Special
// Note:  A good use for this applet is for a simple sound button.



<param name = "Link"         value="http://www.codebrain.com/index.html">
-------------------------------------------------------------------------
// This is the url the applet will link to when the mouse is clicked.
// The actual link takes place on the up-click of the mouse.  Be certain
// to use explicit addressing, as above; NOT just the name of the HTML
// page.



<param name = "Target"                                      value="_new">
-------------------------------------------------------------------------
// This is the target or frame to which the link will go.  It 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 Target would be the
// name of the frame where you want the linked page to appear; i.e.,
// main, contents -- whatever name you've given the frame.



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 is really a pretty simple applet, 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 CodeBrainYak.class applet is (c) 1999 by CodeBrain
All responsibility for use of the applet remains with the user.
