WOActiveImage
Synopsis
WOActiveImage{src=aURL |
value=aMethod;
action=aMethod |
href=aURL;
[imageMapFile=aString;]
[name=aString;]
[x=aNumber; y=aNumber;]
[target=frameName;]
[disabled=YES|NO;] ...};
Description
A WOActiveImage displays an image within the HTML page. If the WOActiveImage is disabled, it simply displays its image as a passive element in the page. If enabled, the image is active, that is, when the user clicks the image, another page is displayed.
Within an HTML form, a WOActiveImage functions as a graphical submit button. Outside an HTML form, a WOActiveImage functions as a mapped, active image. When the user clicks such a WOActiveImage, the coordinates of the click are sent back to the server. Depending on where the user click, different actions can be invoked. An image map file associates actions with each of the defined areas of the image.
- src
-
The URL for the image data. The source can be statically specified in the declaration file or it can be returned as the result of a method invocation.
- value
-
The source for the image data. This data can come from a database, a file, or memory
- action
-
The method to invoke when this element is clicked. If imageMapFile is specified, action is only invoked if the click is outside any mapped area. In other words, action defines the default action of the active image.
- href
-
The URL to direct the browser to as a default when the image is clicked and no hotzones are hit.
- imageMapFile
-
The name of the image map file.
- name
-
If name is specified then the hit point is specified as name.x=value; name.y=value; in the form. This is useful for people who want to use imagemap to submit a form to an external URL which expects the hit point to be a certain format.
- x, y
-
If specified, returns the coordinates of the user's click within the image.
- target
-
Specifies the frame in a frameset that will receive the page returned as a result of the user's click. Optional Field.
- disabled
-
If YES, a regular image element "<IMG>" is generated,rather than an active image.
The Image Map File
If imageMapFile is specified, WebObjects searches for the file within the component bundle (Component.wo/). If it isn't found there, WebObjects searches the application directory (MyApplication/).
Each line in the image map file has this format:
shape action coordinate-list
- shape
-
Either 'rect' or 'circle' (polygon not yet supported). For 'rect' shape, the coordinates x1,y1 specify the upper-left corner of the hot zone, and x2,y2 specify lower right corner. For 'circle' shape, the x1,y1 is the origin, and x2,y2 is
a point on the circle.
- action
-
The name of the method to invoke.
- coordinate-list
-
x1,y1 x2,y2 ...
Here's an example of an image map file:
rect home 0,0 135,56
rect buy 135,0 270,56
Examples