Module wicket.bootstrap.core
Class Carousel
java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
de.agilecoders.wicket.core.markup.html.bootstrap.carousel.Carousel
- All Implemented Interfaces:
Serializable,Iterable<Component>,IEventSink,IEventSource,IFeedbackContributor,IConverterLocator,IMetadataContext<Serializable,,Component> IQueueRegion,IHeaderContributor,IRequestableComponent,IHierarchical<Component>,IClusterable
A generic plugin and component for cycling through images (with description and header text)
like a carousel.
- Author:
- miha
- See Also:
-
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
ConstructorsConstructorDescriptionCarousel(String markupId, List<ICarouselImage> images) Construct.Carousel(String markupId, IModel<List<ICarouselImage>> model) Construct. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidfinal Durationprotected ComponentnewDescription(String markupId, ICarouselImage image) creates a new image description elementprotected ComponentnewHeader(String markupId, ICarouselImage image) creates a new image header elementprotected ComponentnewImage(String markupId, ICarouselImage image) creates a new image elementprotected ComponentnewImageList(String wicketId) creates a newICarouselImagelist viewprotected voidprotected voidfinal CarouselsetInterval(Duration interval) The amount of time to delay between automatically cycling an item.Methods inherited from class org.apache.wicket.markup.html.panel.Panel
getRegionMarkup, newMarkupSourcingStrategyMethods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSessionMethods 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, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildrenMethods inherited from class org.apache.wicket.Component
add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, 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, 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, wrapMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.wicket.IQueueRegion
dequeue, newDequeueContextMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
Carousel
Construct.- Parameters:
markupId- the component idimages- the list of images
-
Carousel
Construct.- Parameters:
markupId- the component idmodel- the list of images
-
-
Method Details
-
onInitialize
protected void onInitialize()- Overrides:
onInitializein classMarkupContainer
-
onComponentTag
- Overrides:
onComponentTagin classComponent
-
createPrevLabel
- Returns:
- label of previous button
-
createNextLabel
- Returns:
- label of next button
-
newImageList
creates a newICarouselImagelist view- Parameters:
wicketId- The component id- Returns:
- new list view.
-
newImage
creates a new image element- Parameters:
markupId- the markup id of the headerimage- the current image for this header- Returns:
- new image component
-
newDescription
creates a new image description element- Parameters:
markupId- the markup id of the headerimage- the current image for this header- Returns:
- new description component
-
newHeader
creates a new image header element- Parameters:
markupId- the markup id of the headerimage- the current image for this header- Returns:
- new header component
-
getInterval
- Returns:
- current interval as
Duration
-
setInterval
The amount of time to delay between automatically cycling an item. If Duration.NONE or value is 0, carousel will not automatically cycle.- Parameters:
interval- The duration- Returns:
- this instance for chaining
-
detachModel
protected void detachModel()- Overrides:
detachModelin classComponent
-