com.webobjects.woextensions
Class WXOutlineEntry

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.woextensions.WXOutlineEntry

All Implemented Interfaces:

Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults

public class WXOutlineEntry

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

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

WXOutlineEntry(WOContext aContext)

Method Summary

void	appendToResponse(WOResponse aResponse, WOContext aContext) Forces the component to generate its interface and output it in the response's content.
void	awake() Invoked at the beginning of a WOComponent's involvement in a cycle of the request-response loop.
boolean	hasChildren()
WOActionResults	invokeAction(WORequest aRequest, WOContext aContext) Tells the component to execute any action specified in the request.
boolean	isExpanded()
int	nestingLevel()
int	nestingLevelForChildren()
boolean	synchronizesVariablesWithBindings() Indicates if the push-pull of values in the parent component is enabled.
void	takeValuesFromRequest(WORequest aRequest, WOContext aContext) Tells the component to synchronize its variables with values from the request.
WOComponent	toggleExpansion()

Methods inherited from class com.webobjects.appserver.WOComponent

application, 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, reset, 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

Constructor Detail

WXOutlineEntry

public WXOutlineEntry(WOContext aContext)

Method Detail

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)

Description copied from class: WOComponent

Forces the component to generate its interface and output it in the response's content. Component objects associated with a response receive this message during the last phase of the component request handling, or when returned by a direct action method. In the append-to-response phase, application objects (particularly the response page instance itself) generate the HTML content of the page. WOComponent's default implementation of this method invokes the appendToResponse method on the root WOElement object of the component template, which in turn invokes appendToResponse. Subclasses of WOComponent can override this method to replace or supplement the default behavior with custom logic.

Overrides:

appendToResponse in class WOComponent

Parameters:

aResponse - the HTTP response that an application returns to a Web server to complete a cycle of the request-response loop

aContext - context of a transaction

See Also:

WOComponent.invokeAction(WORequest aRequest, WOContext aContext), WOComponent.takeValuesFromRequest(WORequest aRequest, WOContext aContext)

awake

public void awake()

Description copied from class: WOComponent

Invoked at the beginning of a WOComponent's involvement in a cycle of the request-response loop. It gives the WOComponent an opportunity to initialize its instance variables or perform setup operations. The default implementation does nothing.

Overrides:

awake in class WOComponent

See Also:

WOComponent.ensureAwakeInContext(WOContext aContext), WOComponent.sleep()

hasChildren

public boolean hasChildren()

invokeAction

public WOActionResults invokeAction(WORequest aRequest,
                                    WOContext aContext)

Description copied from class: WOComponent

Tells the component to execute any action specified in the request. It is systematically called during the middle phase of the component request handling. All WOComponent objects associated with a request page invoke this method. In this middle phase, the invokeAction method is propagated through the WOElement objects of the page. The dynamic element on which the user has acted (by, for example, clicking a button) responds by triggering the method in the request component that is bound to the action. WOComponent's default implementation of this method invokes invokeAction on the root WOElement object of the component template.

Overrides:

invokeAction in class WOComponent

Parameters:

aRequest - the request

aContext - context of the transaction

Returns:

a WOActionResults containing the result of the request

See Also:

WOComponent.appendToResponse(WOResponse aResponse, WOContext aContext), WOComponent.takeValuesFromRequest(WORequest aRequest, WOContext aContext)

isExpanded

public boolean isExpanded()

nestingLevel

public int nestingLevel()

nestingLevelForChildren

public int nestingLevelForChildren()

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Description copied from class: WOComponent

Indicates if the push-pull of values in the parent component is enabled. Returns whether a nested component pulls all values down from its parent and pushes all values to its parent before and after each phase of the request-response loop. This method returns false for stateless components (unless you override isStateless and return true), and true otherwise. Override this method to create a non-synchronizing component.

Overrides:

synchronizesVariablesWithBindings in class WOComponent

Returns:

false if this method creates a non-synchronizing component, true otherwise

See Also:

WOComponent.valueForBinding(String aBindingName), WOComponent.setValueForBinding(Object aValue, String aBindingName), WOComponent.pullValuesFromParent(), WOComponent.pushValuesToParent(), WOComponent.isStateless()

takeValuesFromRequest

public void takeValuesFromRequest(WORequest aRequest,
                                  WOContext aContext)

Description copied from class: WOComponent

Tells the component to synchronize its variables with values from the request. It is systematically called during the first phase of the component request handling. All WOComponent objects associated with a request are called with this method during the first phase of the request-response loop. The default WOComponent behavior is to invoke the method on the root WOElement object of the component's template (returned by template(). In this phase, each dynamic element in the template extracts any entered data or changed state (such as a check in a check box) associated with an attribute and assigns the value to the component variable bound to the attribute. Subclasses of WOComponent can override this method to replace or supplement the default behavior with custom logic.

Overrides:

takeValuesFromRequest in class WOComponent

Parameters:

aRequest - the current request with the WOComponent object

aContext - context of a transaction

See Also:

WOComponent.appendToResponse(WOResponse aResponse, WOContext aContext), WOComponent.invokeAction(WORequest aRequest, WOContext aContext)

toggleExpansion

public WOComponent toggleExpansion()