wicket.markup.html.link
Class BookmarkablePageLink

java.lang.Object
  wicket.Component
      wicket.MarkupContainer
          wicket.markup.html.WebMarkupContainer
              wicket.markup.html.link.Link
                  wicket.markup.html.link.BookmarkablePageLink

All Implemented Interfaces:

java.io.Serializable, IRequestListener, ILinkListener

Direct Known Subclasses:

AutoLinkResolver.AutolinkBookmarkablePageLink

public class BookmarkablePageLink
extends Link

Renders a stable link which can be cached in a web browser and used at a later time.

Author:

Jonathan Locke

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange

Field Summary

Fields inherited from class wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Fields inherited from interface wicket.markup.html.link.ILinkListener

INTERFACE

Constructor Summary

BookmarkablePageLink(java.lang.String id, java.lang.Class pageClass)
Constructor.

BookmarkablePageLink(java.lang.String id, java.lang.Class pageClass, PageParameters parameters)
Constructor.

Method Summary

java.lang.Class	getPageClass() Get tge page class registered with the link
PageMap	getPageMap()
protected java.lang.CharSequence	getURL() Gets the url to use for this link.
boolean	linksTo(Page page) Whether this link refers to the given page.
void	onClick() THIS METHOD IS NOT USED! Bookmarkable links do not have a click handler.
BookmarkablePageLink	setPageMap(PageMap pageMap)
BookmarkablePageLink	setParameter(java.lang.String property, int value) Adds a given page property value to this link.
BookmarkablePageLink	setParameter(java.lang.String property, long value) Adds a given page property value to this link.
BookmarkablePageLink	setParameter(java.lang.String property, java.lang.String value) Adds a given page property value to this link.

Methods inherited from class wicket.markup.html.link.Link

appendAnchor, getAfterDisabledLink, getAnchor, getAutoEnable, getBeforeDisabledLink, getOnClickScript, getOnClickScript, getPopupSettings, internalOnAttach, isEnabled, onComponentTag, onComponentTagBody, onLinkClicked, setAfterDisabledLink, setAnchor, setAutoEnable, setBeforeDisabledLink, setPopupSettings

Methods inherited from class wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage

Methods inherited from class wicket.MarkupContainer

add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class wicket.Component

add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, renderHead, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkablePageLink

public BookmarkablePageLink(java.lang.String id,
                            java.lang.Class pageClass)

Constructor.

Parameters:

id - The name of this component

pageClass - The class of page to link to

BookmarkablePageLink

public BookmarkablePageLink(java.lang.String id,
                            java.lang.Class pageClass,
                            PageParameters parameters)

Constructor.

Parameters:

id - See Component

pageClass - The class of page to link to

parameters - The parameters to pass to the new page when the link is clicked

Method Detail

getPageClass

public final java.lang.Class getPageClass()

Get tge page class registered with the link

Returns:

Page class

getPageMap

public final PageMap getPageMap()

Returns:

Page map for this link

linksTo

public boolean linksTo(Page page)

Whether this link refers to the given page.

Overrides:

linksTo in class Link

Parameters:

page - the page

Returns:

True if this link goes to the given page

See Also:

Link.linksTo(wicket.Page)

onClick

public final void onClick()

THIS METHOD IS NOT USED! Bookmarkable links do not have a click handler. It is here to satisfy the interface only, as bookmarkable links will be dispatched by the handling servlet.

Specified by:

onClick in class Link

See Also:

Link.onClick()

setPageMap

public final BookmarkablePageLink setPageMap(PageMap pageMap)

Parameters:

pageMap - The pagemap for this link's destination

Returns:

This

setParameter

public BookmarkablePageLink setParameter(java.lang.String property,
                                         int value)

Adds a given page property value to this link.

Parameters:

property - The property

value - The value

Returns:

This

setParameter

public BookmarkablePageLink setParameter(java.lang.String property,
                                         long value)

Adds a given page property value to this link.

Parameters:

property - The property

value - The value

Returns:

This

setParameter

public BookmarkablePageLink setParameter(java.lang.String property,
                                         java.lang.String value)

Adds a given page property value to this link.

Parameters:

property - The property

value - The value

Returns:

This

getURL

protected java.lang.CharSequence getURL()

Gets the url to use for this link.

Overrides:

getURL in class Link

Returns:

The URL that this link links to

See Also:

Link.getURL()