er.extensions.batching

Class ERXFlickrBatchNavigation

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.batching.ERXFlickrBatchNavigation

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, Serializable, Cloneable

Direct Known Subclasses:

AjaxFlickrBatchNavigation

public class ERXFlickrBatchNavigation
extends ERXComponent

ERXFlickrBatchNavigation is a batch navigation component that provides pagination that behaves like the paginator on Flickr.com.

Include ERXFlickrBatchNavigation.css in ERExtensions for a default stylesheet that looks (very) similar to Flickr.

Can also be used for pagination on the parent component, where the objects being paginated may be POJOs in an array, or where paging all the objects in the allObjects array is not feasible due to memory requirements.

See Also:

Serialized Form

Author:

mschrag, rob, cug (non displayGroup batching)

Bindings

Name	Description
displayGroup	the display group to paginate
displayName	the name of the items that are being display ("photo", "bug", etc)
showPageRange	if true, the range of items on the page is shown, for example "(1-7 of 200 items)"
showBatchSizes	if true, a menu to change the items per page is shown "Show: (10) 20 (100) (All) items per page"
batchSizes	can be either a string or an NSArray of numbers that define the batch sizes to chose from. The number "0" provides an "All" items batch size. For example "10,20,30" or "10,50,100,0"
small	if true, a compressed page count style is used
parentActionName	(if you don't provide a displayGroup) the action to be executed on the parent component to get the next batch of items.
currentBatchIndex	(if you don't provide a displayGroup) used to get and set on the parent component the selected page index
maxNumberOfObjects	(if you don't provide a displayGroup) used to get the total number of objects that are being paginated.
numberOfObjectsPerBatch	(if you don't provide a displayGroup) the number of objects per batch (page)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXFlickrBatchNavigation.PageNumber

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.MapImplementation, com.webobjects.foundation.NSKeyValueCoding.Null<T>, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
Integer	currentBatchSize

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERXFlickrBatchNavigation(com.webobjects.appserver.WOContext context)

Method Summary

Modifier and Type	Method and Description
protected void	addEllipsis()
protected void	addPageNumbers(int startIndex, int endIndex)
int	batchCount()
int	batchSize()
int	currentBatchIndex()
String	currentBatchSizeString()
WODisplayGroup	displayGroup()
String	displayName()
Integer	displayNameCount()
int	firstIndex()
boolean	hasMultiplePages()
boolean	hasNextPage()
boolean	hasPreviousPage()
boolean	isCurrentBatchSizeSelected()
boolean	isCurrentPageNumber()
int	lastIndex()
int	maxNumberOfObjects()
com.webobjects.appserver.WOActionResults	nextPage()
int	numberOfObjectsPerBatch()
NSArray	objects()
NSArray<ERXFlickrBatchNavigation.PageNumber>	pageNumbers()
String	parentActionName()
NSArray<? extends Number>	possibleBatchSizes()
com.webobjects.appserver.WOActionResults	previousPage()
ERXFlickrBatchNavigation.PageNumber	repetitionPageNumber()
com.webobjects.appserver.WOActionResults	selectBatchSize()
com.webobjects.appserver.WOActionResults	selectPage()
void	setRepetitionPageNumber(ERXFlickrBatchNavigation.PageNumber repetitionPageNumber)
boolean	showBatchSizes()
boolean	showLabels()
boolean	synchronizesVariablesWithBindings()

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, appendToResponse, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, invokeAction, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, reset, shouldCheckAccess, stringValueForBinding, stringValueForBinding, takeValuesFromRequest, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Field Detail

currentBatchSize

public Integer currentBatchSize

Constructor Detail

ERXFlickrBatchNavigation

public ERXFlickrBatchNavigation(com.webobjects.appserver.WOContext context)

Method Detail

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class com.webobjects.appserver.WOComponent

objects

public NSArray objects()

displayGroup

public WODisplayGroup displayGroup()

setRepetitionPageNumber

public void setRepetitionPageNumber(ERXFlickrBatchNavigation.PageNumber repetitionPageNumber)

repetitionPageNumber

public ERXFlickrBatchNavigation.PageNumber repetitionPageNumber()

hasMultiplePages

public boolean hasMultiplePages()

showLabels

public boolean showLabels()

hasPreviousPage

public boolean hasPreviousPage()

previousPage

public com.webobjects.appserver.WOActionResults previousPage()

hasNextPage

public boolean hasNextPage()

nextPage

public com.webobjects.appserver.WOActionResults nextPage()

selectPage

public com.webobjects.appserver.WOActionResults selectPage()

displayName

public String displayName()

displayNameCount

public Integer displayNameCount()

isCurrentPageNumber

public boolean isCurrentPageNumber()

pageNumbers

public NSArray<ERXFlickrBatchNavigation.PageNumber> pageNumbers()

addEllipsis

protected void addEllipsis()

addPageNumbers

protected void addPageNumbers(int startIndex,
                              int endIndex)

batchCount

public int batchCount()

numberOfObjectsPerBatch

public int numberOfObjectsPerBatch()

maxNumberOfObjects

public int maxNumberOfObjects()

currentBatchIndex

public int currentBatchIndex()

parentActionName

public String parentActionName()

firstIndex

public int firstIndex()

lastIndex

public int lastIndex()

showBatchSizes

public boolean showBatchSizes()

possibleBatchSizes

public NSArray<? extends Number> possibleBatchSizes()

batchSize

public int batchSize()

currentBatchSizeString

public String currentBatchSizeString()

isCurrentBatchSizeSelected

public boolean isCurrentBatchSizeSelected()

selectBatchSize

public com.webobjects.appserver.WOActionResults selectBatchSize()