Package 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:

java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<java.io.Serializable,Component>, IRequestListener, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public class InlineFrame
extends WebMarkupContainer
implements IRequestListener

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

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
InlineFrame(java.lang.String id, java.lang.Class<C> c)	Constructs an inline frame that instantiates the given Page class when the content of the inline frame is requested.
InlineFrame(java.lang.String id, java.lang.Class<C> c, org.apache.wicket.request.mapper.parameter.PageParameters params)	Constructs an inline frame that instantiates the given Page class when the content of the inline frame is requested.
InlineFrame(java.lang.String id, IPageProvider pageProvider)	This constructor is ideal for constructing pages lazily.
InlineFrame(java.lang.String id, Page page)	This constructor is ideal if a Page object was passed in from a previous Page.

Method Summary

Modifier and Type	Method	Description
protected boolean	getStatelessHint()	Returns whether the component can be stateless.
protected java.lang.CharSequence	getURL()	Gets the url to use for this link.
protected void	onComponentTag(ComponentTag tag)	Handles this frame's tag.
void	onRequest()	Called when a request is received.
boolean	rendersPage()	Does invocation of this listener render the page.

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, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, 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, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, 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, newMarkupSourcingStrategy, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

InlineFrame

public InlineFrame(java.lang.String id,
                   java.lang.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

c - Page class

InlineFrame

public InlineFrame(java.lang.String id,
                   java.lang.Class<C> c,
                   org.apache.wicket.request.mapper.parameter.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

c - Page class

params - Page parameters

InlineFrame

public InlineFrame(java.lang.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(java.lang.String id,
                   IPageProvider pageProvider)

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

pageProvider - the provider of the page to be contained in the inline frame if and when the content is requested

Method Detail

getURL

protected java.lang.CharSequence getURL()

Gets the url to use for this link.

Returns:

The URL that this link links to

onComponentTag

protected void onComponentTag(ComponentTag tag)

Handles this frame's tag.

Overrides:

onComponentTag in class Component

Parameters:

tag - the component tag

See Also:

Component.onComponentTag(ComponentTag)

rendersPage

public boolean rendersPage()

Description copied from interface: IRequestListener

Does invocation of this listener render the page.

Specified by:

rendersPage in interface IRequestListener

Returns:

default true, i.e. a RenderPageRequestHandler is schedules after invocation

onRequest

public final void onRequest()

Description copied from interface: IRequestListener

Called when a request is received.

Specified by:

onRequest in interface IRequestListener

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