Package org.apache.wicket.markup.html.link

Class ClientSideImageMap

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.apache.wicket.markup.html.link.ClientSideImageMap

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class ClientSideImageMap
extends Panel

A client-side image map implementation which allows you to "attach" the map to any existing Image component.

Since:

1.5

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
ClientSideImageMap(String id, Image image)	Constructs a client-side image map which is "attached" to the given Image component.

Method Summary

Modifier and Type	Method	Description
ClientSideImageMap	addCircleArea(AbstractLink link, int x, int y, int radius)	Adds a circle-shaped area centered at (x,y) with radius r.
ClientSideImageMap	addPolygonArea(AbstractLink link, int... coordinates)	Adds a polygon-shaped area defined by coordinates.
ClientSideImageMap	addRectangleArea(AbstractLink link, int x1, int y1, int x2, int y2)	Adds a rectangular-shaped area.
ClientSideImageMap	addShapeArea(AbstractLink link, Shape shape)	Adds an area defined by a shape object.
String	newChildId()	Generates a unique id string.
protected void	onComponentTag(ComponentTag tag)	Processes the component tag.

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ClientSideImageMap

public ClientSideImageMap(String id,
                          Image image)

Constructs a client-side image map which is "attached" to the given Image component.

Parameters:

id - the component id

image - the image component

Method Detail

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class Component

Parameters:

tag - Tag to modify

newChildId

public String newChildId()

Generates a unique id string. This makes it easy to add items to be rendered w/out having to worry about generating unique id strings in your code.

Returns:

unique child id

addCircleArea

public ClientSideImageMap addCircleArea(AbstractLink link,
                                        int x,
                                        int y,
                                        int radius)

Adds a circle-shaped area centered at (x,y) with radius r.

Parameters:

link - the link

x - x coordinate of the center of the circle

y - y coordinate of center

radius - the radius

Returns:

this

addPolygonArea

public ClientSideImageMap addPolygonArea(AbstractLink link,
                                         int... coordinates)

Adds a polygon-shaped area defined by coordinates.

Parameters:

link - the link

coordinates - the coordinates for the polygon

Returns:

This

addRectangleArea

public ClientSideImageMap addRectangleArea(AbstractLink link,
                                           int x1,
                                           int y1,
                                           int x2,
                                           int y2)

Adds a rectangular-shaped area.

Parameters:

link - the link

x1 - top left x

y1 - top left y

x2 - bottom right x

y2 - bottom right y

Returns:

this

addShapeArea

public ClientSideImageMap addShapeArea(AbstractLink link,
                                       Shape shape)

Adds an area defined by a shape object.

Parameters:

link - the link

shape - the shape

Returns:

this