com.premiumminds.webapp.wicket.bootstrap

Class BootstrapPaginator

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<T>

org.apache.wicket.markup.html.form.FormComponentPanel<Integer>

com.premiumminds.webapp.wicket.bootstrap.BootstrapPaginator

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<Integer,org.apache.wicket.markup.html.form.FormComponent<Integer>>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>, 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 abstract class BootstrapPaginator
extends org.apache.wicket.markup.html.form.FormComponentPanel<Integer>

This component creates a paginator component using the bootstrap pagination element.

Example:

 <nav>
   <ul wicket:id="paginator" class="pagination"></ul>
 </nav>
 

The related Java code:

 new BootstrapPaginator("paginator", Model.of(2000)) {
     public void onPageChange(AjaxRequestTarget target, IModel<Integer> page) {
        ...
     }
 }
 

Author:

acamilo

See Also:

bootstrap pagination, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

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

Constructor Summary

Constructors

Constructor and Description
BootstrapPaginator(String id, org.apache.wicket.model.IModel<Integer> totalResults) Creates a paginator with 20 results per page by default
BootstrapPaginator(String id, org.apache.wicket.model.IModel<Integer> totalResults, int resultsPerPage) Creates a paginator

Method Summary

Modifier and Type	Method and Description
int	getCurrentIndex() Get the first first index for the current page
int	getNumberResultsPerPage() Get the number of results per page that the paginator uses to calculate how many pages should exist
int	getPagesToShow() Return the number of pages to show on the pagination component
int	getTotalPages() Get the total of pages shown
org.apache.wicket.model.IModel<Integer>	getTotalResults() Get the model with the total number of results
boolean	isHiddenFirstButton() Return if the goto first page button is hidden when it's not needed
boolean	isHiddenLastButton() Return if the goto last page button is hidden when it's not needed
boolean	isHiddenNextButton() Return if the goto next page button is hidden when it's not needed
boolean	isHiddenPreviousButton() Return if the goto previous page button is hidden when it's not needed
boolean	isShowFirstButton() Return if the goto first page button is shown
boolean	isShowLastButton() Return if the goto last page button is shown
boolean	isShowNextButton() Return if the goto next page button is shown
boolean	isShowPreviousButton() Return if the goto previous page button is shown
abstract void	onPageChange(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.model.IModel<Integer> page) This method is called every time the current page changes
void	setHiddenFirstButton(boolean hiddenFirstButton) Sets if the goto first page button should be hidden when it's not needed
void	setHiddenLastButton(boolean hiddenLastButton) Sets if the goto last page button should be hidden when it's not needed
void	setHiddenNextButton(boolean hiddenNextButton) Sets if the goto next page button should be hidden when it's not needed
void	setHiddenPreviousButton(boolean hiddenPreviousButton) Sets if the goto previous page button should be hidden when it's not needed
void	setNumberResultsPerPage(int numberResultsPerPage) Set the number of results per page that the paginator uses to calculate how many pages should exist
void	setPagesToShow(int pagesToShow) Sets the number of pages to show on the pagination component
void	setShowFirstButton(boolean showFirstButton) Sets whether to show the goto first page option
void	setShowLastButton(boolean showLastButton) Sets whether to show the goto last page option
void	setShowNextButton(boolean showNextButton) Sets whether to show the goto next page option
void	setShowPreviousButton(boolean showPreviousButton) Sets whether to show the goto previous page option
void	setTotalResults(org.apache.wicket.model.IModel<Integer> totalResults) Set the model with the total number of results

Methods inherited from class org.apache.wicket.markup.html.form.FormComponentPanel

checkRequired, clearInput, newMarkupSourcingStrategy, onComponentTag

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel

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, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, 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, 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, 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, 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, getRegionMarkup, newDequeueContext

Methods inherited from interface org.apache.wicket.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BootstrapPaginator

public BootstrapPaginator(String id,
                          org.apache.wicket.model.IModel<Integer> totalResults)

Creates a paginator with 20 results per page by default

Parameters:

id - component id

totalResults - model for total results

BootstrapPaginator

public BootstrapPaginator(String id,
                          org.apache.wicket.model.IModel<Integer> totalResults,
                          int resultsPerPage)

Creates a paginator

Parameters:

id - component id

totalResults - model for total results

resultsPerPage - number of results per page

Method Detail

isShowFirstButton

public boolean isShowFirstButton()

Return if the goto first page button is shown

Returns:

true if the goto first page button is shown

setShowFirstButton

public void setShowFirstButton(boolean showFirstButton)

Sets whether to show the goto first page option

Parameters:

showFirstButton - whether to show the goto first page option

isShowLastButton

public boolean isShowLastButton()

Return if the goto last page button is shown

Returns:

true if the goto last page button is shown

setShowLastButton

public void setShowLastButton(boolean showLastButton)

Sets whether to show the goto last page option

Parameters:

showLastButton - if true show the goto last page option

isShowNextButton

public boolean isShowNextButton()

Return if the goto next page button is shown

Returns:

true if the goto next page button is shown

setShowNextButton

public void setShowNextButton(boolean showNextButton)

Sets whether to show the goto next page option

Parameters:

showNextButton - whether to show the goto next page option

isShowPreviousButton

public boolean isShowPreviousButton()

Return if the goto previous page button is shown

Returns:

true if the goto previous page button is shown

setShowPreviousButton

public void setShowPreviousButton(boolean showPreviousButton)

Sets whether to show the goto previous page option

Parameters:

showPreviousButton - whether to show the goto previous page option

getPagesToShow

public int getPagesToShow()

Return the number of pages to show on the pagination component

Returns:

integer with the number of pages to show on the pagination component

setPagesToShow

public void setPagesToShow(int pagesToShow)

Sets the number of pages to show on the pagination component

Parameters:

pagesToShow - number of pages to show on the pagination component

getTotalPages

public int getTotalPages()

Get the total of pages shown

Returns:

totalResults / numberOfResultsPerPage

isHiddenFirstButton

public boolean isHiddenFirstButton()

Return if the goto first page button is hidden when it's not needed

Returns:

true if the goto first page button is hidden when it's not needed

setHiddenFirstButton

public void setHiddenFirstButton(boolean hiddenFirstButton)

Sets if the goto first page button should be hidden when it's not needed

Parameters:

hiddenFirstButton - if the goto first page button should be hidden when it's not needed

isHiddenLastButton

public boolean isHiddenLastButton()

Return if the goto last page button is hidden when it's not needed

Returns:

true if the goto last page button is hidden when it's not needed

setHiddenLastButton

public void setHiddenLastButton(boolean hiddenLastButton)

Sets if the goto last page button should be hidden when it's not needed

Parameters:

hiddenLastButton - if the goto last page button should be hidden when it's not needed

isHiddenPreviousButton

public boolean isHiddenPreviousButton()

Return if the goto previous page button is hidden when it's not needed

Returns:

true if the goto previous page button is hidden when it's not needed

setHiddenPreviousButton

public void setHiddenPreviousButton(boolean hiddenPreviousButton)

Sets if the goto previous page button should be hidden when it's not needed

Parameters:

hiddenPreviousButton - if the goto previous page button should be hidden when it's not needed

isHiddenNextButton

public boolean isHiddenNextButton()

Return if the goto next page button is hidden when it's not needed

Returns:

true if the goto next page button is hidden when it's not needed

setHiddenNextButton

public void setHiddenNextButton(boolean hiddenNextButton)

Sets if the goto next page button should be hidden when it's not needed

Parameters:

hiddenNextButton - if the goto next page button should be hidden when it's not needed

onPageChange

public abstract void onPageChange(org.apache.wicket.ajax.AjaxRequestTarget target,
                                  org.apache.wicket.model.IModel<Integer> page)

This method is called every time the current page changes

Parameters:

target - ajax target (paginator was already added)

page - the new current page

getTotalResults

public org.apache.wicket.model.IModel<Integer> getTotalResults()

Get the model with the total number of results

Returns:

model with number of results

setTotalResults

public void setTotalResults(org.apache.wicket.model.IModel<Integer> totalResults)

Set the model with the total number of results

Parameters:

totalResults - model with the number of results

getNumberResultsPerPage

public int getNumberResultsPerPage()

Get the number of results per page that the paginator uses to calculate how many pages should exist

Returns:

number of results per page

setNumberResultsPerPage

public void setNumberResultsPerPage(int numberResultsPerPage)

Set the number of results per page that the paginator uses to calculate how many pages should exist

Parameters:

numberResultsPerPage - number of results per page

getCurrentIndex

public int getCurrentIndex()

Get the first first index for the current page

Returns:

page * numberOfResultsPerPage