com.jxcell
Class ValidationFailedEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bycom.jxcell.ValidationFailedEvent
All Implemented Interfaces:
java.io.Serializable

public class ValidationFailedEvent
extends java.util.EventObject

This event occurs when the validation process fails

See Also:
Serialized Form

Field Summary
static short eFail
          validation failure throw an exception
static short eIgnoreValidationRule
          validatation failure ignore the rule and place the value into the cell
static short eRetry
          validation failure, revalidate, then throw an exception
static short eShowErrorAndFail
          validation, show an error message box, then throw an exception
 
Method Summary
 short getAction()
          This method returns the action when validation fails
 int getCol()
          This method returns the column the user was entering data in when validation failed
 java.lang.String getEntry()
          This method returns the entry the user was trying to make when validation failed
 java.lang.String getMessage()
          This method returns the message returned when validation fails
 int getRow()
          This method returns the row the user was entering data in when validation failed
 int getSheet()
          This method returns the sheet the user was entering data in when validation failed
 void setAction(short action)
          This method sets the action taken by Formula One when validation fails
 void setEntry(java.lang.String entry)
          This method can be used within the ValidationFailed event to set the entry to a new value if the setAction method is set to 3 - retry validation.
 void setMessage(java.lang.String message)
          This method sets the message returned when validation fails
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

eFail

public static final short eFail
validation failure throw an exception

See Also:
Constant Field Values

eIgnoreValidationRule

public static final short eIgnoreValidationRule
validatation failure ignore the rule and place the value into the cell

See Also:
Constant Field Values

eRetry

public static final short eRetry
validation failure, revalidate, then throw an exception

See Also:
Constant Field Values

eShowErrorAndFail

public static final short eShowErrorAndFail
validation, show an error message box, then throw an exception

See Also:
Constant Field Values
Method Detail

getAction

public short getAction()
This method returns the action when validation fails

Returns:
action taken on validation failure

getCol

public int getCol()
This method returns the column the user was entering data in when validation failed

Returns:
column number

getEntry

public java.lang.String getEntry()
This method returns the entry the user was trying to make when validation failed

Returns:
string indicating the entry that failed validation

getMessage

public java.lang.String getMessage()
This method returns the message returned when validation fails

Returns:
the validation failure message

getRow

public int getRow()
This method returns the row the user was entering data in when validation failed

Returns:
row number

getSheet

public int getSheet()
This method returns the sheet the user was entering data in when validation failed

Returns:
worksheet number

setAction

public void setAction(short action)
               throws CellException
This method sets the action taken by Formula One when validation fails

Parameters:
action - integer describing the action taken on validation failure eFail eIgnoreValidationRule eRetry eShowErrorAndFail
Throws:
CellException

setEntry

public void setEntry(java.lang.String entry)
This method can be used within the ValidationFailed event to set the entry to a new value if the setAction method is set to 3 - retry validation.

Parameters:
entry - string indicating the new entry

setMessage

public void setMessage(java.lang.String message)
This method sets the message returned when validation fails

Parameters:
message - the validation failure message