WebObjects 5.2.3

com.webobjects.woextensions
Class WOSimpleArrayDisplay

java.lang.Object
  extended bycom.webobjects.appserver.WOElement
      extended bycom.webobjects.appserver.WOComponent
          extended bycom.webobjects.woextensions.WOSimpleArrayDisplay
All Implemented Interfaces:
Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults
Direct Known Subclasses:
WOSimpleArrayDisplay2

public class WOSimpleArrayDisplay
extends WOComponent

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Nested classes inherited from class com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Field Summary
 Object currentItem
           
 String itemDisplayKey
           
 NSArray list
           
 String listAction
           
 String listActionString
           
 int numberToDisplay
           
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
WOSimpleArrayDisplay(WOContext aContext)
           
 
Method Summary
 String displayStringForItem()
           
 boolean hasItems()
           
 boolean isDisplayingSubset()
           
 boolean isStateless()
          By default, this method returns false, indicating that state will be maintained for instances of the receiver.
 String itemDisplayKey()
           
 NSArray list()
           
 String listAction()
           
 WOActionResults listActionClicked()
           
 String listActionString()
           
 int numberToDisplay()
           
 int realSize()
           
 void reset()
          Allows a stateless component to reset temporary references.
 NSArray subList()
           
 
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, 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

currentItem

public Object currentItem

itemDisplayKey

public String itemDisplayKey

list

public NSArray list

listAction

public String listAction

listActionString

public String listActionString

numberToDisplay

public int numberToDisplay
Constructor Detail

WOSimpleArrayDisplay

public WOSimpleArrayDisplay(WOContext aContext)
Method Detail

displayStringForItem

public String displayStringForItem()

hasItems

public boolean hasItems()

isDisplayingSubset

public boolean isDisplayingSubset()

isStateless

public boolean isStateless()
Description copied from class: WOComponent
By default, this method returns false, indicating that state will be maintained for instances of the receiver. Overriding this method to return true will make the component stateless. A single instance of each stateless component is shared between multiple sessions, reducing the application's memory footprint.

By default, stateless components don't synchronize. So, if you override this method to return true and you want the component to synchronize, you must also override synchronizesVariablesWithBindings and return true.

Overrides:
isStateless in class WOComponent
Returns:
true if this method is overidden, false otherwise
See Also:
WOComponent.reset(), WOComponent.synchronizesVariablesWithBindings()

itemDisplayKey

public String itemDisplayKey()

list

public NSArray list()

listAction

public String listAction()

listActionClicked

public WOActionResults listActionClicked()

listActionString

public String listActionString()

numberToDisplay

public int numberToDisplay()

realSize

public int realSize()

reset

public void reset()
Description copied from class: WOComponent
Allows a stateless component to reset temporary references. This method -- which is only invoked if the component is stateless -- allows a component instance to reset or delete temporary references to objects that are specific to a given context. To ensure that when the shared instance of a component is reused by another session there are no side effects, implement this method so that it releases and sets to null each of the component's instance variables.

Overrides:
reset in class WOComponent
See Also:
WOComponent.isStateless()

subList

public NSArray subList()

Last updated Thu Oct 21 15:04:16 PDT 2004.

Copyright © 2004 Apple Computer, Inc.