# Image Menu Navigator

Class Files: inm.class, ocgifix.class, ocjwkey.class Notice Tag: Image Navigator Menu, Copyright (c) 1997 OpenCube Technologies, Registered (Unique Key ID#)

Applet Tag Template:

- Based on the above sample implementation

Online Documentation at www.opencube.com:

The online documentation includes general information regarding the use of the applet tag and uploading applets to the server, common Java bugs with Internet Explorer and Netscape as well as an applet configuration FAQ.

- Applet Configuration FAQ
- Technical Document Index

Information about the applet and its parameters:

Required Parameters

Parameter 1 (the "notice" tag) must be included in the applet tag in order for the applet to work. Most of the parameters will default if you fail to define them, at a minimum you must include the notice tag, image file locations, and associated messages. Usually the easiest way to customize the applet is to cut and paste the applet tag information used in the sample and modify it to fit your web page.

Color Definition

Color Definition: This applet uses a simple RGB color scheme. To define a color in one of the color parameters use a value between 0 - 255 for the red, green, and blue components separated by commas and typed out in the correct r,g,b order. Below is a sample of how a color parameter should look, the example specifies several different sample colors for the "bgcolor" parameter.

WHITE: <param name="bgcolor" value="255,255,255">
GREEN: <param name="bgcolor" value="0,255,0">
BLACK: <param name="bgcolor" value="0,0,0">
YELLOW: <param name="bgcolor" value="255,255,0">
OFF WHITE: <param name="bgcolor" value="240,239,234">

The best way to choose the exact color you are looking for without having to guess the numbers is to access your systems Color Picker. Color Pickers usually allow you to drag the mouse over a rainbow type color grid to select a color, and show you the appropriate RGB values. In windows the Color Picker is accessible through MS Paint as well as a majority of the popular Imaging and HTML Authoring Software.

Defining Multiple Attributes with One Parameter Name

Parameters used to customize a specific image location or message are indicated using a range, such as "imagefile0" - "imagefileN". To define a parameter for a specific image or message (available when noted as above), use "imagefile0" to define, in this case, the first main menu image, "imagefile1" would define the second main menu image, etc.

Coordinate System

The origin of the applets coordinate system is located at the upper left corner of the applet. The x (horizontal) coordinate starts at the left border with 0 and goes as far to the right as the applet is wide (defined with the width tag - see above). The y (vertical) coordinate starts at the top of the applet with 0 and goes down as far as the applet is high (defined with the height tag - see above).

The Applet Parameters

General Applet Settings

Parameter 1
Attribute: Copyright notice.
param name="Notice"
value="Image Navigator Menu, Copyright (c) 1997 OpenCube Technologies, Registered (Unique Key ID#)"
Note: This must be included for the applet to work.

Parameter 2
Attribute: Applet Background Color
param name = "bgcolor"
Value = R,G,B, Where R,G,B are the red, green, and blue components of the applets background color.

Parameter 3
Attribute: Default Status Bar Text when mouse is over applet
param name = "onsbtext"
value="X", where X is the message to appear in the status bar when the mouse is over the applet but not over a URL link.
DEFAULT: OpenCube - Image Navigator Menu

Parameter 4
Attribute: Default Status Bar Text when mouse is off applet
param name = "offsbtext"
value="X", where X is the message to appear in the status bar when the mouse is not over the applet.
DEFAULT: Java by OpenCube

The Main Image

Parameter 5
Attribute: Main Image File Location
param name = "bgimagefile"
Value = X. Where X is the relative location and name of the main image file to be displayed in the applet area. This must be defined relative to the location of the document containing the applet.

Parameter 6
Attribute: Main Image File X (Horizontal) Coordinate
param name = "bgimagex"
Value = X. Where X is the horizontal x coordinate of the main images left border relative to the left edge of the applet. (measured in screen pixels)
DEFAULT: 0

Parameter 7
Attribute: Main Image File Y (Vertical) Coordinate
param name = "bgimagex"
Value = X. Where X is the vertical y coordinate of the main images top border relative to the top edge of the applet. (measured in screen pixels)
DEFAULT: 0

The Highlight Images

Parameter 8
Attribute: Highlight Image File Location and Name
param name = "hlfile0" - "hlfileN"
Value = X. Where X is the relative location and name of the image file to be displayed in the applet area when the mouse is over the coordinates specified with "picx", "picy", "picwidth", and "picheight". This must be defined relative to the location of the document containing the applet.

Parameter 9
Attribute: Image x (horizontal) location
param name = "picx0" - "picxN"
Value = X. Where X is the horizontal location of the left border of the image relative to the left margin of the applet.

Parameter 10
Attribute: Image y (vertical) location
param name = "picy0" - "picyN"
Value = X. Where X is the vertical location of the top border of the image relative to the top of the applet.

Parameter 11
Attribute: Predefined Image Width
param name = "picwidth0" - "picwidthN"
Value = X. Where X is the predefined width of the image. When this parameter is used the menus are made accessible before the main image loads. When this parameter is not included the main image must first load, then as the highlight images load and their dimensions are automatically determined by the applet the highlight regions become active and the sub menus are made accessible. Note: When predefining the image width it is not necessary to define the width as the exact width of the image, by using other values you can redefine your hot-spots without effecting the highlight image.

Parameter 12
Attribute: Predefined Image Height
param name = "picheight0" - "picheightN"
Value = X. Where X is the predefined height of the image. See the above description with the predefined image width parameter for more information.

Message Box Descriptions and Formatting

Parameter 13
Attribute: Default Message Description
param name = "msg"
Value = X. Where X is the default message that is initially loaded before the mouse moves over any image. If your text is longer than the width of the applet it will automatically be formatted to multiple lines. You may use a horizontal bar ('|') character to force a paragraph break. For example "this is the first paragraph|this is a second paragraph and automatically has a space between itself and the first paragraph by using the horizontal bar character" You may force as may paragraph breaks as you wish.

Parameter 14
Attribute: Specific Messages associated with an Image
param name = "msg0" - "msgN"
Value = X, Where X is the message that corresponds to the index used to identify a image defined with the "hlfile" parameter. This is the specific message that will appear when the mouse moves over its related image. Note: Not defining a message for a specific image will force the default message defined with the "msg" parameter to be used.

Parameter 15
Attribute: Font Style
param name = "msg_style"
Value = plain, bold, italic, or bolditalic
DEFAULT: plain

Parameter 16
Attribute: Font Name
param name = "msg_font"
Value = X. Where X is the name of the font to be used for all messages. (valid Java font names: "Courier", "Helvetica", "TimesRoman", "Dialog", "DialogInput")
DEFAULT: Helvetica

Parameter 17
Attribute: Default Font Size
param name = "msg_size"
Value = X. Where X is the default size of the font for all messages.
DEFAULT: 12

Parameter 18
Attribute: Specific Font Size
param name = "msg_size0" - "msg_sizeN"
Value = X, Where X is the size of the font for a specific message.

Parameter 19
Attribute: Default Text Color
param name = "msg_textcolor"
Value = R,G,B. Where R,G,B defines the red, green, and blue components of the color as described above.
DEFAULT: Black

Parameter 20
Attribute: Specific Text Color
param name = "msg_textcolor0" - "msg_textcolorN"
Value = R,G,B. Where R,G,B define the red, green, and blue components of the color for a specific message as described above.

Parameter 21
Attribute: Default Background Color
param name = "msg_bgcolor"
Value = R,G,B. Where R,G,B define the red, green, and blue components of the back ground color of the message area.
DEFAULT: White

Parameter 22
Attribute: Specific Back Ground Color
param name = "msg_bgcolor0" - "msg_bgcolorN"
Value = R,G,B. Where R,G,B define the red, green, and blue components of the back ground color for a specific message area.

Parameter 23
Attribute: Default Center or Left Justify Text
param name = "msg_centertext"
Value = true or false. Where true = yes center text, false = no left justify text.
DEFAULT: false

Parameter 24
Attribute: Specific Center or Left Justify Text
param name = "msg_centertext0" - "msg_centertextN"
Value = true or false. Where true = yes center text, false = no left justify text.

Parameter 25
Attribute: Default Vertical Alignment
param name = "msg_valign"
Value = 1 or 2 or 3. Where 1=align top: 2=align center: 3=align bottom
DEFAULT: 2

Parameter 26
Attribute: Specific Vertical Alignment
param name = ""msg_valign0" - ""msg_valignN"
Value = 1 or 2 or 3. Where 1=align top: 2=align center: 3=align bottom.

Parameter 27
Attribute: Default Border Thickness
param name = ""msg_borderthickness"
Value = X, Where X is the thickness of the border for all messages.
DEFAULT: 0

Parameter 28
Attribute: Specific Border Thickness
param name = ""msg_borderthickness0" - ""msg_borderthicknessN"
Value = X, Where X is the thickness of the border for a specific messages.

Parameter 29
Attribute: Default Border Color
param name = ""msg_bordercolor"
Value = R,G,B. Where R,G,B define the red, green, and blue components of the border color.
DEFAULT: Black

Parameter 30
Attribute: Specific Border Color
param name = ""msg_bordercolor0" - ""msg_bordercolorN"
Value = R,G,B. Where R,G,B define the red, green, and blue components of the specific border color.

Parameter 31
Attribute: Left and Right margin
param name = "msg_lrmargin"
Value = X. Where X is the left and right margin not including the border area, if any.

Message Box Position and Sizing

It is possible to place the message box directly within the image, however the box will not be made transparent. The box will always sit on top of the image, using such as design it is possible to have an image effect surrounding the message and links on all sides with highlight images on all sides.

Parameter 32
Attribute: Horizontal X Coordinate of Message
param name = "msg_x"
Value = X. Where X is the horizontal location, x coordinate of the messages left border using the coordinate system described above. This parameter defines the final horizontal resting location of the message.

Parameter 33
Attribute: Vertical Y Coordinate of Message
param name = "msg_y"
Value = X. Where X is the vertical location, y coordinate of the messages top border using the coordinate system described above. This parameter defines the final vertical resting location of the message.

Parameter 34
Attribute: Message Width
param name = "msg_width"
Value = X. Where X is the width of the message area.

Parameter 35
Attribute: Message Height
param name = "msg_height"
Value = X. Where X is the height of the message area.

Message Box Animations

Parameter 36
Attribute: Default Animation Heading for Messages
param name = "msg_heading"
Value = 0 or 1 or 2 or 3 or 4. Where 0=No Animation: 1= Start at Top: 2= Start Right: 3=Start Bottom: 4=Start Left. Note: Watch that the messages do not transition over the images or they will be erased.

Parameter 37
Attribute: Specific Animation Heading for Messages
param name = "msg_heading0" - "msg_headingN"
Value = 0 or 1 or 2 or 3 or 4. Where 0=No Animation: 1= Start at Top: 2= Start Right: 3=Start Bottom: 4=Start Left. Note: Watch that the messages do not transition over the images or they will be erased.

Parameter 38
Attribute: Animation Delay
param name = "animationdelay"
Value = X, Where X is the delay time in milliseconds for all animation's. (1000 = 1 Second)
DEFAULT: 0

Parameter 39
Attribute: Animation Jump Size
param name = "jump"
Value = X, Where X is the jump size in pixels for the animation. A value of 1 yields a slow smooth animation, the larger the value the faster the animation however the choppier the effect.
DEFAULT: 1

Sub Menu Descriptions and Formatting

Parameter 40
Attribute: Sub Menu Descriptions
param name = "desc0-0" - "descN-N"
Value = X, Where X is the message that corresponds to the index used to identify an image. (e.g to define the first sub menu message for the first image use "desc0-0", to define the second sub menu message for the first image use "desc0-1", to define the first sub menu message for the second image use "desc1-0", etc.,etc.)

Parameter 41
Attribute: Font Style
param name = "sub_style"
Value = plain, bold, italic, or bolditalic
DEFAULT: plain

Parameter 42
Attribute: Font Size
param name = "sub_size"
Value = X. Where X is the default size of the font for all messages.
DEFAULT: 10

Parameter 43
Attribute: Font
param name = "sub_font"
Value = X. Where X is the name of the font to be used for all messages. (valid Java font names: "Courier", "Helvetica", "TimesRoman", "Dialog", "DialogInput")
DEFAULT: Helvetica

Parameter 44
Attribute: Text Color
param name = "sub_textcolor"
Value = R,G,B. Where R,G,B define the red, green, and blue components of the color as described above.
DEFAULT: Black

Parameter 45
Attribute: Left and Right Margins
param name = "sub_lrmargin"
Value = X, Where X is the left and right margin to use for the sub menu descriptions.

Parameter 46
Attribute: Center or Left Justify Text?
param name = "sub_centertext"
Value = true or false, True = yes, Center Text - False = no, left justify text

Parameter 47
Attribute: Sub Menu Color
param name = "sub_bgcolor"
Value = R,G,B. Where R,G,B defines the red, green, and blue components of the pop up sub menu color.
DEFAULT: Yellow

Parameter 48
Attribute: Sub Menu Outline Color
param name = "sub_outlinecolor"
Value = R,G,B. Where R,G,B defines the red, green, and blue components of the pop up sub menus outline color.
DEFAULT: Black

Parameter 49
Attribute: Sub Menu Highlight Background Color
param name = "sub_hlcolor"
Value = R,G,B. Where R,G,B defines the red, green, and blue components of the pop up sub menus highlighted background color.
DEFAULT: Red

Parameter 50
Attribute: Sub Menu Highlight Text Color
param name = "sub_hltextcolor"
Value = R,G,B. Where R,G,B defines the red, green, and blue components of the pop up sub menus highlighted text color.
DEFAULT: Black

Sub Menu Positioning

Parameter 51
Attribute: Sub Menu X (Horizontal) Offset from the left side of the highlight Image
param name = "menuxoffset0" - "menuxoffsetN"
Value = X, Where X is the x offset from the left edge of the image using the coordinate system described above. A value of 0 would place the sub menu's left border at the left edge of the image.

Parameter 52
Attribute: Sub Menu Y (Vertical) Offset from the top of the highlight Image
param name = "menuyoffset0" - "menuyoffsetN"
Value = X, Where X is the y offset from the top of the image using the coordinate system described above. A value of 0 would place the sub menu's top border at the top edge of the highlight image.

URL Links

Parameter 53
Attribute: Image URL Links
param name = "imagedesturl0" - "imagedesturlN"
value=X, where X is the link for the specific highlight image. URL's can be defined relative to the HTML document containing the applet or fully qualified.

Parameter 54
Attribute: Specific Load Destination Image URL Where?
param name="imageloadwhere0" - "imageloadwhereN"
The "loadwhere" tag specifies where the document specified in the "URL" value should be loaded. The default is "_self". A value equal to the name (case sensitive) of a frame will load the document in that frame.
"_self" show in the current frame
"_parent" show in the parent frame
"_top" show in the top-most frame
"_blank" show in a new unnamed top-level window
"name" show in a new top-level window named name
"frame name" show in the frame named frame name

Note: When targeting a frame location with the name of the frame make certain that the case and names are typed identically. If the applet cannot find the frame the document will be loaded in a new window.

Parameter 55
Attribute: Sub Menu URL Links
param name = "desturl0-0" - "desturlN-N"
value=X, where X is the link for the specific sub menu message. (e.g. to define a link for the first images first sub menu message use "desturl0-0" for the second use "desturl0-1", etc, to define a url link for the third images second sub menu message us "desturl2-1", etc., etc.) URL's can be defined relative to the HTML document containing the applet or fully qualified.

Parameter 56
Attribute: Default Load Destination URL Where?
param name="loadwhere0-0" - "loadwhereN-N"
The "loadwhere" tag specifies where the document specified in the "URL" value should be loaded. The default is "_self". A value equal to the name (case sensitive) of a frame will load the document in that frame.
"_self" show in the current frame
"_parent" show in the parent frame
"_top" show in the top-most frame
"_blank" show in a new unnamed top-level window
"name" show in a new top-level window named name
"frame name" show in the frame named frame name

Note: When targeting a frame location with the name of the frame make certain that the case and names are typed identically. If the applet cannot find the frame the document will be loaded in a new window.

Image Navigator Menu, © 1996, OpenCube Technologies