Module org.apache.wicket.extensions

Package org.apache.wicket.extensions.breadcrumb.panel

Class BreadCrumbPanel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

org.apache.wicket.extensions.breadcrumb.panel.BreadCrumbPanel

All Implemented Interfaces:

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

public abstract class BreadCrumbPanel
extends Panel
implements IBreadCrumbParticipant

A panel that participates with a bread crumb model. The idea is that you would have a dialog-like component that is much like a wizard, but more decoupled. A typical setup is that you have a panel, where the content is dynamic but hierarchical in nature, and that there are links on the panel that take you deeper into the hierarchy

An example of using bread crumb panels and bread crumb links:

 add(new BreadCrumbLink("myLink", breadCrumbModel)
 {
        protected IBreadCrumbParticipant getParticipant(String componentId)
        {
                return new MyPanel(componentId, breadCrumbModel);
        }
 });
 

where MyPanel is a bread crumb panel and the link is added to another bread crumb panel instance (this). When clicked, MyPanel will replace the panel that the link is placed on, and it will set (and add) MyPanel as the active bread crumb in the bread crumb component model.

Author:

Eelco Hillenius

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

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
BreadCrumbPanel(String id, IBreadCrumbModel breadCrumbModel)	Construct.
BreadCrumbPanel(String id, IBreadCrumbModel breadCrumbModel, IModel<?> model)	Construct.

Method Summary

Modifier and Type	Method	Description
void	activate(IBreadCrumbParticipant participant)	Activates the provided participant, which typically has the effect of replacing this current panel with the one provided - as the participant typically would be a bread crumb panel - and updating the bread crumb model of this panel, pushing the bread crumb for the given participant on top.
void	activate(IBreadCrumbPanelFactory breadCrumbPanelFactory)	Activates the bread crumb panel that is the result of calling the create method of the bread crumb panel factory.
final IBreadCrumbModel	getBreadCrumbModel()	Gets the bread crumb panel.
Component	getComponent()	The participating component == this.
void	onActivate(IBreadCrumbParticipant previous)	Called when the corresponding bread crumb is activated.
final void	setBreadCrumbModel(IBreadCrumbModel breadCrumbModel)	Sets the bread crumb panel.

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

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.extensions.breadcrumb.IBreadCrumbParticipant

getTitle

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

BreadCrumbPanel

public BreadCrumbPanel(String id,
 IBreadCrumbModel breadCrumbModel)

Construct.

Parameters:

id - Component id

breadCrumbModel - The bread crumb model

BreadCrumbPanel

public BreadCrumbPanel(String id,
 IBreadCrumbModel breadCrumbModel,
 IModel<?> model)

Construct.

Parameters:

id - Component id

breadCrumbModel - The bread crumb model

model - The model

Method Details

activate

public void activate(IBreadCrumbPanelFactory breadCrumbPanelFactory)

Activates the bread crumb panel that is the result of calling the create method of the bread crumb panel factory.

Parameters:

breadCrumbPanelFactory -

activate

public void activate(IBreadCrumbParticipant participant)

Activates the provided participant, which typically has the effect of replacing this current panel with the one provided - as the participant typically would be a bread crumb panel - and updating the bread crumb model of this panel, pushing the bread crumb for the given participant on top.

Parameters:

participant - The participant to set as the active one

getBreadCrumbModel

public final IBreadCrumbModel getBreadCrumbModel()

Gets the bread crumb panel.

Returns:

The bread crumb panel

getComponent

public Component getComponent()

The participating component == this.

Specified by:

getComponent in interface IBreadCrumbParticipant

Returns:

The participating component, must return a non-null value

See Also:

• IBreadCrumbParticipant.getComponent()

onActivate

public void onActivate(IBreadCrumbParticipant previous)

Description copied from interface: IBreadCrumbParticipant

Called when the corresponding bread crumb is activated.

Specified by:

onActivate in interface IBreadCrumbParticipant

Parameters:

previous - The previously active bread crumb participant, possibly null

See Also:

• IBreadCrumbParticipant.onActivate(org.apache.wicket.extensions.breadcrumb.IBreadCrumbParticipant)

setBreadCrumbModel

public final void setBreadCrumbModel(IBreadCrumbModel breadCrumbModel)

Sets the bread crumb panel.

Parameters:

breadCrumbModel - The bread crumb panel