Skip to Content

Wiki source code of WOActiveImage

Last modified by Pascal Robert on 2012/02/11 08:52
Show last authors
1 {{toc/}}
2
3 = Introduction =
4
5 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, clicking the image generates a request.
6
7 WOActiveImages are intended to be used outside of an HTML form. WOActiveImage functions as a mapped, active image. When the user clicks in a WOActiveImage, the coordinates of the click are sent back to the server. Depending on where the user clicks, different actions are invoked. An image map file associates actions with each of the defined areas of the image. If an image map file is not specified, the method specified by the action attribute is performed when the image is clicked, or if the href attribute is specified, the image acts as a hyperlink and takes you to that destination.
8
9 Within an HTML form, a WOActiveImage functions as a graphical submit button. However, it is better to use a WOImageButton instead of WOActiveImage to create a graphic submit button or a mapped image within a form.
10
11 = Generated HTML =
12
13 When you use WOActiveImage, it will generate a <img> tag surrounded by a <a href> tag, like this:
14
15 {{code}}
16 <a href="/cgi-bin/WebObjects/DynamicElements.woa/wo/nSZJRma4bnNG7UdGL12KDw/3.1" name="1"><img border="0" ismap="ismap" src="/WebObjects/DynamicElements/WebServerResources/WO.jpeg" width="180" height="180"></a>
17 {{/code}}
18
19 = Usage =
20
21 {{code}}
22
23 WOActiveImage {
24 filename= imageFileName;
25 [framework = frameworkBaseName|"app";] |
26 src=aURL; |
27 value=aMethod;
28 action=aMethod |
29 href=aURL |
30 actionClass=aClass |
31 directActionName=aName; |
32 data=dataObject;
33 mimeType=typeString;
34 [key=cacheKey;]
35 [imageMapFile=aString];
36 [name=aString;]
37 [x=aNumber; y=aNumber;]
38 [target=frameName;]
39 [disabled=aBoolean;]
40 [secure=aBoolean;]...}
41
42 {{/code}}
43
44 = Bindings =
45
46 |(((
47 filename
48 )))|(((
49 Path to the image relative to the WebServerResources directory.
50 )))
51 |(((
52 framework
53 )))|(((
54 Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn't necessary. If the image file is in a framework and the component is in the application, specify the framework's name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.
55 )))
56 |(((
57 src
58 )))|(((
59 URL containing the image data. Use this attribute for complete URLs; for relative URLs use filename instead.
60 )))
61 |(((
62 value
63 )))|(((
64 Image data in the form of a WOElement object. This data can come from a database, a file, or memory.
65 )))
66 |(((
67 action
68 )))|(((
69 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.
70 )))
71 |(((
72 href
73 )))|(((
74 URL to direct the browser to as a default when the image is clicked and no hot zones are hit.
75 )))
76 |(((
77 actionClass
78 )))|(((
79 The name of the class in which the directActionName can be found. Defaults to "DirectAction".
80 )))
81 |(((
82 directActionName
83 )))|(((
84 The direct action method to invoke when the URL is accessed (minus the "Action" suffix). Defaults to "default".
85 )))
86 |(((
87 data
88 )))|(((
89 Specifies an image resource in the form of an NSData; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
90 )))
91 |(((
92 mimeType
93 )))|(((
94 A string designating a MIME resource type, such as "image/gif", to be put in the content-type header field; this type tells the client what to do with data. If you provide data but no MIME type, an exception is thrown.
95 )))
96 |(((
97 key
98 )))|(((
99 A string that the application uses as a key for caching the data specified in data. If you do not provide a key, the data object must be fetched each time it is needed. For further information, see the reference documentation for the WOResourceManager class, (in particular, see the flushDataCache method).
100 )))
101 |(((
102 imageMapFile
103 )))|(((
104 Name of the image map file. See "The Image Map File" (page 17) for more details.
105 )))
106 |(((
107 name
108 )))|(((
109 If name is specified then the hit point is specified as name.x=value; name.y=value; in the form. This is useful when you need to use this element to
110 submit a form to an external URL that expects the hit point to be expressed in a certain format.
111 )))
112 |(((
113 x, y
114 )))|(((
115 If specified, returns the coordinates of the user's click within the image.
116 )))
117 |(((
118 target
119 )))|(((
120 Frame in a frameset that will receive the page returned as a result of the user's click.
121 )))
122 |(((
123 disabled
124 )))|(((
125 If disabled evaluates to true, a regular image element (<IMG>) is generated rather than an active image.
126 )))
127 |(((
128 secure
129 )))|(((
130 Changes the URL prefix from http to https when WebObjects generates URLs for component actions and direct actions for this element. For this attribute to have any effect, you must provide bindings either for the action, directAction, actionClass, or pageName attribute (respecting the valid combinations).
131 )))
132 |(((
133 alt
134 )))|(((
135 Specify a tooltip (string) on the image. It adds the "title" attribute to the generated <a> tag. Project Wonder addition (Wonder will automatically switch to ERXActiveImage if you extend from ERXApplication).
136 )))
137
138 = Examples =
139
140 == Java methods ==
141
142 == WOD-style ==
143
144 {{code/}}
145
146 == Inline bindings (WOOGNL) ==
147
148 Calling a method "doSomething" with an image named "WO.jpeg" coming from the Web server resources:
149
150 {{code}}
151
152 <wo:WOActiveImage action="~doSomething" filename="WO.jpeg" />
153
154 {{/code}}
155
156 Calling a method "doSomething" with an image coming from a NSData object (image stored in a BLOB object from the database):
157
158 {{code}}
159
160 <wo:WOActiveImage action="~doNothing" data="$myEO.imgData" mimeType="image/jpeg" />
161
162 {{/code}}
163
164 = Related documents =
165
166 [[ERXActiveImage>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/extensions/components/_private/ERXActiveImage.html||shape="rect"]]