com.actimind.actiwate.testing.html.objects
Interface ImageMap

All Superinterfaces:

BaseElement, com.actimind.actiwate.testing.logging.Loggable

public interface ImageMap

extends BaseElement

Represents an HTML map element

Method Summary

Area	area(int idx) Returns an area by index.
Area	area(java.lang.String nameOrId) Searches for an area with specified name or id.
Area	areaByAlt(java.lang.String alt) Searches for an area with specified alternative description.
Area	areaByShape(java.lang.String shape, int idx) Searches for an area with specified value of 'shape' attribute.
Area	areaByTitle(java.lang.String title) Searches for an area with specified title.
Area[]	areas() Returns map's areas.
Area[]	areasByShape(java.lang.String shape) Returns map areas with specificed shape attribute.
Image	getMappedImage() Returns Image object representing HTML image having reference to this map.
Image[]	getMappedImages() Returns array of Image objects representing HTML images having references to this map.
java.lang.String	name() Return name attribute of this map

Methods inherited from interface com.actimind.actiwate.testing.html.objects.BaseElement

element, id

Methods inherited from interface com.actimind.actiwate.testing.logging.Loggable

getLogDesc

Method Detail

areas

public Area[] areas()

Returns map's areas. If map doesn't contain areas then empty array is returned.

Returns:

an array of areas within this map.

area

public Area area(int idx)
          throws LookupException

Returns an area by index. Index starts from zero.

Parameters:

idx - index of an area in this map, starting from zero

Returns:

area by idx

Throws:

LookupException - if area does not exist

area

public Area area(java.lang.String nameOrId)
          throws LookupException

Searches for an area with specified name or id.

Parameters:

nameOrId - name or id of an area

Returns:

Area object for the first found area

Throws:

LookupException - if area was not found

areaByAlt

public Area areaByAlt(java.lang.String alt)
               throws LookupException

Searches for an area with specified alternative description. The 'alt' attribute of an Area is normilized before the comparison.

Parameters:

alt - alternative description of an area

Returns:

Area object for the first found area

Throws:

LookupException - if area was not found

areaByTitle

public Area areaByTitle(java.lang.String title)
                 throws LookupException

Searches for an area with specified title. The 'title' attribute of an Area is normilized before the comparison.

Parameters:

title - area title

Returns:

Area object for the first found area

Throws:

LookupException - if area was not found

areaByShape

public Area areaByShape(java.lang.String shape,
                        int idx)
                 throws LookupException

Searches for an area with specified value of 'shape' attribute.

Parameters:

shape - area shape

idx - index of area with specificed shape

Returns:

Area object with specificed shape and index

Throws:

LookupException - if area was not found

areasByShape

public Area[] areasByShape(java.lang.String shape)

Returns map areas with specificed shape attribute. If no area found then empty array is returned.

Parameters:

shape - area shape attribute

Returns:

array of area object with specificed shape

getMappedImages

public Image[] getMappedImages()

Returns array of Image objects representing HTML images having references to this map. If no images found then empty array returned.

Returns:

array of images referencing this map

getMappedImage

public Image getMappedImage()
                     throws LookupException

Returns Image object representing HTML image having reference to this map. If this map is referenced by several images then only first one is returned.

Returns:

array of images referencing this map

Throws:

LookupException - if no images found.

name

public java.lang.String name()

Return name attribute of this map