de.intarsys.tools.functor

Class DeclarationFunctor<T>

java.lang.Object

de.intarsys.tools.functor.DeclarationFunctor<T>

All Implemented Interfaces:

IContextSupport, IDeclarationSupport, IFunctor<T>, IElementConfigurable, IElementSerializable, IPresentationSupport

public class DeclarationFunctor<T>
extends Object
implements IFunctor<T>, IElementConfigurable, IElementSerializable, IDeclarationSupport, IContextSupport, IPresentationSupport

An IFunctor that will add declaration features to a nested IFunctor.

Field Summary

Fields inherited from interface de.intarsys.tools.presentation.IPresentationSupport

ATTR_DESCRIPTION, ATTR_ICON, ATTR_LABEL, ATTR_TIP

Constructor Summary

Constructors

Constructor and Description
DeclarationFunctor()
DeclarationFunctor(IFunctor functor)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(IElement pElement)
Object	getContext()
IDeclarationBlock	getDeclarationBlock() The block of declarations available so far for this.
String	getDescription() A long, descriptive string representation.
IFunctor	getFunctor()
String	getIconName() A name for an icon.
String	getLabel() A short string representation (suitable for example for use with an icon or menu item).
String	getTip() An "intermediate" length description (suitable for example with a tooltip).
T	perform(IFunctorCall call) Perform the encapsulated business logic in the context defined in "call".
void	serialize(IElement element) Serialize the state in element.
void	setContext(Object context)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclarationFunctor

public DeclarationFunctor()

DeclarationFunctor

public DeclarationFunctor(IFunctor functor)

Method Detail

configure

public void configure(IElement pElement)
               throws ConfigurationException

Specified by:

configure in interface IElementConfigurable

Throws:

ConfigurationException

getContext

public Object getContext()

getDeclarationBlock

public IDeclarationBlock getDeclarationBlock()

Description copied from interface: IDeclarationSupport

The block of declarations available so far for this.

Specified by:

getDeclarationBlock in interface IDeclarationSupport

Returns:

The block of declarations available so far for this.

getDescription

public String getDescription()

Description copied from interface: IPresentationSupport

A long, descriptive string representation.

Specified by:

getDescription in interface IPresentationSupport

Returns:

A long, descriptive string representation.

getFunctor

public IFunctor getFunctor()

getIconName

public String getIconName()

Description copied from interface: IPresentationSupport

A name for an icon.

Specified by:

getIconName in interface IPresentationSupport

Returns:

A name for an icon.

getLabel

public String getLabel()

Description copied from interface: IPresentationSupport

A short string representation (suitable for example for use with an icon or menu item).

Specified by:

getLabel in interface IPresentationSupport

Returns:

A short string representation (suitable for example for use with an icon or menu item).

getTip

public String getTip()

Description copied from interface: IPresentationSupport

An "intermediate" length description (suitable for example with a tooltip).

Specified by:

getTip in interface IPresentationSupport

Returns:

An "intermediate" length description (suitable for example with a tooltip).

perform

public T perform(IFunctorCall call)
          throws FunctorInvocationException

Description copied from interface: IFunctor

Perform the encapsulated business logic in the context defined in "call".

Specified by:

perform in interface IFunctor<T>

Parameters:

call - The call context

Returns:

The behavior execution result.

Throws:

FunctorInvocationException - An exception that raised while executing the business logic will be wrapped in a FunctorInvocationException.

serialize

public void serialize(IElement element)
               throws ElementSerializationException

Description copied from interface: IElementSerializable

Serialize the state in element. element represents the receiver immediately, it contains the state information directly, not as a child element. This means most of the time you have to change the element name itself and add child elements.

Specified by:

serialize in interface IElementSerializable

Throws:

ElementSerializationException

setContext

public void setContext(Object context)
                throws ConfigurationException

Specified by:

setContext in interface IContextSupport

Throws:

ConfigurationException