Skip navigation links
A C D E F G H I M O P R S T V 

A

addConnectionListener(ConnectionListener) - Method in interface com.microfocus.zfe.haapi.Session
Registers a listener that will receive connection events from this Session instance.
addOIAListener(OIAListener) - Method in interface com.microfocus.zfe.haapi.ps.OIA
Adds an OIAListener instance that wishes to be notified of OIA events.
addPresentationSpaceListener(PresentationSpaceListener, PresentationSpaceEvent.Origin...) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Registers a listener to receive presentation space events from this PresentationSpace instance.
Attribute - Enum in com.microfocus.zfe.haapi.ps
Enumeration of all possible field and extended attributes for all host types.

C

changed(OIAChangedEvent) - Method in interface com.microfocus.zfe.haapi.ps.OIAListener
Called when the OIA status changes.
clearField() - Method in interface com.microfocus.zfe.haapi.ps.Field
Clears the current field in an emulation-specific manner.
Color - Enum in com.microfocus.zfe.haapi.ps
Enumeration of the supported host colors
com.microfocus.zfe.haapi - package com.microfocus.zfe.haapi
 
com.microfocus.zfe.haapi.ps - package com.microfocus.zfe.haapi.ps
 
com.microfocus.zfe.serversideevents.annotation - package com.microfocus.zfe.serversideevents.annotation
 
connect() - Method in interface com.microfocus.zfe.haapi.Session
Attempts a connection to the host.
ConnectionErrorEvent - Class in com.microfocus.zfe.haapi
Data carrier for connection error events.
ConnectionErrorEvent(Session, SessionException) - Constructor for class com.microfocus.zfe.haapi.ConnectionErrorEvent
Creates a new instance of this error object.
ConnectionListener - Interface in com.microfocus.zfe.haapi
The listener interface for receiving communications events.
ConnectionState - Enum in com.microfocus.zfe.haapi
Represent the different connection states.
connectionStateChanged(ConnectionStateChangedEvent) - Method in interface com.microfocus.zfe.haapi.ConnectionListener
Invoked whenever the connection state changes.
ConnectionStateChangedEvent - Class in com.microfocus.zfe.haapi
Data carrier for connection state events.
ConnectionStateChangedEvent(Session, ConnectionState) - Constructor for class com.microfocus.zfe.haapi.ConnectionStateChangedEvent
Creates a new instance of this event object.
contentChanged(ContentChangedEvent) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpaceListener
Event fired when a change occurs in the presentation space data
ContentChangedEvent - Class in com.microfocus.zfe.haapi.ps
Event fired when the contents of a PresentationSpace changes, either due to user activity or host activity.
ContentChangedEvent(PresentationSpace, PresentationSpaceEvent.Origin, Position, List<DataCell>) - Constructor for class com.microfocus.zfe.haapi.ps.ContentChangedEvent
 
ControlKey - Enum in com.microfocus.zfe.haapi.ps
String constants for the various key mnemonics that can be used in the PresentationSpace.sendKeys method.
cursorChanged(CursorChangedEvent) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpaceListener
Event fired when a cursor change occurs in the presentation space
CursorChangedEvent - Class in com.microfocus.zfe.haapi.ps
Event fired when the state of the presentation space cursor changes.
CursorChangedEvent(PresentationSpace, PresentationSpaceEvent.Origin, boolean, Position) - Constructor for class com.microfocus.zfe.haapi.ps.CursorChangedEvent
Constructor for generating a new CursorEvent.

D

DataCell - Interface in com.microfocus.zfe.haapi.ps
Represents a single row/col position in the presentation space and contains all data about that position
Dimension - Class in com.microfocus.zfe.haapi.ps
HAAPI Screen dimension object.
Dimension(int, int) - Constructor for class com.microfocus.zfe.haapi.ps.Dimension
Creates a new dimension instance.
disconnect() - Method in interface com.microfocus.zfe.haapi.Session
Disconnects from the host.

E

equals(Object) - Method in class com.microfocus.zfe.haapi.ps.Dimension
Checks whether two dimension objects have equal values (copied from java.awt.Dimension).
equals(Object) - Method in class com.microfocus.zfe.haapi.ps.Position
 
error(ConnectionErrorEvent) - Method in interface com.microfocus.zfe.haapi.ConnectionListener
Invoked whenever there is an error connecting/disconnecting the session
error(OIAErrorEvent) - Method in interface com.microfocus.zfe.haapi.ps.OIAListener
Called when an OIA related error occurs.
error(PresentationSpaceErrorEvent) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpaceListener
Fired when a presentation space related error occurs.

F

Field - Interface in com.microfocus.zfe.haapi.ps
Represents a field instance in the presentation space where the host types or the given screen supports fields.
FieldList - Interface in com.microfocus.zfe.haapi.ps
A FieldList contains a list of all the fields in the host presentation space.
findField(Position) - Method in interface com.microfocus.zfe.haapi.ps.FieldList
Returns the field containing the specified position.
findField(String, Position, PresentationSpace.SearchDirection) - Method in interface com.microfocus.zfe.haapi.ps.FieldList
Returns the field containing the specified text.

G

getAttributes() - Method in interface com.microfocus.zfe.haapi.ps.DataCell
Returns the set of attributes specified for this data cell instance.
getAttributes() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the set of attributes specified for this field instance.
getBackgroundColor() - Method in interface com.microfocus.zfe.haapi.ps.DataCell
Returns the background color for this data cell
getBackgroundColor() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the background color specified for this field instance
getCells() - Method in class com.microfocus.zfe.haapi.ps.ContentChangedEvent
Returns the list of DataCell instances associated with this update
getChar() - Method in interface com.microfocus.zfe.haapi.ps.DataCell
Returns the character associated with this cell
getCol() - Method in class com.microfocus.zfe.haapi.ps.Position
Returns the column of this position instance
getCols() - Method in class com.microfocus.zfe.haapi.ps.Dimension
 
getCommErrorCode() - Method in interface com.microfocus.zfe.haapi.ps.OIA
Returns the current comm error code
getCommErrorCode() - Method in class com.microfocus.zfe.haapi.ps.OIAChangedEvent
 
getConnectionState() - Method in interface com.microfocus.zfe.haapi.Session
Returns the current state of the host connection.
getCursorPosition() - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Returns a Position instance representing the current cursor position.
getDataCells() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns a list of data cell instances that are included in the field.
getDataCells() - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Returns a list of DataCell instances representing each position of the presentation space with the first member of the list being the first position on the host screen and the last member being the last position.
getDataCells(Position, int) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Returns a list of DataCell instances where the first member of the list will be for the position specified by the start parameter.
getDeviceName() - Method in interface com.microfocus.zfe.haapi.Session
This method will return the connected device name if available, or the configured device name, or null if no device name was configured.
getEnd() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the ending position of the field, which is the position in the presentation space containing the last character of the field.
getError() - Method in class com.microfocus.zfe.haapi.ConnectionErrorEvent
 
getError() - Method in class com.microfocus.zfe.haapi.ps.OIAErrorEvent
 
getEventOrigin() - Method in class com.microfocus.zfe.haapi.ps.PresentationSpaceEvent
Returns the event origin, either PresentationSpaceListener.Origin.USER or PresentationSpaceListener.PSEventTypeHOST
getFields() - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Returns a list of the fields in the presentation space.
getForegroundColor() - Method in interface com.microfocus.zfe.haapi.ps.DataCell
Returns the foreground color for this data cell
getForegroundColor() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the foreground color specified for this field instance
getLength() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the length of the field.
getMask() - Method in enum com.microfocus.zfe.haapi.ps.OIAStatus
Returns a bitmask for the OIA status that can be used for serialization of OIA status
getOIA() - Method in class com.microfocus.zfe.haapi.ps.OIAChangedEvent
 
getOIA() - Method in class com.microfocus.zfe.haapi.ps.OIAErrorEvent
 
getOIA() - Method in interface com.microfocus.zfe.haapi.Session
Returns the operator information area object (OIA) associated with the session.
getPosition() - Method in class com.microfocus.zfe.haapi.ps.ContentChangedEvent
Returns the starting position in the presentation space for this update
getPosition() - Method in class com.microfocus.zfe.haapi.ps.CursorChangedEvent
Returns the current cursor position
getPosition() - Method in interface com.microfocus.zfe.haapi.ps.DataCell
Return the position of this cell
getPresentationSpace() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the PresentationSpace instance which contains this field
getPresentationSpace() - Method in interface com.microfocus.zfe.haapi.ps.FieldList
Returns the PresentationSpace instance which created this field list
getPresentationSpace() - Method in class com.microfocus.zfe.haapi.ps.PresentationSpaceErrorEvent
 
getPresentationSpace() - Method in class com.microfocus.zfe.haapi.ps.PresentationSpaceEvent
Returns the PresentationSpace that generated the event
getPresentationSpace() - Method in interface com.microfocus.zfe.haapi.Session
Returns the presentation space object associated with the session.
getPresentationSpaceException() - Method in class com.microfocus.zfe.haapi.ps.PresentationSpaceErrorEvent
 
getProgErrorCode() - Method in interface com.microfocus.zfe.haapi.ps.OIA
Returns the current program error code
getProgErrorCode() - Method in class com.microfocus.zfe.haapi.ps.OIAChangedEvent
 
getRow() - Method in class com.microfocus.zfe.haapi.ps.Position
Returns the row of this position instance
getRows() - Method in class com.microfocus.zfe.haapi.ps.Dimension
 
getSession() - Method in class com.microfocus.zfe.haapi.ConnectionErrorEvent
 
getSession() - Method in class com.microfocus.zfe.haapi.ConnectionStateChangedEvent
 
getSize() - Method in class com.microfocus.zfe.haapi.ps.MetricsChangedEvent
Returns the current screen size
getSize() - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Returns the size of the screen as a Dimension object.
getStart() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the starting position of the field, which is the position of the first character of the field.
getState() - Method in class com.microfocus.zfe.haapi.ConnectionStateChangedEvent
 
getStatus() - Method in interface com.microfocus.zfe.haapi.ps.OIA
Returns the current OIA status as an EnumSet
getStatus() - Method in class com.microfocus.zfe.haapi.ps.OIAChangedEvent
 
getText() - Method in interface com.microfocus.zfe.haapi.ps.Field
Returns the text from the field.
getText(Position, int) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Returns a string representing a linear area of the presentation space.
getType() - Method in interface com.microfocus.zfe.haapi.Session
Returns the type of host session.

H

HaapiException - Exception in com.microfocus.zfe.haapi
 
HaapiException() - Constructor for exception com.microfocus.zfe.haapi.HaapiException
 
HaapiException(String) - Constructor for exception com.microfocus.zfe.haapi.HaapiException
 
HaapiException(String, Throwable) - Constructor for exception com.microfocus.zfe.haapi.HaapiException
 
HaapiException(Throwable) - Constructor for exception com.microfocus.zfe.haapi.HaapiException
 
hashCode() - Method in class com.microfocus.zfe.haapi.ps.Dimension
 
hashCode() - Method in class com.microfocus.zfe.haapi.ps.Position
 

I

InjectDependency - Annotation Type in com.microfocus.zfe.serversideevents.annotation
Annotation to tag a method in a server side event handler for dependency injection.
InvalidPositionException - Exception in com.microfocus.zfe.haapi.ps
Thrown when a position is encountered that is not part of the presentation space.
InvalidPositionException(String) - Constructor for exception com.microfocus.zfe.haapi.ps.InvalidPositionException
 
isConnected() - Method in interface com.microfocus.zfe.haapi.Session
Determines whether the connection to the host is connected and ready.
isCursorVisible() - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Tests if the cursor is currently visible in the presentation space.
isFieldDelimiter() - Method in interface com.microfocus.zfe.haapi.ps.DataCell
Tests if this cell represents a field delimiter.
isVisible() - Method in class com.microfocus.zfe.haapi.ps.CursorChangedEvent
Flag to indicate the current cursor visibility state

M

metricsChanged(MetricsChangedEvent) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpaceListener
Event fired when the host screen size changes
MetricsChangedEvent - Class in com.microfocus.zfe.haapi.ps
Event fired when the PresentationSpace size changes
MetricsChangedEvent(PresentationSpace, PresentationSpaceEvent.Origin, int, int) - Constructor for class com.microfocus.zfe.haapi.ps.MetricsChangedEvent
 

O

OIA - Interface in com.microfocus.zfe.haapi.ps
An OIA object represents the operator information area (OIA) of the host terminal session.
OIAChangedEvent - Class in com.microfocus.zfe.haapi.ps
Data carrier for OIA changed events.
OIAChangedEvent(OIA, Set<OIAStatus>, int, int) - Constructor for class com.microfocus.zfe.haapi.ps.OIAChangedEvent
Creates a new instance of the OIA changed event.
OIAErrorEvent - Class in com.microfocus.zfe.haapi.ps
Data carrier for OIA error events.
OIAErrorEvent(OIA, OIAException) - Constructor for class com.microfocus.zfe.haapi.ps.OIAErrorEvent
Creates a new instance of OIAErrorEvent.
OIAException - Exception in com.microfocus.zfe.haapi.ps
 
OIAException(String) - Constructor for exception com.microfocus.zfe.haapi.ps.OIAException
 
OIAListener - Interface in com.microfocus.zfe.haapi.ps
Listener interface to receive OIA events
Events are generated whenever any status indicator within OIA changes or an OIA related error occurs.
OIAStatus - Enum in com.microfocus.zfe.haapi.ps
Enumeration of the supported OIA status values.
origin - Variable in class com.microfocus.zfe.haapi.ps.PresentationSpaceEvent
The event origin

P

Position - Class in com.microfocus.zfe.haapi.ps
Represents a screenRows, column location
Position(int, int) - Constructor for class com.microfocus.zfe.haapi.ps.Position
Constructs a new Position instance
PresentationSpace - Interface in com.microfocus.zfe.haapi.ps
Contains information about a host screen and methods to interact with a host screen.
PresentationSpace.SearchDirection - Enum in com.microfocus.zfe.haapi.ps
Used for search related methods.
PresentationSpaceErrorEvent - Class in com.microfocus.zfe.haapi.ps
Event fired when a PresentationSpace related error occurs.
PresentationSpaceErrorEvent(PresentationSpace, PresentationSpaceException) - Constructor for class com.microfocus.zfe.haapi.ps.PresentationSpaceErrorEvent
Creates a new instance of this event object.
PresentationSpaceEvent - Class in com.microfocus.zfe.haapi.ps
Base class for events fired to notify listeners that something in the presentation space has changed.
PresentationSpaceEvent(PresentationSpace, PresentationSpaceEvent.Origin) - Constructor for class com.microfocus.zfe.haapi.ps.PresentationSpaceEvent
Constructor for generating a new PresentationSpaceEvent with a specific origin.
PresentationSpaceEvent.Origin - Enum in com.microfocus.zfe.haapi.ps
Used for listener registration as well indicating the event origin
PresentationSpaceException - Exception in com.microfocus.zfe.haapi.ps
 
PresentationSpaceException() - Constructor for exception com.microfocus.zfe.haapi.ps.PresentationSpaceException
 
PresentationSpaceException(String) - Constructor for exception com.microfocus.zfe.haapi.ps.PresentationSpaceException
 
PresentationSpaceException(String, Throwable) - Constructor for exception com.microfocus.zfe.haapi.ps.PresentationSpaceException
 
PresentationSpaceException(Throwable) - Constructor for exception com.microfocus.zfe.haapi.ps.PresentationSpaceException
 
PresentationSpaceListener - Interface in com.microfocus.zfe.haapi.ps
Implementations can register with a PresentationSpace instance to receive presentation space related events.
ProtectedFieldException - Exception in com.microfocus.zfe.haapi.ps
Thrown when an attempt is made to write to a protected host field.
ProtectedFieldException(String) - Constructor for exception com.microfocus.zfe.haapi.ps.ProtectedFieldException
 
ps - Variable in class com.microfocus.zfe.haapi.ps.PresentationSpaceEvent
 

R

removeConnectionListener(ConnectionListener) - Method in interface com.microfocus.zfe.haapi.Session
Unregisters an event listener that no longer wishes to receive connection events.
removeOIAListener(OIAListener) - Method in interface com.microfocus.zfe.haapi.ps.OIA
Removes an OIAListener instance so it will not longer receive OIA events
removePresentationSpaceListener(PresentationSpaceListener) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Unregisters a listener that no longer wishes to receive presentation space events from this PresentationSpace instance.

S

sendKeys(String) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Transmits a string and/or terminal keys to the host at the current cursor position in the presentation space.
Session - Interface in com.microfocus.zfe.haapi
A Session object represents a host session.
SessionCreated - Annotation Type in com.microfocus.zfe.serversideevents.annotation
Annotation to tag a method in a server side event handler for notification of session created.
SessionDestroyed - Annotation Type in com.microfocus.zfe.serversideevents.annotation
Annotation to tag a method in a server side event handler for notification of session destroyed.
SessionException - Exception in com.microfocus.zfe.haapi
 
SessionException() - Constructor for exception com.microfocus.zfe.haapi.SessionException
 
SessionException(String) - Constructor for exception com.microfocus.zfe.haapi.SessionException
 
SessionException(String, Throwable) - Constructor for exception com.microfocus.zfe.haapi.SessionException
 
SessionException(Throwable) - Constructor for exception com.microfocus.zfe.haapi.SessionException
 
SessionType - Enum in com.microfocus.zfe.haapi
The types of host sessions that are supported
setCursorPosition(Position) - Method in interface com.microfocus.zfe.haapi.ps.PresentationSpace
Moves the host cursor to the specified row and column position.
setDeviceName(String) - Method in interface com.microfocus.zfe.haapi.Session
Configure a new device name for the session.
setText(String) - Method in interface com.microfocus.zfe.haapi.ps.Field
Sets the field text.

T

toString() - Method in class com.microfocus.zfe.haapi.ConnectionErrorEvent
 
toString() - Method in enum com.microfocus.zfe.haapi.ConnectionState
 
toString() - Method in class com.microfocus.zfe.haapi.ConnectionStateChangedEvent
 
toString() - Method in class com.microfocus.zfe.haapi.ps.ContentChangedEvent
 
toString() - Method in enum com.microfocus.zfe.haapi.ps.ControlKey
 
toString() - Method in class com.microfocus.zfe.haapi.ps.CursorChangedEvent
 
toString() - Method in class com.microfocus.zfe.haapi.ps.Dimension
 
toString() - Method in class com.microfocus.zfe.haapi.ps.MetricsChangedEvent
 
toString() - Method in class com.microfocus.zfe.haapi.ps.OIAChangedEvent
 
toString() - Method in class com.microfocus.zfe.haapi.ps.OIAErrorEvent
 
toString() - Method in enum com.microfocus.zfe.haapi.ps.OIAStatus
 
toString() - Method in class com.microfocus.zfe.haapi.ps.Position
 
toString() - Method in enum com.microfocus.zfe.haapi.ps.PresentationSpace.SearchDirection
 
toString() - Method in class com.microfocus.zfe.haapi.ps.PresentationSpaceErrorEvent
 
toString() - Method in class com.microfocus.zfe.haapi.ps.PresentationSpaceEvent
 
toString() - Method in enum com.microfocus.zfe.haapi.SessionType
 

V

valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ConnectionState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ps.Attribute
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ps.Color
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ps.ControlKey
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ps.OIAStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ps.PresentationSpace.SearchDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.ps.PresentationSpaceEvent.Origin
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microfocus.zfe.haapi.SessionType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.microfocus.zfe.haapi.ConnectionState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.ps.Attribute
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.ps.Color
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.ps.ControlKey
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.ps.OIAStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.ps.PresentationSpace.SearchDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.ps.PresentationSpaceEvent.Origin
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microfocus.zfe.haapi.SessionType
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E F G H I M O P R S T V 
Skip navigation links

Copyright © 2020 Micro Focus. All rights reserved.