de.agilecoders.wicket.markup.html.bootstrap.carousel

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.markup.html.bootstrap.carousel.Carousel

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class Carousel
extends org.apache.wicket.markup.html.panel.Panel

A generic plugin and component for cycling through images (with description and header text) like a carousel.

Author:

miha

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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
Carousel(String markupId, org.apache.wicket.model.IModel<List<? extends ICarouselImage>> model) Construct.
Carousel(String markupId, List<? extends ICarouselImage> images) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.wicket.model.IModel<String>	createNextLabel()
protected org.apache.wicket.model.IModel<String>	createPrevLabel()
org.apache.wicket.util.time.Duration	getInterval()
protected org.apache.wicket.Component	newDescription(String markupId, ICarouselImage image) creates a new image description element
protected org.apache.wicket.Component	newHeader(String markupId, ICarouselImage image) creates a new image header element
protected org.apache.wicket.Component	newImage(String markupId, ICarouselImage image) creates a new image element
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag)
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
Carousel	setInterval(org.apache.wicket.util.time.Duration interval) The amount of time to delay between automatically cycling an item.

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

newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, 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, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Carousel

public Carousel(String markupId,
        List<? extends ICarouselImage> images)

Construct.

Parameters:

markupId - the component id

images - the list of images

Carousel

public Carousel(String markupId,
        org.apache.wicket.model.IModel<List<? extends ICarouselImage>> model)

Construct.

Parameters:

markupId - the component id

model - the list of images

Method Detail

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)

Overrides:

onComponentTag in class org.apache.wicket.Component

createPrevLabel

protected org.apache.wicket.model.IModel<String> createPrevLabel()

Returns:

label of previous button

createNextLabel

protected org.apache.wicket.model.IModel<String> createNextLabel()

Returns:

label of next button

newImage

protected org.apache.wicket.Component newImage(String markupId,
                                   ICarouselImage image)

creates a new image element

Parameters:

markupId - the markup id of the header

image - the current image for this header

Returns:

new image component

newDescription

protected org.apache.wicket.Component newDescription(String markupId,
                                         ICarouselImage image)

creates a new image description element

Parameters:

markupId - the markup id of the header

image - the current image for this header

Returns:

new description component

newHeader

protected org.apache.wicket.Component newHeader(String markupId,
                                    ICarouselImage image)

creates a new image header element

Parameters:

markupId - the markup id of the header

image - the current image for this header

Returns:

new header component

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

getInterval

public final org.apache.wicket.util.time.Duration getInterval()

Returns:

current interval as Duration

setInterval

public final Carousel setInterval(org.apache.wicket.util.time.Duration interval)

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