org.apache.tapestry.spec
Class Direction

java.lang.Object
  org.apache.commons.lang.enum.Enum
      org.apache.tapestry.spec.Direction

All Implemented Interfaces:

Serializable, Comparable

public class Direction
extends org.apache.commons.lang.enum.Enum

Represents different types of parameters. Currently only in and custom are supported, but this will likely change when Tapestry supports out parameters is some form (that reflects form style processing).

Since:

2.0.3

Version:

$Id: Direction.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Lewis Ship

See Also:

Serialized Form

Field Summary

static Direction	AUTO Causes a synthetic property to be created that automatically references and de-references the underlying binding.
static Direction	CUSTOM Processing of the parameter is entirely the responsibility of the component, which must obtain an manipulate the IBinding (if any) for the parameter.
static Direction	FORM Encapsulates the semantics of a form component's value parameter.
static Direction	IN The parameter value is input only; the component property value is unchanged or not relevant after the component renders.

Constructor Summary

protected	Direction(String name)
protected	Direction(String name, boolean allowInvariant)

Method Summary

boolean	getAllowInvariant()
String	getDisplayName() Returns a user-presentable name for the direction.

Methods inherited from class org.apache.commons.lang.enum.Enum

compareTo, equals, getEnum, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

IN

public static final Direction IN

The parameter value is input only; the component property value is unchanged or not relevant after the component renders. The property is set from the binding before the component renders, then reset to initial value after the component renders.

FORM

public static final Direction FORM

Encapsulates the semantics of a form component's value parameter.

The parameter is associated with a IFormComponent. The property value is set from the binding before the component renders (when renderring, but not when rewinding). The binding is updated from the property value after after the component renders when the containing form is rewinding, and the component is not disabled.

Since:

2.2

CUSTOM

public static final Direction CUSTOM

Processing of the parameter is entirely the responsibility of the component, which must obtain an manipulate the IBinding (if any) for the parameter.

AUTO

public static final Direction AUTO

Causes a synthetic property to be created that automatically references and de-references the underlying binding.

Since:

3.0

Constructor Detail

Direction

protected Direction(String name)

Direction

protected Direction(String name,
                    boolean allowInvariant)

Method Detail

getAllowInvariant

public boolean getAllowInvariant()

Since:

3.0

getDisplayName

public String getDisplayName()

Returns a user-presentable name for the direction.