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
-
MacroExtractEvent(Macro, String, String[])
- Constructs a new MacroExtractEvent object.
-
getData()
- Retrieve the String array from the event.
-
getExtractName()
- Retrieve the extract name from the event.
-
getPS()
- Retrieve the Host Access Class Library (HACL) presentation space object that
was used by the Macro bean for the extract.
-
setPS(ECLPS)
- Sets the Host Access Class Library (HACL) presentation space object that
was used by the Macro bean for the extract.
-
trimBottomLines()
- Trims blank lines from the extract data string array return in getData.
MacroExtractEvent
public MacroExtractEvent(Macro src,
String n,
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
getData
public String[] getData()
- Retrieve the String array from the event.
- Returns:
- String [] Rows of data obtained from the Presentation Space.
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 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(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 String getExtractName()
- Retrieve the extract name from the event.
- Returns:
- String Name of the extract
All Packages Class Hierarchy This Package Previous Next Index