com.ibm.ctg.epi

Class Screen

  • java.lang.Object
    • com.ibm.ctg.epi.Screen
  • All Implemented Interfaces:
    java.io.Serializable


    public class Screen
    extends java.lang.Object
    implements java.io.Serializable
    This class represents a 3270 terminal screen and provides methods to query and set screen information.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      Field field(int index)
      Gets a field by index.
      Field field(int row, int col)
      Gets a field by screen position.
      int fieldCount()
      Gets the number of fields.
      java.util.Enumeration fields()
      Returns an Enumeration of the fields in the screen.
      AID getAID()
      Gets the AID that will be sent back to the server.
      int getCursorColumn()
      Gets the column position of the cursor.
      int getCursorRow()
      Gets the row position of the cursor.
      int getDepth()
      Gets the screen depth.
      java.lang.String getEncoding()
      Returns the character encoding that the Screen will use.
      java.lang.String getMapName()
      Gets the map name for this screen.
      java.lang.String getMapSetName()
      Gets the map set name for this screen.
      int getWidth()
      Gets the screen width.
      void setAID(AID aidkey)
      Sets the AID that will be sent back to the server.
      void setCursor(int row, int column)
      Sets the cursor position.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getEncoding

        public java.lang.String getEncoding()
        Returns the character encoding that the Screen will use.
        Returns:
        the character encoding
      • fields

        public java.util.Enumeration fields()
        Returns an Enumeration of the fields in the screen.
        Returns:
        Enumeration of fields
      • field

        public Field field(int index)
        Gets a field by index. Fields are numbered from 1.
        Parameters:
        index - the index of the field
        Returns:
        the field or null if not found
      • field

        public Field field(int row,
                  int col)
        Gets a field by screen position.
        Parameters:
        row - the row
        col - the column
        Returns:
        the field or null if not found
      • fieldCount

        public int fieldCount()
        Gets the number of fields.
        Returns:
        the number of fields
      • getDepth

        public int getDepth()
        Gets the screen depth.
        Returns:
        the number of rows on the screen
      • getWidth

        public int getWidth()
        Gets the screen width.
        Returns:
        the number of columns on the screen
      • setAID

        public void setAID(AID aidkey)
        Sets the AID that will be sent back to the server.
        Parameters:
        aidkey - the AID to set
      • getAID

        public AID getAID()
        Gets the AID that will be sent back to the server.
        Returns:
        the currently set AID
      • setCursor

        public void setCursor(int row,
                     int column)
                       throws EPIException
        Sets the cursor position.
        Parameters:
        row - the cursor row
        column - the cursor column
        Throws:
        EPIException - if the row or column are out of range
      • getCursorRow

        public int getCursorRow()
        Gets the row position of the cursor.
        Returns:
        the row
      • getCursorColumn

        public int getCursorColumn()
        Gets the column position of the cursor.
        Returns:
        the column
      • getMapName

        public java.lang.String getMapName()
        Gets the map name for this screen.
        Returns:
        Map Name
      • getMapSetName

        public java.lang.String getMapSetName()
        Gets the map set name for this screen.
        Returns:
        Map Set Name
©Copyright IBM Corp. 1994, 2013
Legal