org.araneaframework.framework
Class StandardConfirmationFilterWidget

java.lang.Object
  org.araneaframework.core.BaseComponent
      org.araneaframework.core.BaseService
          org.araneaframework.core.BaseWidget
              org.araneaframework.framework.core.BaseFilterWidget
                  org.araneaframework.framework.StandardConfirmationFilterWidget

All Implemented Interfaces:

Component, ConfirmationContext, FilterWidget, Serializable, Service, Widget

public class StandardConfirmationFilterWidget

extends BaseFilterWidget

implements ConfirmationContext

Since:

1.1

Author:

Taimo Peelo (taimo@araneaframework.org)

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.araneaframework.core.BaseWidget

BaseWidget.WidgetImpl

Nested classes inherited from class org.araneaframework.core.BaseService

BaseService.ServiceImpl

Nested classes inherited from class org.araneaframework.core.BaseComponent

BaseComponent.ComponentImpl

Nested classes inherited from class org.araneaframework.Widget

Widget.Interface

Field Summary

Fields inherited from class org.araneaframework.framework.core.BaseFilterWidget

childWidget

Fields inherited from class org.araneaframework.core.BaseService

currentInputData, currentOutputData

Fields inherited from interface org.araneaframework.framework.ConfirmationContext

CONFIRMATION_RESULT_KEY

Constructor Summary

StandardConfirmationFilterWidget()

Method Summary

void	confirm(org.apache.commons.collections.Closure onConfirmClosure, String message) Creates a condition for the user to confirm (only one confirmation can be used per page).
protected void	event(Path path, InputData input)
protected Environment	getChildWidgetEnvironment() By default returns the widget's Environment.
String	getConfirmationMessage() Returns the current confirmation message meant for the user.
protected boolean	isActive()
protected void	removeConfirmation()
protected void	render(OutputData output)

Methods inherited from class org.araneaframework.framework.core.BaseFilterWidget

action, destroy, getChildWidget, init, propagate, setChildWidget, update

Methods inherited from class org.araneaframework.core.BaseWidget

_getWidget, getInputData, getOutputData, handleWidgetException

Methods inherited from class org.araneaframework.core.BaseService

_getService, handleServiceException

Methods inherited from class org.araneaframework.core.BaseComponent

_addComponent, _addComponent, _checkCall, _disableComponent, _enableComponent, _endCall, _endWaitingCall, _getChildren, _getComponent, _getDisabledChildren, _propagate, _relocateComponent, _removeComponent, _setEnvironment, _setScope, _startCall, _startWaitingCall, _strictCheckCall, _strictStartCall, _waitNoCall, disable, enable, getEnvironment, getScope, handleException, isAlive, isDead, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.araneaframework.Widget

_getWidget

Methods inherited from interface org.araneaframework.Service

_getService

Methods inherited from interface org.araneaframework.Component

_getComponent, getEnvironment, getScope, isAlive

Constructor Detail

StandardConfirmationFilterWidget

public StandardConfirmationFilterWidget()

Method Detail

confirm

public void confirm(org.apache.commons.collections.Closure onConfirmClosure,
                    String message)

Description copied from interface: ConfirmationContext

Creates a condition for the user to confirm (only one confirmation can be used per page). The user will be shown the confirmation message (on page load). If the user chooses "Yes" then the business logic inside the closure will be invoked.

Specified by:

confirm in interface ConfirmationContext

Parameters:

onConfirmClosure - A closure that invokes the business logic when the user confirms it.

message - The confirmation message displayed to the user.

removeConfirmation

protected void removeConfirmation()

getConfirmationMessage

public String getConfirmationMessage()

Description copied from interface: ConfirmationContext

Returns the current confirmation message meant for the user.

Specified by:

getConfirmationMessage in interface ConfirmationContext

Returns:

the current confirmation message.

isActive

protected boolean isActive()

event

protected void event(Path path,
                     InputData input)
              throws Exception

Overrides:

event in class BaseFilterWidget

Throws:

Exception

render

protected void render(OutputData output)
               throws Exception

Overrides:

render in class BaseFilterWidget

Throws:

Exception

getChildWidgetEnvironment

protected Environment getChildWidgetEnvironment()

Description copied from class: BaseFilterWidget

By default returns the widget's Environment. The child is initilized with the return value of this method.

Overrides:

getChildWidgetEnvironment in class BaseFilterWidget