Module org.apache.wicket.core

Package org.apache.wicket.markup.html.panel

Class Panel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

AbstractFilter, AbstractToolbar, AbstractTree, AjaxEditableLabel, AjaxLazyLoadPanel, AjaxListPanel, BorderPanel, BreadCrumbBar, BreadCrumbPanel, ClientSideImageMap, ColGroup, DataTable, DevUtilsPanel, EmptyPanel, FeedbackPanel, FormComponentFeedbackIndicator, GenericPanel, GoFilter, KittenCaptchaPanel, ModalDialog, Node, NoFilter, PageView, PagingNavigator, RatingPanel, SignInPanel, StyledLinkLabel, Subtree, TabbedPanel, UploadProgressBar, Wizard, WizardButtonBar, WizardStep

public abstract class Panel
extends WebMarkupContainer
implements IQueueRegion

A panel is a reusable component that holds markup and other components.

Whereas WebMarkupContainer is an inline container like

  ...
  <span wicket:id="xxx">
    <span wicket:id="mylabel">My label</span>
    ....
  </span>
  ...
 

a Panel has its own associated markup file and the container content is taken from that file, like:

  <span wicket:id="mypanel"/>
 
  TestPanel.html
  <wicket:panel>
    <span wicket:id="mylabel">My label</span>
    ....
  </wicket:panel>
 

Author:

Jonathan Locke, Juergen Donnerstag

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PANEL

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, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
Panel(String id)
Panel(String id, IModel<?> model)

Method Summary

Modifier and Type	Method	Description
IMarkupFragment	getRegionMarkup()	Returns the markup inside <wicket:panel> tag.
protected IMarkupSourcingStrategy	newMarkupSourcingStrategy()	If Component.getMarkupSourcingStrategy() returns null, this method will be called.

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, 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, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, 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, onAfterRender, onBeforeRender, onComponentTag, 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 org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

PANEL

public static final String PANEL

See Also:

• Constant Field Values

Constructor Details

Panel

public Panel(String id)

See Also:

• Component(String)

Panel

public Panel(String id,
 IModel<?> model)

See Also:

• Component(String, IModel)

Method Details

newMarkupSourcingStrategy

protected IMarkupSourcingStrategy newMarkupSourcingStrategy()

If Component.getMarkupSourcingStrategy() returns null, this method will be called. By default it returns null, which means that a default markup strategy will be attached to the component.

Please note that markup source strategies are not persisted. Instead they get re-created by calling this method again. That's ok since markup sourcing strategies usually do not maintain a state.

Overrides:

newMarkupSourcingStrategy in class Component

Returns:

Markup sourcing strategy

getRegionMarkup

public IMarkupFragment getRegionMarkup()

Returns the markup inside <wicket:panel> tag. If such tag is not found, all the markup is returned.

Specified by:

getRegionMarkup in interface IQueueRegion

Overrides:

getRegionMarkup in class MarkupContainer

Returns:

the markup to use for queuing

See Also:

• IQueueRegion.getRegionMarkup()