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

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.link.InlineFrame

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, IRequestListener, ILinkListener

public class InlineFrame
extends WebMarkupContainer
implements ILinkListener

Implementation of an inline frame component. Must be used with an iframe (<iframe src...) element. The src attribute will be generated.

Author:

Sven Meier, Ralf Ebert

See Also:

Serialized Form

Nested Class Summary

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

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

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_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

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

INTERFACE

Constructor Summary

InlineFrame(String id, IPageMap pageMap, Class<C> c)
Constructs an inline frame that instantiates the given Page class when the content of the inline frame is requested.

InlineFrame(String id, IPageMap pageMap, Class<C> c, PageParameters params)
Constructs an inline frame that instantiates the given Page class when the content of the inline frame is requested.

InlineFrame(String id, IPageMap pageMap, IPageLink pageLink)
This constructor is ideal for constructing pages lazily.

InlineFrame(String id, Page page)
This constructor is ideal if a Page object was passed in from a previous Page.

Method Summary

IPageMap	getPageMap() Returns the pageMap.
protected boolean	getStatelessHint() Returns whether the component can be stateless.
protected CharSequence	getURL() Gets the url to use for this link.
protected void	onComponentTag(ComponentTag tag) Handles this frame's tag.
void	onLinkClicked() Called when a link is clicked.

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

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

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, 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, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, 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

InlineFrame

public InlineFrame(String id,
                   IPageMap pageMap,
                   Class<C> c)

Constructs an inline frame that instantiates the given Page class when the content of the inline frame is requested. The instantiated Page is used to render a response to the user.

Type Parameters:

C -

Parameters:

id - See Component

pageMap - the pagemap where the page of the inline frame must be in

c - Page class

InlineFrame

public InlineFrame(String id,
                   IPageMap pageMap,
                   Class<C> c,
                   PageParameters params)

Constructs an inline frame that instantiates the given Page class when the content of the inline frame is requested. The instantiated Page is used to render a response to the user.

Type Parameters:

C -

Parameters:

id - See Component

pageMap - the pagemap where the page of the inline frame must be in

c - Page class

params - Page parameters

InlineFrame

public InlineFrame(String id,
                   Page page)

This constructor is ideal if a Page object was passed in from a previous Page. Construct an inline frame containing the given Page.

Parameters:

id - See component

page - The page

InlineFrame

public InlineFrame(String id,
                   IPageMap pageMap,
                   IPageLink pageLink)

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

Parameters:

id - See Component

pageMap - the pagemap where the page of the inline frame must be in

pageLink - An implementation of IPageLink which will create the page to be contained in the inline frame if and when the content is requested

Method Detail

getURL

protected CharSequence getURL()

Gets the url to use for this link.

Returns:

The URL that this link links to

onComponentTag

protected final void onComponentTag(ComponentTag tag)

Handles this frame's tag.

Overrides:

onComponentTag in class Component

Parameters:

tag - the component tag

See Also:

Component.onComponentTag(ComponentTag)

onLinkClicked

public final void onLinkClicked()

Description copied from interface: ILinkListener

Called when a link is clicked.

Specified by:

onLinkClicked in interface ILinkListener

See Also:

ILinkListener.onLinkClicked()

getPageMap

public final IPageMap getPageMap()

Returns the pageMap.

Returns:

pageMap

getStatelessHint

protected boolean getStatelessHint()

Description copied from class: Component

Returns whether the component can be stateless. Also the component behaviors must be stateless, otherwise the component will be treat as stateful. In order for page to be stateless (and not to be stored in session), all components (and component behaviors) must be stateless.

Overrides:

getStatelessHint in class Component

Returns:

whether the component can be stateless