Module org.apache.wicket.extensions

Package org.apache.wicket.extensions.breadcrumb

Class BreadCrumbBar.BreadCrumbsListView

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.repeater.AbstractRepeater

org.apache.wicket.markup.html.list.ListView<IBreadCrumbParticipant>

org.apache.wicket.extensions.breadcrumb.BreadCrumbBar.BreadCrumbsListView

All Implemented Interfaces:

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

Enclosing class:

BreadCrumbBar

protected class BreadCrumbBar.BreadCrumbsListView
extends ListView<IBreadCrumbParticipant>
implements IBreadCrumbModelListener

List view for rendering the bread crumbs.

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

Constructor Summary

Constructors

Constructor	Description
BreadCrumbsListView(String id)	Construct.

Method Summary

Modifier and Type	Method	Description
void	breadCrumbActivated(IBreadCrumbParticipant previousParticipant, IBreadCrumbParticipant breadCrumbParticipant)	Called when a bread crumb was activated.
void	breadCrumbAdded(IBreadCrumbParticipant breadCrumbParticipant)	Called when a bread crumb was added to the model.
void	breadCrumbRemoved(IBreadCrumbParticipant breadCrumbParticipant)	Called when a bread crumb was removed from the model.
protected void	onBeforeRender()	Called on all visible components before any component is rendered.
protected void	populateItem(ListItem<IBreadCrumbParticipant> item)	Populate a given item.

Methods inherited from class org.apache.wicket.markup.html.list.ListView

getList, getListItemModel, getModel, getModelObject, getReuseItems, getStartIndex, getViewSize, moveDownLink, moveUpLink, newItem, onBeginPopulateItem, onPopulate, removeLink, renderChild, renderItem, renderIterator, setList, setModel, setModelObject, setReuseItems, setStartIndex, setViewSize

Methods inherited from class org.apache.wicket.markup.repeater.AbstractRepeater

dequeue, getMarkup, onRender

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, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, 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, newMarkupSourcingStrategy, onAfterRender, 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 java.lang.Iterable

forEach, spliterator

Constructor Details

BreadCrumbsListView

public BreadCrumbsListView(String id)

Construct.

Parameters:

id - Component id

Method Details

breadCrumbActivated

public void breadCrumbActivated(IBreadCrumbParticipant previousParticipant,
 IBreadCrumbParticipant breadCrumbParticipant)

Description copied from interface: IBreadCrumbModelListener

Called when a bread crumb was activated.

Specified by:

breadCrumbActivated in interface IBreadCrumbModelListener

Parameters:

previousParticipant - The previously active participant

breadCrumbParticipant - The bread crumb that was activated.

breadCrumbAdded

public void breadCrumbAdded(IBreadCrumbParticipant breadCrumbParticipant)

Description copied from interface: IBreadCrumbModelListener

Called when a bread crumb was added to the model.

Specified by:

breadCrumbAdded in interface IBreadCrumbModelListener

Parameters:

breadCrumbParticipant - The new bread crumb

breadCrumbRemoved

public void breadCrumbRemoved(IBreadCrumbParticipant breadCrumbParticipant)

Description copied from interface: IBreadCrumbModelListener

Called when a bread crumb was removed from the model.

Specified by:

breadCrumbRemoved in interface IBreadCrumbModelListener

Parameters:

breadCrumbParticipant - The bread crumb that was removed

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called on all visible components before any component is rendered.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Changes to the component tree can be made only before calling super.onBeforeRender().

Overrides:

onBeforeRender in class AbstractRepeater

See Also:

• AbstractRepeater.onBeforeRender()

populateItem

protected void populateItem(ListItem<IBreadCrumbParticipant> item)

Description copied from class: ListView

Populate a given item.

be careful to add any components to the list item. So, don't do:

 add(new Label("foo", "bar"));
 

but:

 item.add(new Label("foo", "bar"));
 

Specified by:

populateItem in class ListView<IBreadCrumbParticipant>

Parameters:

item - The item to populate