er.extensions.batching
Class ERXBatchNavigationBar

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.components.ERXComponent
              er.extensions.components.ERXNonSynchronizingComponent
                  er.extensions.components.ERXStatelessComponent
                      er.extensions.batching.ERXBatchNavigationBar

All Implemented Interfaces:

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

Direct Known Subclasses:

ERLITBatchNavigationBar, ERXAjaxBatchNavigationBar, ERXBatchNavigationBarInForm

public class ERXBatchNavigationBar
extends ERXStatelessComponent

Better batch navigation bar to page thtough display groups.

• User typing null for either number of objects per batch or the page number
• When resetting the number of items per batch the page first page displayed would be the last page.
• Broadcasts a notification when the batch size changes
• Has go first/go last methods/li>
• Has option to not clear the selection when paging, which WODisplayGroup does when calling displayNext()/displayPrevious()
• Broadcasts a notification when the batch size changes
• Can be used inside or outside of a form
• Graphics can be easily configured
• Has localization support, both for static texts and the object count.

See Also:

Serialized Form

Bindings

d2wContext	the D2W context that this component is in
displayGroup	the WODisplayGroup that is being controlled
width	the width of the navigation bar table (there is a minimum 500 pixel width if tableClass is not specified)
objectName	the name of the type of object that is contained in the WODisplayGroup
border	the border width of the navigation bar table
bgcolor	the background color of the navigation bar table
textColor	no longer used?
sortKeyList	an NSArray of sort key paths that will be displayed in a popup button
tableClass	the CSS class for the navigation table (overrides minimum 500 pixel width when set)
imageFramework	the name of the framework that contains the navigation arrow images
leftArrowImage	the name of the left navigation arrow image
rightArrowImage	the name of the right navigation arrow image
clearSelection	boolean that indicates if the selection should be reset on paging (default false)

Nested Class Summary

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.Null, 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

static java.lang.String	BatchSizeChanged Contains a string that names the notification posted when the batch size changes
static org.apache.log4j.Logger	log logging support
boolean	wasInForm

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

ERXBatchNavigationBar(com.webobjects.appserver.WOContext aContext)
Public constructor

Method Summary

void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.
void	awake()
protected void	clearSelection(com.webobjects.foundation.NSArray selection)
int	currentBatchIndex()
com.webobjects.appserver.WOComponent	displayFirstBatch()
com.webobjects.appserver.WODisplayGroup	displayGroup()
com.webobjects.appserver.WOComponent	displayLastBatch()
com.webobjects.appserver.WOComponent	displayNextBatch()
com.webobjects.appserver.WOComponent	displayPreviousBatch()
int	filteredObjectsCount()
java.lang.String	formTarget()
boolean	hasObjectName()
boolean	hasSortKeyList()
java.lang.String	imageFramework()
java.lang.String	leftArrowImage()
int	numberOfObjectsPerBatch()
int	objectCount()
void	reset()
java.lang.String	rightArrowImage()
protected com.webobjects.foundation.NSArray	selection()
void	setCurrentBatchIndex(java.lang.Number newValue)
void	setNumberOfObjectsPerBatch(java.lang.Number newValue)

Methods inherited from class er.extensions.components.ERXStatelessComponent

isStateless, valueForBooleanBinding, valueForBooleanBinding, valueForBooleanBinding, valueForIntBinding, valueForObjectBinding, valueForObjectBinding

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, resetCachedBindingsInStatefulComponent, synchronizesVariablesWithBindings, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

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

Methods inherited from class com.webobjects.appserver.WOComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

logging support

BatchSizeChanged

public static final java.lang.String BatchSizeChanged

Contains a string that names the notification posted when the batch size changes

See Also:

Constant Field Values

wasInForm

public boolean wasInForm

Constructor Detail

ERXBatchNavigationBar

public ERXBatchNavigationBar(com.webobjects.appserver.WOContext aContext)

Public constructor

Method Detail

awake

public void awake()

Overrides:

awake in class com.webobjects.appserver.WOComponent

reset

public void reset()

Overrides:

reset in class ERXStatelessComponent

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.

Overrides:

appendToResponse in class ERXNonSynchronizingComponent

Parameters:

response - to which we are appending

context - context of the response

displayGroup

public com.webobjects.appserver.WODisplayGroup displayGroup()

hasObjectName

public boolean hasObjectName()

hasSortKeyList

public boolean hasSortKeyList()

numberOfObjectsPerBatch

public int numberOfObjectsPerBatch()

currentBatchIndex

public int currentBatchIndex()

setCurrentBatchIndex

public void setCurrentBatchIndex(java.lang.Number newValue)

setNumberOfObjectsPerBatch

public void setNumberOfObjectsPerBatch(java.lang.Number newValue)

filteredObjectsCount

public int filteredObjectsCount()

objectCount

public int objectCount()

imageFramework

public java.lang.String imageFramework()

leftArrowImage

public java.lang.String leftArrowImage()

rightArrowImage

public java.lang.String rightArrowImage()

selection

protected com.webobjects.foundation.NSArray selection()

clearSelection

protected void clearSelection(com.webobjects.foundation.NSArray selection)

displayNextBatch

public com.webobjects.appserver.WOComponent displayNextBatch()

displayPreviousBatch

public com.webobjects.appserver.WOComponent displayPreviousBatch()

displayFirstBatch

public com.webobjects.appserver.WOComponent displayFirstBatch()

displayLastBatch

public com.webobjects.appserver.WOComponent displayLastBatch()

formTarget

public java.lang.String formTarget()