All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.event.MacroExtractEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.eNetwork.beans.HOD.event.HODEvent
                   |
                   +----com.ibm.eNetwork.beans.HOD.event.MacroExtractEvent

public class MacroExtractEvent
extends HODEvent
MacroExtractEvent is fired to MacroRuntimeListeners by Macro when it encounters an extract line in the macro. Any extract lines will cause Macro to retrieve the text in the bounding rectangle. This text will be loaded into an array of strings (String []), where each row will be a string element in the array. This data is then synchronously fired in a MacroExtractEvent. Use the getData() call to obtain the String array.

See Also:
MacroRuntimeListener, Macro

Constructor Index

 o MacroExtractEvent(Macro, String, String[])
Constructs a new MacroExtractEvent object.

Method Index

 o getData()
Retrieve the String array from the event.
 o getExtractName()
Retrieve the extract name from the event.
 o getPS()
Retrieve the Host Access Class Library (HACL) presentation space object that was used by the Macro bean for the extract.
 o setPS(ECLPS)
Sets the Host Access Class Library (HACL) presentation space object that was used by the Macro bean for the extract.
 o trimBottomLines()
Trims blank lines from the extract data string array return in getData.

Constructors

 o MacroExtractEvent
 public MacroExtractEvent(Macro src,
                          String n,
                          String d[])
Constructs a new MacroExtractEvent object.

Methods

 o getData
 public String[] getData()
Retrieve the String array from the event.

Returns:
String [] Rows of data obtained from the Presentation Space.
 o getPS
 public ECLPS getPS()
Retrieve the Host Access Class Library (HACL) presentation space object that was used by the Macro bean for the extract. Use the ECLPS object to retreive more than just the basic lines of text from the screen. For example, you can call ECLPS.GetScreen with the appropriate parameters to retreive color data, password protection data, etc.

Returns:
com.ibm.eNetwork.ECL.ECLPS HACL PS object that was used for the extract.
See Also:
ECLPS
 o setPS
 public void setPS(ECLPS argPS)
Sets the Host Access Class Library (HACL) presentation space object that was used by the Macro bean for the extract. This method is called by the Macro bean before it fires the event and is really of no use otherwise.

Parameters:
com.ibm.eNetwork.ECL.ECLPS - argPS HACL PS object that was used for the extract.
See Also:
ECLPS
 o trimBottomLines
 public void trimBottomLines()
Trims blank lines from the extract data string array return in getData.

 o getExtractName
 public String getExtractName()
Retrieve the extract name from the event.

Returns:
String Name of the extract

All Packages  Class Hierarchy  This Package  Previous  Next  Index