FormEventReceiver (ATG Java API)

java.lang.Object
- javax.servlet.GenericServlet
- - atg.droplet.Tag
  - - atg.droplet.FormEventReceiver

All Implemented Interfaces:

EventReceiver, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

InputTag
```
public class FormEventReceiver
extends Tag
implements EventReceiver
```
This class implements the EventReceiving functionality for input, select, and textarea tags. It is the base class for InputTag, SelectTag, and TextArea tag. Programmers should instance those classes to obtain both the rendering and event receiving functionality.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getComponentPath()` Return the path name of the component
`TagConverter`	`getConverter()` The converter to apply to any set accesses to this value
`java.util.Properties`	`getConverterArgs()` The arguments for the converter
`java.lang.String`	`getDefault()`
`boolean`	`getMayHaveSubmitValue()`
`java.lang.String`	`getName()` Get the name of the parameter that identifies this event as occuring
`int[][]`	`getPathDims()` Return the name of the property for the component
`java.lang.String[]`	`getPathNames()` Return the name of the property for the component
`int`	`getPriority()`
`java.lang.String`	`getPropertyPath()` Return the complete path name of the property
`java.lang.String`	`getSubmitValue()`
`java.lang.String`	`getType()` Returns the type
`java.lang.String`	`getXssFiltering()` Returns the value of the xssFiltering attribute
`boolean`	`isImage()` Is this handler expecting an image expecting .x and .y args?
`void`	`setConverter(TagConverter pConverter)`
`void`	`setConverterArgs(java.util.Properties pConverterArgs)`
`boolean`	`setMayHaveSubmitValue(boolean pValue)`
`void`	`setName(java.lang.String pName)`
`void`	`setPathDims(int[][] pPathDims)` Sets the list of dimensions.
`void`	`setPathNames(java.lang.String[] pPathNames)` Sets the list of path names.
`void`	`setPriority(int pPriority)`
`void`	`setProperty(java.lang.String pProperty)` Sets the property attribute for this tag.
`void`	`setPropertyPath(java.lang.String pPropertyPath)` Sets the path name of the property that this Input/Select etc.
`void`	`setType(java.lang.String pType)`
`void`	`setXssFiltering(java.lang.String pXssFiltering)` Sets the value of the xssFiltering attribute

Methods inherited from class atg.droplet.Tag
getAttribute, getAttributes, getTagName, service, service, serviceAttributes, setAttribute, setAttributes, setTagName

Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
- Method Detail
  - getComponentPath
```
public java.lang.String getComponentPath()
```
    Return the path name of the component
    
    Specified by:
    
    getComponentPath in interface EventReceiver
  - setType
```
public void setType(java.lang.String pType)
```
  - getType
```
public java.lang.String getType()
```
    Returns the type
  - getXssFiltering
```
public java.lang.String getXssFiltering()
```
    Returns the value of the xssFiltering attribute
  - setXssFiltering
```
public void setXssFiltering(java.lang.String pXssFiltering)
```
    Sets the value of the xssFiltering attribute
  - getDefault
```
public java.lang.String getDefault()
```
    Specified by:
    
    getDefault in interface EventReceiver
    
    Returns:
    
    the default value to use in a set event if no value was specified
  - getSubmitValue
```
public java.lang.String getSubmitValue()
```
    Specified by:
    
    getSubmitValue in interface EventReceiver
    
    Returns:
    
    the submit value for this tag
  - getMayHaveSubmitValue
```
public boolean getMayHaveSubmitValue()
```
    Returns:
    
    the flag that indicates whether this tag has been rendered yet with a submit value.
  - setMayHaveSubmitValue
```
public boolean setMayHaveSubmitValue(boolean pValue)
```
  - getPriority
```
public int getPriority()
```
  - setPriority
```
public void setPriority(int pPriority)
```
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: EventReceiver
    
    Get the name of the parameter that identifies this event as occuring
    
    Specified by:
    
    getName in interface EventReceiver
  - setName
```
public void setName(java.lang.String pName)
```
  - isImage
```
public boolean isImage()
```
    Description copied from interface: EventReceiver
    
    Is this handler expecting an image expecting .x and .y args?
    
    Specified by:
    
    isImage in interface EventReceiver
  - setProperty
```
public void setProperty(java.lang.String pProperty)
                 throws DropletException
```
    Sets the property attribute for this tag. The property is mapped to an absolute property through any imports associated with the tag.
    
    Throws:
    
    DropletException
  - setPropertyPath
```
public void setPropertyPath(java.lang.String pPropertyPath)
                     throws DropletException
```
    Sets the path name of the property that this Input/Select etc. tag is associated with.
    
    Throws:
    
    DropletException
  - getPropertyPath
```
public java.lang.String getPropertyPath()
```
    Return the complete path name of the property
    
    Specified by:
    
    getPropertyPath in interface EventReceiver
  - getPathNames
```
public java.lang.String[] getPathNames()
```
    Return the name of the property for the component
    
    Specified by:
    
    getPathNames in interface EventReceiver
  - getPathDims
```
public int[][] getPathDims()
```
    Return the name of the property for the component
    
    Specified by:
    
    getPathDims in interface EventReceiver
  - setPathNames
```
public void setPathNames(java.lang.String[] pPathNames)
```
    Sets the list of path names.
    
    Specified by:
    
    setPathNames in interface EventReceiver
  - setPathDims
```
public void setPathDims(int[][] pPathDims)
```
    Sets the list of dimensions.
    
    Specified by:
    
    setPathDims in interface EventReceiver
  - getConverter
```
public TagConverter getConverter()
```
    Description copied from interface: EventReceiver
    
    The converter to apply to any set accesses to this value
    
    Specified by:
    
    getConverter in interface EventReceiver
  - setConverter
```
public void setConverter(TagConverter pConverter)
```
  - getConverterArgs
```
public java.util.Properties getConverterArgs()
```
    Description copied from interface: EventReceiver
    
    The arguments for the converter
    
    Specified by:
    
    getConverterArgs in interface EventReceiver
  - setConverterArgs
```
public void setConverterArgs(java.util.Properties pConverterArgs)
```

Class FormEventReceiver

Field Summary

Method Summary

Methods inherited from class atg.droplet.Tag

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

Method Detail

getComponentPath

setType

getType

getXssFiltering

setXssFiltering

getDefault

getSubmitValue

getMayHaveSubmitValue

setMayHaveSubmitValue

getPriority

setPriority

getName

setName

isImage

setProperty

setPropertyPath

getPropertyPath

getPathNames

getPathDims

setPathNames

setPathDims

getConverter

setConverter

getConverterArgs

setConverterArgs