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


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD



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)

MacroExtractEvent



public 
MacroExtractEvent(
Macro src,
                         java.lang.String n,
                         java.lang.String[] d,
                         char[][] cd,
                         char[][] fd,
                         char[][] ed,
                         char[][] dd,
                         char[][] gd)


Method Detail

getData



public java.lang.String[] 
getData()

getColorData



public char[][] 
getColorData()

getFieldData



public char[][] 
getFieldData()

getExtendedFieldData



public char[][] 
getExtendedFieldData()

getDBCSData



public char[][] 
getDBCSData()

getGridData



public char[][] 
getGridData()

getPS



public com.ibm.eNetwork.ECL.ECLPS 
getPS()

setPS



public void 
setPS(com.ibm.eNetwork.ECL.ECLPS argPS)

trimBottomLines



public void 
trimBottomLines()

getExtractName



public java.lang.String 
getExtractName()


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD