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

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  extended by org.apache.wicket.markup.html.panel.Panel
                      extended by org.apache.wicket.markup.html.link.ClientSideImageMap
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IHeaderContributor, IMarkupCacheKeyProvider, IMarkupResourceStreamProvider, IRequestableComponent, IHierarchical<Component>

public class ClientSideImageMap
extends Panel
implements IMarkupResourceStreamProvider, IMarkupCacheKeyProvider

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_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PATH_SEPARATOR, RENDER
 
Constructor Summary
ClientSideImageMap(java.lang.String id, Image image)
          Constructs a client-side image map which is "attached" to the given Image component.
 
Method Summary
 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, java.awt.Shape shape)
          Adds an area defined by a shape object.
 java.lang.String getCacheKey(MarkupContainer markupContainer, java.lang.Class<?> aClass)
          Provide the markup cache key for the associated Markup resource stream.
 IResourceStream getMarkupResourceStream(MarkupContainer markupContainer, java.lang.Class<?> c)
          Create a new markup resource stream for the container.
 
Methods inherited from class org.apache.wicket.markup.html.panel.Panel
getMarkup, onComponentTag, onComponentTagBody
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
findMarkupInAssociatedFileHeader, renderHead, renderHeadFromAssociatedMarkupFile
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getWebPage, getWebRequest
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupStream, getMarkupType, hasAssociatedMarkup, internalAdd, iterator, iterator, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClientSideImageMap

public ClientSideImageMap(java.lang.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

getCacheKey

public java.lang.String getCacheKey(MarkupContainer markupContainer,
                                    java.lang.Class<?> aClass)
Description copied from interface: IMarkupCacheKeyProvider
Provide the markup cache key for the associated Markup resource stream.

Specified by:
getCacheKey in interface IMarkupCacheKeyProvider
Parameters:
markupContainer - The MarkupContainer object requesting the markup cache key
aClass - The container the markup should be associated with
Returns:
A IResourceStream if the resource was found
See Also:
IMarkupResourceStreamProvider

getMarkupResourceStream

public IResourceStream getMarkupResourceStream(MarkupContainer markupContainer,
                                               java.lang.Class<?> c)
Description copied from interface: IMarkupResourceStreamProvider
Create a new markup resource stream for the container.

Note: usually it will only called once, as the IResourceStream will be cached by MarkupCache.

Specified by:
getMarkupResourceStream in interface IMarkupResourceStreamProvider
Parameters:
markupContainer - The MarkupContainer which requests to load the Markup resource stream
c - The container the markup should be associated with
Returns:
A IResourceStream if the resource was found

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,
                                       java.awt.Shape shape)
Adds an area defined by a shape object.

Parameters:
link - the link
shape - the shape
Returns:
this


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.