public static final class ImageMap.HotSpot
extends java.lang.Object
implements java.io.Serializable
HotSpot
s represent an image map hotspot. For
example (in server-side map format):
rect http://www.biojava.org 0,0 100,20
A user object may be set for each hot spot. This would typically contain extra data used to construct a representation of the hotspot in a document or application. For example, in an image map representing Blast search results the user object could be a sequence in a database. In an HTML document the user object could be used to assign values to actions such as mouseover.
Constructor and Description |
---|
HotSpot(java.lang.String type,
java.net.URL url,
java.lang.Integer[] coordinates)
Creates a new
HotSpot with a null user object. |
HotSpot(java.lang.String type,
java.net.URL url,
java.lang.Integer[] coordinates,
java.lang.Object userObject)
Creates a new
HotSpot . |
Modifier and Type | Method and Description |
---|---|
java.lang.Integer[] |
getCoordinates()
getCoordinates returns the hotspot coordinates. |
java.lang.String |
getType()
getType returns the type of hotspot. |
java.net.URL |
getURL()
getURL returns the hotspot URL. |
java.lang.Object |
getUserObject()
getUserObject returns the current user object
(or null). |
void |
setUserObject(java.lang.Object userObject)
setUserObject sets the user object. |
java.lang.String |
toString() |
public HotSpot(java.lang.String type, java.net.URL url, java.lang.Integer[] coordinates)
HotSpot
with a null user object.type
- a String
of hotspot. The only
valid arguments are ImageMap.RECT, ImageMap.CIRCLE or
ImageMap.POLY (checked by object reference equalty);url
- a URL
target.coordinates
- an Integer []
array of
hotspot coordinates, in order.public HotSpot(java.lang.String type, java.net.URL url, java.lang.Integer[] coordinates, java.lang.Object userObject)
HotSpot
.type
- a String
of hotspot. The only
valid arguments are ImageMap.RECT, ImageMap.CIRCLE or
ImageMap.POLY (checked by object reference equalty);url
- a URL
target.coordinates
- an Integer []
array of
hotspot coordinates, in order.userObject
- an Object
public java.lang.String getType()
getType
returns the type of hotspot.String
.public java.net.URL getURL()
getURL
returns the hotspot URL.URL
.public java.lang.Integer[] getCoordinates()
getCoordinates
returns the hotspot coordinates.Integer []
array.public java.lang.Object getUserObject()
getUserObject
returns the current user object
(or null).Object
.public void setUserObject(java.lang.Object userObject)
setUserObject
sets the user object.userObject
- an Object
.public java.lang.String toString()
toString
in class java.lang.Object