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

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.eNetwork.beans.HOD.event.HODEvent
              |
              +--com.ibm.eNetwork.beans.HOD.event.MacroExtractEvent
All Implemented Interfaces:
java.io.Serializable

public class MacroExtractEvent
extends com.ibm.eNetwork.beans.HOD.event.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 specified plane(s) in the bounding rectangle. Extracted text will be loaded into an array of strings (String []), where each row will be a string element in the array. All other plane data will be loaded into an array of char arrays (char[][]), where each row will be a char[] element in the array. This data is then synchronously fired in a MacroExtractEvent. Use the appropriate getData() call to obtain the extracted array.

See Also:
MacroRuntimeListener, Macro, Serialized Form

Constructor Summary
MacroExtractEvent(Macro src, java.lang.String n, java.lang.String[] d)
          Constructs a new MacroExtractEvent object.
MacroExtractEvent(Macro src, java.lang.String n, java.lang.String[] d, char[][] cd, char[][] fd, char[][] ed, char[][] dd, char[][] gd)
          Constructs a new MacroExtractEvent object.
 
Method Summary
 char[][] getColorData()
          Retrieve the color plane from the event
 java.lang.String[] getData()
          Retrieve the String array from the event.
 char[][] getDBCSData()
          Retrieve the dbcs plane from the event
 char[][] getExtendedFieldData()
          Retrieve the extended field plane from the event
 java.lang.String getExtractName()
          Retrieve the extract name from the event.
 char[][] getFieldData()
          Retrieve the field plane from the event
 char[][] getGridData()
          Retrieve the grid plane from the event
 com.ibm.eNetwork.ECL.ECLPS getPS()
          Retrieve the Host Access Class Library (HACL) presentation space object that was used by the Macro bean for the extract.
 void setPS(com.ibm.eNetwork.ECL.ECLPS argPS)
          Sets the Host Access Class Library (HACL) presentation space object that was used by the Macro bean for the extract.
 void trimBottomLines()
          Trims blank lines from the extract data string array return in getData.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MacroExtractEvent

public MacroExtractEvent(Macro src,
                         java.lang.String n,
                         java.lang.String[] d)
Constructs a new MacroExtractEvent object.
Parameters:
com.ibm.eNetwork.beans.HOD.Macro - src macro associated with the extract
String - n name of the extract
String[] - d data from the extract
See Also:
Macro

MacroExtractEvent

public MacroExtractEvent(Macro src,
                         java.lang.String n,
                         java.lang.String[] d,
                         char[][] cd,
                         char[][] fd,
                         char[][] ed,
                         char[][] dd,
                         char[][] gd)
Constructs a new MacroExtractEvent object.
Parameters:
com.ibm.eNetwork.beans.HOD.Macro - src macro associated with the extract
String - n name of the extract
String[] - d text data from the extract
char[][] - cd color data from the extract
char[][] - fd field data from the extract
char[][] - ed extended field data from the extract
char[][] - dd dbcs data from the extract
char[][] - gd grid data from the extract
See Also:
Macro
Method Detail

getData

public java.lang.String[] getData()
Retrieve the String array from the event.
Returns:
String [] Rows of data obtained from the Presentation Space.

getColorData

public char[][] getColorData()
Retrieve the color plane from the event
Returns:
char[][] Rows of color data obtained from the Presentation Space.

getFieldData

public char[][] getFieldData()
Retrieve the field plane from the event
Returns:
char[][] Rows of field data obtained from the Presentation Space.

getExtendedFieldData

public char[][] getExtendedFieldData()
Retrieve the extended field plane from the event
Returns:
char[][] Rows of extended field data obtained from the Presentation Space.

getDBCSData

public char[][] getDBCSData()
Retrieve the dbcs plane from the event
Returns:
char[][] Rows of dbcs data obtained from the Presentation Space.

getGridData

public char[][] getGridData()
Retrieve the grid plane from the event
Returns:
char[][] Rows of grid data obtained from the Presentation Space.

getPS

public com.ibm.eNetwork.ECL.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 retrieve more than just the basic lines of text from the screen. For example, you can call ECLPS.GetScreen with the appropriate parameters to retrieve color data, password protection data, etc.
Returns:
com.ibm.eNetwork.ECL.ECLPS HACL PS object that was used for the extract.
See Also:
ECLPS

setPS

public void setPS(com.ibm.eNetwork.ECL.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

trimBottomLines

public void trimBottomLines()
Trims blank lines from the extract data string array return in getData.

getExtractName

public java.lang.String getExtractName()
Retrieve the extract name from the event.
Returns:
String Name of the extract