atg.droplet
Class AnchorTag

java.lang.Object
  javax.servlet.GenericServlet
      atg.droplet.Tag
          atg.droplet.ComplexTag
              atg.droplet.EventSender
                  atg.droplet.AnchorTag

All Implemented Interfaces:

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

public class AnchorTag
extends EventSender
implements EventReceiver

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	TAG_NAME

Fields inherited from interface atg.droplet.DropletConstants

DROPLET_ANCHOR_QUALIFIER, DROPLET_ANCHOR_VALUE, DROPLET_ARGUMENTS, DROPLET_BEAN_PREFIX, DROPLET_BEFORE_GET_ATTRIBUTE, DROPLET_EVENT_ATTRIBUTE, DROPLET_EVENT_PREFIX, DROPLET_EXCEPTIONS_ATTRIBUTE, DROPLET_PARAM_PREFIX, DROPLET_PROPERTY_PREFIX, DROPLET_SESSION_CONF, DROPLET_SUBMIT_VALUE_PREFIX, OBJECT_BEFORE_GET_ATTRIBUTE, PRIORITY_DEFAULT, SUBMIT_PRIORITY_DEFAULT, UNCHECKED_DROPLET_EXCEPTIONS_ATTRIBUTE

Constructor Summary

AnchorTag()

AnchorTag(java.lang.String pAnchorId, DropletEventServlet pServlet)

AnchorTag(java.lang.String pAnchorId, DropletEventServlet pServlet, TagConverter pConverter, java.util.Properties pConverterArgs)

Method Summary

void	addHref(java.lang.String pHref) Adds a new action/anchor to the list
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()
java.lang.String	getHref()
java.util.Set	getHrefList() Returns the hrefList
java.lang.String	getName() Since anchor's only have a single property value, we don't need to have unique names for them.
int[][]	getPathDims() Return the name of the property for the component
java.lang.String[]	getPathNames() Return the name of the property for the component
java.lang.String	getPropertyPath() Return the complete path name of the property
boolean	getRequiresSessionConfirmation() Whether this form requires session confirmation.
java.lang.String	getSubmitValue()
java.lang.String	getTagName() Returns the name of this tag or null if no name has been specified.
boolean	hasHref(java.lang.String pHref) Returns true if the href is exists, false if not.
boolean	isImage() Is this handler expecting an image expecting .x and .y args?
int	numHrefs() Returns the number of hrefs
void	service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes) Renders the tag and its content
void	setHref(java.lang.String pHref)
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	setPropertyPath(java.lang.String pPropertyPath) Sets the complete path to find the property
void	setRequiresSessionConfirmation(boolean pRequiresSessionConfirmation) Whether this form requires session confirmation.

Methods inherited from class atg.droplet.EventSender

getImageRequestValue, getRequestValue

Methods inherited from class atg.droplet.ComplexTag

addContent, addContent, addContent, getContent, serviceContent, setContent

Methods inherited from class atg.droplet.Tag

getAttribute, getAttributes, 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

TAG_NAME

public static final java.lang.String TAG_NAME

See Also:

Constant Field Values

Constructor Detail

AnchorTag

public AnchorTag()

AnchorTag

public AnchorTag(java.lang.String pAnchorId,
                 DropletEventServlet pServlet)

AnchorTag

public AnchorTag(java.lang.String pAnchorId,
                 DropletEventServlet pServlet,
                 TagConverter pConverter,
                 java.util.Properties pConverterArgs)

Method Detail

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 to use to override the form value.

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

getName

public java.lang.String getName()

Since anchor's only have a single property value, we don't need to have unique names for them. This name is used for the anchor's property value.

Specified by:

getName in interface EventReceiver

setName

public void setName(java.lang.String pName)

getTagName

public java.lang.String getTagName()

Description copied from class: Tag

Returns the name of this tag or null if no name has been specified.

Overrides:

getTagName in class Tag

getHref

public java.lang.String getHref()

setHref

public void setHref(java.lang.String pHref)

getPropertyPath

public java.lang.String getPropertyPath()

Return the complete path name of the property

Specified by:

getPropertyPath in interface EventReceiver

setPropertyPath

public void setPropertyPath(java.lang.String pPropertyPath)
                     throws DropletException

Sets the complete path to find the property

Throws:

DropletException

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

getComponentPath

public java.lang.String getComponentPath()

Return the path name of the component

Specified by:

getComponentPath in interface EventReceiver

setRequiresSessionConfirmation

public void setRequiresSessionConfirmation(boolean pRequiresSessionConfirmation)

Whether this form requires session confirmation. Defaults to true.

getRequiresSessionConfirmation

public boolean getRequiresSessionConfirmation()

Whether this form requires session confirmation. Defaults to true.

addHref

public void addHref(java.lang.String pHref)

Adds a new action/anchor to the list

Parameters:

pActionURL - the action to be added

hasHref

public boolean hasHref(java.lang.String pHref)

Returns true if the href is exists, false if not.

numHrefs

public int numHrefs()

Returns the number of hrefs

getHrefList

public java.util.Set getHrefList()

Returns the hrefList

service

public void service(DynamoHttpServletRequest pReq,
                    DynamoHttpServletResponse pRes)
             throws javax.servlet.ServletException,
                    java.io.IOException

Renders the tag and its content

Overrides:

service in class ComplexTag

Throws:

javax.servlet.ServletException

java.io.IOException

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

getConverterArgs

public java.util.Properties getConverterArgs()

Description copied from interface: EventReceiver

The arguments for the converter

Specified by:

getConverterArgs in interface EventReceiver