de.softpro.signware.SPAcquire2 Class Reference
Inheritance diagram for de.softpro.signware.SPAcquire2:
List of all members.
Detailed Description
Acquire a signature / reference without GUI on the computer screen.
SPAcquire2 extends SPAcquire and adds support for javax.swing.Action objects and dispatches virtual button clicks to the registered actions.
- Operating Systems:
- Windows (Win32)
|
Public Member Functions |
| void | buttonCallback (int iId) |
| | Callback function called when a hardware button is pressed.
|
| java.awt.Color | getBackgroundColor () throws SPSignwareException |
| | Set the background color.
|
| java.awt.Color | getForegroundColor () throws SPSignwareException |
| | Set the foreground color of this canvas.
|
| void | rectCallback (int iId) |
| | Callback function called when a virtual button (rectangle) is clicked.
|
| void | registerButtonAction (int iId, javax.swing.Action action) |
| | Register an action for hardware button events.
|
| int | registerComponent (java.lang.String strDescription, javax.swing.Action action, int iId) throws SPSignwareException |
| | Register a rectangle in acquiry mode.
|
| int | registerComponent (byte[] baDescription, javax.swing.Action action, int iId) throws SPSignwareException |
| | Register a rectangle in acquiry mode.
|
| void | setBackgroundColor (java.awt.Color col) throws SPSignwareException |
| | Set the background color.
|
| void | setForegroundColor (java.awt.Color col) throws SPSignwareException |
| | Set the foreground color of this canvas.
|
| | SPAcquire2 () throws SPSignwareException |
| | Constructor.
|
| void | unregisterAllComponents () throws SPSignwareException |
| | Unregister all registered components.
|
| void | unregisterComponent (int iId) throws SPSignwareException |
| | Unregister a button component.
|
Constructor & Destructor Documentation
|
|
Constructor.
SPAcquire2 extends SPAcquire and uses javax.Swing.Action Objects to notify the aplication on virtual or hardware button events.
SPAcquire2 implements the methods rectCallback and buttonCallback and dispatches the events to the assigned actions.
An application that uses SPAcquire2 must call the appropriate implementation in SPAcquire2, if it overrides the methods rectCallback or buttonCallback.
- Operating Systems:
- Windows (Win32)
- See also:
- SPAcquireCreate
SPAcquire comments |
Member Function Documentation
| void de.softpro.signware.SPAcquire2.buttonCallback |
( |
int |
iId |
) |
|
|
| java.awt.Color de.softpro.signware.SPAcquire2.getBackgroundColor |
( |
|
) |
throws SPSignwareException |
|
|
|
Set the background color.
This is a convenience function for getPropertyInt("BackgroundColor")
- Returns:
- int: the background color
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- setBackgroundColor
|
| java.awt.Color de.softpro.signware.SPAcquire2.getForegroundColor |
( |
|
) |
throws SPSignwareException |
|
|
|
Set the foreground color of this canvas.
This is a convenience function for getPropertyInt("ForegroundColor")
- Returns:
- java.awt.Color, the foreground color
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- setForegroundColor, SPAcquireGetForegroundColor
|
| void de.softpro.signware.SPAcquire2.rectCallback |
( |
int |
iId |
) |
|
|
|
|
Callback function called when a virtual button (rectangle) is clicked.
- Parameters:
-
| iId | [i] Identifier of the clicked Rectangle |
- Note:
- The default implementation invokes the registered actions for the according rectangle (virtual button), see registerRect.
Reimplemented from de.softpro.signware.SPAcquire. |
| void de.softpro.signware.SPAcquire2.registerButtonAction |
( |
int |
iId, |
|
|
javax.swing.Action |
action |
|
) |
|
|
|
|
Register an action for hardware button events.
The action will be called when a hardware button is pressed on the tablet. The ID - assignment may depend on the connected tablet.
Please call registerComponent to create and register virtual buttons
- Parameters:
-
- See also:
- SPAcquireSetButtonListener, SPTabletSetButtonListener
|
| int de.softpro.signware.SPAcquire2.registerComponent |
( |
java.lang.String |
strDescription, |
|
|
javax.swing.Action |
action, |
|
|
int |
iId |
|
) |
throws SPSignwareException |
|
|
|
Register a rectangle in acquiry mode.
- Parameters:
-
| strDescription | [i] the XML description of the rectangle to be registered, sec_XML_Data, sec_VirtualButtonDescriptionDTD. The only supported encoding in the XML declaration is UTF-8 |
| action | [i] the action to call when the tablet clicks the component |
| iId | [i] a unique id of the registered rectangle. The unique number may not be 0.
- If iId is 0 then a new virtual button will be created. registerRect will return the actual Id that was assigned to the button.
- If iId is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
- If iId is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The Id of the new virtual button will be returned.
|
- Returns:
- int the registered unique id of the rectangle
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- SPAcquireRegisterRect2
unregisterComponent SPAcquire comments
|
| int de.softpro.signware.SPAcquire2.registerComponent |
( |
byte[] |
baDescription, |
|
|
javax.swing.Action |
action, |
|
|
int |
iId |
|
) |
throws SPSignwareException |
|
|
|
Register a rectangle in acquiry mode.
- Parameters:
-
| baDescription | [i] the XML description of the rectangle to be registered, sec_XML_Data, sec_VirtualButtonDescriptionDTD. Supported encodings in the XML declaration are ASCII, UTF-8, and ISO-8859-1 |
| action | [i] the action to call when the tablet clicks the component |
| iId | [i] a unique id of the registered rectangle.
- If iId is 0 then a new virtual button will be created. registerRect will return the actual Id that was assigned to the button.
- If iId is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
- If iId is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The Id of the new virtual button will be returned.
|
- Returns:
- int the registered unique id of the rectangle
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- SPAcquireRegisterRect2
unregisterComponent SPAcquire comments
|
| void de.softpro.signware.SPAcquire2.setBackgroundColor |
( |
java.awt.Color |
col |
) |
throws SPSignwareException |
|
|
|
Set the background color.
This is a convenience function for setPropertyInt("BackgroundColor")
- Parameters:
-
| col | [i] the background color |
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- getBackgroundColor
|
| void de.softpro.signware.SPAcquire2.setForegroundColor |
( |
java.awt.Color |
col |
) |
throws SPSignwareException |
|
|
|
Set the foreground color of this canvas.
This is a convenience function for setPropertyInt("ForegroundColor")
- Parameters:
-
| col | [i] the foreground color |
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- getForegroundColor
|
|
|
Unregister a button component.
- Note:
- The identification of a component is returned in the registerComponent call.
- Parameters:
-
| iId | [i] the id of the component to be unregistered, as returned by registerComonent |
- Exceptions:
-
- Operating Systems:
- Windows (Win32)
- See also:
- SPAcquireUnregisterRect
registerComponent, unregisterAllComponents
|
The documentation for this class was generated from the following file:
