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

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.link.AbstractLink
                  org.apache.wicket.markup.html.link.Link
                      org.apache.wicket.markup.html.link.PageLink

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IRequestListener, ILinkListener

public class PageLink
extends Link

Links to a given page via an object implementing the IPageLink delayed linking interface. PageLinks can be constructed directly with an IPageLink interface or with a Page Class object. In the latter case, an IPageLink implementation is provided which constructs a Page of the given class when the link is clicked. A default no-args constructor must be available in this case or a WicketRuntimeException will be thrown when Wicket fails to instantiate the class.

Author:

Jonathan Locke

See Also:

IPageLink, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

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

Field Summary

Fields inherited from class org.apache.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 org.apache.wicket.markup.html.link.ILinkListener

INTERFACE

Constructor Summary

PageLink(java.lang.String id, java.lang.Class c)
Constructs a link that instantiates the given Page class when the link is clicked.

PageLink(java.lang.String id, IPageLink pageLink)
This constructor is ideal for constructing pages lazily.

PageLink(java.lang.String id, Page page)
Deprecated. rather than using this class/ constructor, use normal links and call setResponsePage in their onClick methods.

Method Summary

boolean	linksTo(Page page) Returns true if the given page is of the same class as the (delayed) destination of this page link.
void	onClick() Handles a link click by asking for a concrete Page instance through the IPageLink.getPage() delayed linking interface.

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

appendAnchor, getAnchor, getAutoEnable, getOnClickScript, getOnClickScript, getPopupSettings, getStatelessHint, getURL, isEnabled, onComponentTag, onLinkClicked, setAnchor, setAutoEnable, setPopupSettings

Methods inherited from class org.apache.wicket.markup.html.link.AbstractLink

disableLink, getAfterDisabledLink, getBeforeDisabledLink, isLinkEnabled, onBeforeRender, onComponentTagBody, setAfterDisabledLink, setBeforeDisabledLink

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

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

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

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, 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

PageLink

public PageLink(java.lang.String id,
                java.lang.Class c)

Constructs a link that instantiates the given Page class when the link is clicked. The instantiated Page is used to render a response to the user.

Parameters:

id - See Component

c - Page class

PageLink

public PageLink(java.lang.String id,
                IPageLink pageLink)

This constructor is ideal for constructing pages lazily. Constructs a link which invokes the getPage() method of the IPageLink interface when the link is clicked. Whatever Page objects is returned by this method will be rendered back to the user.

Parameters:

id - See Component

pageLink - An implementation of IPageLink which will create the page linked to if and when this hyperlink is clicked at a later time.

PageLink

public PageLink(java.lang.String id,
                Page page)

Deprecated. rather than using this class/ constructor, use normal links and call setResponsePage in their onClick methods.

This constructor is ideal if a Page object was passed in from a previous Page. Construct a link to the Page. Warning: DO NOT use this for constructing links to pages you didn't already have an instance of. This constructor is strongly discouraged for anything other than linking back to the same page.

Parameters:

id - See component

page - The page

Method Detail

linksTo

public boolean linksTo(Page page)

Returns true if the given page is of the same class as the (delayed) destination of this page link.

Overrides:

linksTo in class Link

Parameters:

page - A page

Returns:

True if this link goes to the given page

See Also:

Link.linksTo(org.apache.wicket.Page)

onClick

public void onClick()

Handles a link click by asking for a concrete Page instance through the IPageLink.getPage() delayed linking interface. This call will normally cause the destination page to be created.

Specified by:

onClick in class Link

See Also:

Link.onClick()