javawebparts.ajaxparts.taglib.config
Class AjaxResponseHandler

java.lang.Object
  |
  +--javawebparts.ajaxparts.taglib.config.AjaxResponseHandler

public class AjaxResponseHandler
extends java.lang.Object

This class holds configuration information on a response handler defined for a given event of an Ajax-enabled element.

Author:
Frank W. Zammetti

Field Summary
private  boolean frozen
          Flag: Is the configuration frozen?
private static org.apache.commons.logging.Log log
          Log instance.
private  java.lang.String matchPattern
          The regex that will be used to determine is response handler should fire.
private  java.lang.String parameter
          The parameter for a handler.
private  java.lang.String type
          The type of a handler.
 
Constructor Summary
AjaxResponseHandler()
           
 
Method Summary
 void freeze()
          Freezes the configuration of this object.
 java.lang.String getMatchPattern()
          Returns the matchPattern of this event handler.
 java.lang.String getParameter()
          Returns the handler-specific parameter string for this handler.
 java.lang.String getType()
          Returns the type of this event handler.
 boolean isFrozen()
          Returns true if this onject's config is frozen, false otherwise.
 void setMatchPattern(java.lang.String inMatchPattern)
          Sets the matchPattern of this event handler.
 void setParameter(java.lang.String inParameter)
          Sets the handler-specific parameter string for this handler.
 void setType(java.lang.String inType)
          Sets the type of this event handler.
 java.lang.String toString()
          Overriden toString method.
private  boolean validate()
          This method is called when the object is frozen to ensure it is configured in a legal way.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

private static org.apache.commons.logging.Log log
Log instance.


type

private java.lang.String type
The type of a handler.


parameter

private java.lang.String parameter
The parameter for a handler. Meaning of value is handler-specific.


matchPattern

private java.lang.String matchPattern
The regex that will be used to determine is response handler should fire.


frozen

private boolean frozen
Flag: Is the configuration frozen?

Constructor Detail

AjaxResponseHandler

public AjaxResponseHandler()
Method Detail

setType

public void setType(java.lang.String inType)
Sets the type of this event handler.

Parameters:
inType - The type of this event handler

getType

public java.lang.String getType()
Returns the type of this event handler.

Returns:
The type of this event handler

setParameter

public void setParameter(java.lang.String inParameter)
Sets the handler-specific parameter string for this handler.

Parameters:
inParameter - The parameter string for this handler

getParameter

public java.lang.String getParameter()
Returns the handler-specific parameter string for this handler.

Returns:
The parameter string for this handler

setMatchPattern

public void setMatchPattern(java.lang.String inMatchPattern)
Sets the matchPattern of this event handler.

Parameters:
inMatchPattern - The matchPattern of this event handler

getMatchPattern

public java.lang.String getMatchPattern()
Returns the matchPattern of this event handler.

Returns:
The matchPattern of this event handler

freeze

public void freeze()
Freezes the configuration of this object.


isFrozen

public boolean isFrozen()
Returns true if this onject's config is frozen, false otherwise.

Returns:
True if frozen, false if not.

validate

private boolean validate()
This method is called when the object is frozen to ensure it is configured in a legal way.

Returns:
True if validation passes, false if not.

toString

public java.lang.String toString()
Overriden toString method.

Overrides:
toString in class java.lang.Object
Returns:
A reflexively-built string representation of this bean


Copyright 2005 Frank W. Zammetti