TriggerActions (Qoppa jPDFProcess API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<String,Vector<Action>>
  - - com.qoppa.pdf.actions.TriggerActions

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Vector<Action>>
```
public class TriggerActions
extends Hashtable<String,Vector<Action>>
```
Utility class to encapsulate a list of actions triggered by different mouse events such as mouse entered, mouse exited, mouse up and mouse down. TriggerActions.getMouseDownActions for instance returns a vector of all actions to be executed on a mouse down event. This utility class is used by the Annotation class for instance since an annotation may have trigger actions associated with it.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BLUR`
`static String`	`CALCULATE`
`static String`	`DOC_CLOSE`
`static String`	`DOC_DID_PRINT`
`static String`	`DOC_DID_SAVE`
`static String`	`DOC_WILL_PRINT`
`static String`	`DOC_WILL_SAVE`
`static String`	`FOCUS`
`static String`	`FORMAT`
`static String`	`KEYSTROKE`
`static String`	`MOUSE_DOWN`
`static String`	`MOUSE_ENTERED`
`static String`	`MOUSE_EXITED`
`static String`	`MOUSE_UP`
`static String`	`PAGE_CLOSE`
`static String`	`PAGE_OPEN`
`static String`	`VALIDATE`

Constructor Summary

Constructors
Constructor and Description

TriggerActions()

Constructors
Constructor and Description
`TriggerActions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Overrides Hashtable method to keep track of modifications.
`Vector<Action>`	`getBlurActions()` Get the list of actions to be performed on blur (focus lost).
`Vector<Action>`	`getCalculateActions()` Get the list of actions to be performed when another field changes
`Vector<Action>`	`getDocCloseActions()` Get the list of actions to be performed when the document is closed.
`Vector<Action>`	`getDocDidPrintActions()` Get the list of actions to be performed when the document has printed.
`Vector<Action>`	`getDocDidSaveActions()` Get the list of actions to be performed when the document has been saved.
`Vector<Action>`	`getDocWillPrintActions()` Get the list of actions to be performed when the document will print.
`Vector<Action>`	`getDocWillSaveActions()` Get the list of actions to be performed when the document will be saved.
`Vector<Action>`	`getFocusActions()` Get the list of actions to be performed when focus is gained.
`Vector<Action>`	`getFormatActions()` Get the list of actions to be executed before a field is formatted
`Vector<Action>`	`getKeystrokeActions()` Get the list of actions to be performed on a keystroke.
`Vector<Action>`	`getMouseDownActions()` Get the list of action to be executed on Mouse Down events as a Vector of Actions.
`Vector<Action>`	`getMouseEnteredActions()` Get the list of action to be executed on Mouse Entered events as a Vector of Actions.
`Vector<Action>`	`getMouseExitedActions()` Get the list of action to be executed on Mouse Exited events as a Vector of Actions.
`Vector<Action>`	`getMouseUpActions()` Get the list of action to be executed on Mouse Up events as a Vector of Actions.
`Vector<Action>`	`getPageCloseActions()` Get the list of actions to be performed when the page is closed.
`Vector<Action>`	`getPageOpenActions()` Get the list of actions to be performed when the page is opened.
`Vector<Action>`	`getValidateActions()` Get the list of actions to be performed when a field value is changed
`boolean`	`isModified()` Check to see if the TriggerActions object has been modified
`Vector<Action>`	`put(String key, Vector<Action> value)` Overrides Hashtable method to keep track of modifications.
`void`	`putAll(Map<? extends String,? extends Vector<Action>> t)`
`Vector<Action>`	`remove(Object key)` Overrides Hashtable method to keep track of modifications.
`void`	`setModified(boolean modified)` Set the modified status of TriggerActions

Methods inherited from class java.util.Hashtable
clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MOUSE_ENTERED
```
public static String MOUSE_ENTERED
```
  - MOUSE_EXITED
```
public static String MOUSE_EXITED
```
  - MOUSE_UP
```
public static String MOUSE_UP
```
  - MOUSE_DOWN
```
public static String MOUSE_DOWN
```
  - VALIDATE
```
public static String VALIDATE
```
  - CALCULATE
```
public static String CALCULATE
```
  - FORMAT
```
public static String FORMAT
```
  - KEYSTROKE
```
public static String KEYSTROKE
```
  - BLUR
```
public static String BLUR
```
  - FOCUS
```
public static String FOCUS
```
  - PAGE_OPEN
```
public static String PAGE_OPEN
```
  - PAGE_CLOSE
```
public static String PAGE_CLOSE
```
  - DOC_CLOSE
```
public static String DOC_CLOSE
```
  - DOC_WILL_SAVE
```
public static String DOC_WILL_SAVE
```
  - DOC_DID_SAVE
```
public static String DOC_DID_SAVE
```
  - DOC_WILL_PRINT
```
public static String DOC_WILL_PRINT
```
  - DOC_DID_PRINT
```
public static String DOC_DID_PRINT
```
- Constructor Detail
  - TriggerActions
```
public TriggerActions()
```
- Method Detail
  - getMouseEnteredActions
```
public Vector<Action> getMouseEnteredActions()
```
    Get the list of action to be executed on Mouse Entered events as a Vector of Actions.
  - getMouseExitedActions
```
public Vector<Action> getMouseExitedActions()
```
    Get the list of action to be executed on Mouse Exited events as a Vector of Actions.
  - getMouseDownActions
```
public Vector<Action> getMouseDownActions()
```
    Get the list of action to be executed on Mouse Down events as a Vector of Actions.
  - getMouseUpActions
```
public Vector<Action> getMouseUpActions()
```
    Get the list of action to be executed on Mouse Up events as a Vector of Actions.
  - getFormatActions
```
public Vector<Action> getFormatActions()
```
    Get the list of actions to be executed before a field is formatted
    
    Returns:
    
    Returns the list of actions that will be executed when formatting the field.
  - getValidateActions
```
public Vector<Action> getValidateActions()
```
    Get the list of actions to be performed when a field value is changed
    
    Returns:
    
    The list of actions that will be executed when validating the field.
  - getCalculateActions
```
public Vector<Action> getCalculateActions()
```
    Get the list of actions to be performed when another field changes
    
    Returns:
    
    The list of actions that will be executed when calculating the value of the field.
  - getKeystrokeActions
```
public Vector<Action> getKeystrokeActions()
```
    Get the list of actions to be performed on a keystroke.
    
    Returns:
    
    The list of actions to be executed when there is a keystroke on the field.
  - getBlurActions
```
public Vector<Action> getBlurActions()
```
    Get the list of actions to be performed on blur (focus lost).
    
    Returns:
    
    The list of actions when the field loses focus.
  - getFocusActions
```
public Vector<Action> getFocusActions()
```
    Get the list of actions to be performed when focus is gained.
    
    Returns:
    
    The list of actions when the field gains focus.
  - getPageOpenActions
```
public Vector<Action> getPageOpenActions()
```
    Get the list of actions to be performed when the page is opened.
    
    Returns:
    
    The list of actions to be performed when the page is opened.
  - getPageCloseActions
```
public Vector<Action> getPageCloseActions()
```
    Get the list of actions to be performed when the page is closed.
    
    Returns:
    
    The list of actions to be performed when the page is closed.
  - getDocCloseActions
```
public Vector<Action> getDocCloseActions()
```
    Get the list of actions to be performed when the document is closed.
    
    Returns:
    
    The list of actions to be performed when the document is closed.
  - getDocWillSaveActions
```
public Vector<Action> getDocWillSaveActions()
```
    Get the list of actions to be performed when the document will be saved.
    
    Returns:
    
    The list of actions to be performed when the document will be saved.
  - getDocDidSaveActions
```
public Vector<Action> getDocDidSaveActions()
```
    Get the list of actions to be performed when the document has been saved.
    
    Returns:
    
    The list of actions to be performed when the document has been saved.
  - getDocWillPrintActions
```
public Vector<Action> getDocWillPrintActions()
```
    Get the list of actions to be performed when the document will print.
    
    Returns:
    
    The list of actions to be performed when the document will print.
  - getDocDidPrintActions
```
public Vector<Action> getDocDidPrintActions()
```
    Get the list of actions to be performed when the document has printed.
    
    Returns:
    
    The list of actions to be performed when the document has printed.
  - remove
```
public Vector<Action> remove(Object key)
                      throws NullPointerException
```
    Overrides Hashtable method to keep track of modifications.
    
    Specified by:
    
    remove in interface Map<String,Vector<Action>>
    
    Overrides:
    
    remove in class Hashtable<String,Vector<Action>>
    
    Throws:
    
    NullPointerException
  - put
```
public Vector<Action> put(String key,
                          Vector<Action> value)
                   throws NullPointerException
```
    Overrides Hashtable method to keep track of modifications.
    
    Specified by:
    
    put in interface Map<String,Vector<Action>>
    
    Overrides:
    
    put in class Hashtable<String,Vector<Action>>
    
    Throws:
    
    NullPointerException
  - isModified
```
public boolean isModified()
```
    Check to see if the TriggerActions object has been modified
    
    Returns:
    
    boolean stating whether the TriggerActions have been modified
  - setModified
```
public void setModified(boolean modified)
```
    Set the modified status of TriggerActions
    
    Parameters:
    
    modified - A boolean representing whether or not the TriggerActions are being marked as modified
  - clear
```
public void clear()
```
    Overrides Hashtable method to keep track of modifications.
    
    Specified by:
    
    clear in interface Map<String,Vector<Action>>
    
    Overrides:
    
    clear in class Hashtable<String,Vector<Action>>
  - putAll
```
public void putAll(Map<? extends String,? extends Vector<Action>> t)
```
    Specified by:
    
    putAll in interface Map<String,Vector<Action>>
    
    Overrides:
    
    putAll in class Hashtable<String,Vector<Action>>

Class TriggerActions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

MOUSE_ENTERED

MOUSE_EXITED

MOUSE_UP

MOUSE_DOWN

VALIDATE

CALCULATE

FORMAT

KEYSTROKE

BLUR

FOCUS

PAGE_OPEN

PAGE_CLOSE

DOC_CLOSE

DOC_WILL_SAVE

DOC_DID_SAVE

DOC_WILL_PRINT

DOC_DID_PRINT

Constructor Detail

TriggerActions

Method Detail

getMouseEnteredActions

getMouseExitedActions

getMouseDownActions

getMouseUpActions

getFormatActions

getValidateActions

getCalculateActions

getKeystrokeActions

getBlurActions

getFocusActions

getPageOpenActions

getPageCloseActions

getDocCloseActions

getDocWillSaveActions

getDocDidSaveActions

getDocWillPrintActions

getDocDidPrintActions

remove

put

isModified

setModified

clear

putAll