screen
Class QScreenTerm

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Canvas
              |
              +--screen.QScreen
                    |
                    +--screen.QScreenTerm
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.lang.Runnable, java.io.Serializable
Direct Known Subclasses:
QScreenT27, QScreenUTS

public abstract class QScreenTerm
extends screen.QScreen

Quickware Terminal Screen

This class implements the programmatic interface to the java QTerm classes for accessing Unisys hosts. It is used by the QScreenBean for non-visual interfaces and also by the QTermJava applets for use as applets in browsers or as standalone java programs.

Notes for developers on using this class:

You atually create an instance of a class that is derived from QScreenTerm, for example QScreenUTS or QScreenT27, but the callable methods are all here.
There are many API calls you can invoke and several events that fire under specific conditions (see the QTermEventListener).

The simplest path to making a host connection would be to:

- Set the terminal name
- Issue the Connect, specifying the host parameters in a string
- Wait for connect confirmation, either by polling the interface
with calls to GetConnectionStatus(), by calling WaitConnected, or by
waiting for the OnConnected event to fire (note that you may receive
the OnConnectRequestRejected event instead)
- Send messages to the host and await responses

You can send a message to the host directly, bypassing the virtual screen by using the SendText method but this is unusual unless you are sure it is ok in your current context. The more usual manner is to simulate the keystrokes of a user by setting the screen position with MoveTo and calling the Display method to set the field text. As you can see in the documentation, there are many methods to navigate the screen, modeled on the capabilities of a terminal such as tabbing to the next tab position or moving to the home position.

When you have done setting the data in the required fields you can call the Xmit method to transmit the screen contents to the host. This is an important concept because the class takes care of all context knowledge and determines exactly which fields to transmit etc.

When a data response from the host is received two events are fired. The first is OnReceivedMessage which is not very interesting for most purposes. Then you will see the OnDisplayedMessage which means that the message has been processed and the virtual screen has been updated. Now is the time for you to retrieve data from the virtual screen. Again there are several methods to enable you to move around the screen and access data but the simplest one is GetRowText (or GetText). Only you know what the host response screen is supposed to contain so it is up to you to retrieve the required data and process accordingly.

When you are done simply call the Disconnect method.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class screen.QScreen
atChangeMask, atColSep, atEmProt, atEntryMask, atFCC, atFlash, atFull, atIniColr, atIntensity, atMalpha, atMnumeric, atMprotect, atMsetAttr, atMunprot, atNoChange, atNoTab, atOff, atReverse, atRight, atSOprot, atStrike, atUnder, CLOCKS_PER_SEC, COLORATTRMASK, COLORMASKS, ctsConnected, ctsConnecting, ctsDisconnected, ctsDisconnecting, DBL_CLICK_DISPLAY_SOE, DBL_CLICK_NONE, DBL_CLICK_QUICK_CLICK, DBL_CLICK_SELECT_WORD, DBL_CLICK_SEND, DBL_CLICK_XMIT, emAdd, emColSep, emNone, EMPH_ATTR_COLOR_MASK, emRemove, emSet, emStrike, emUnder, laControl, laFlash, laReverse, m_accelerators, m_appDef, m_defDest, m_javaVer, m_popup, m_popupCmds, m_popupMenusList, m_popupNamesList, m_props, m_showCmdsPopup, m_showCmdsPos, MAX_SCREEN_COLS, MAX_SCREEN_ROWS, MAX_TERM_PAGES, scmGraphic, scmMixed, scmText, SCREEN_DEF_REF, SCREEN_DOWN, SCREEN_FIELD_BUF_SIZE, SCREEN_MAX_RECALL_CMDS, SCREEN_MAX_RECALL_SIZE, SCREEN_NO_COLOR, SCREEN_NO_XMIT, SCREEN_TIME_RECONNECT, SCREEN_UP, tsLocal, tsRcv, tsXmit, xAll, xAttention, xBreak, xCancel, xChanged, xClose, xConHostPkt, xConnect, xCursor, xDeregister, xDiscAbort, xDisconnect, xHold, xMsg, xOpen, xParams, xRegister, xStatus, xStringZ, xTTYchar, xTTYdata, xVariable, xXmitFrom
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
QScreenTerm()
           
 
Method Summary
 void AddKey(int cmd, char key, boolean shift, boolean ctl, boolean alt, boolean ext)
           
 void addQTermEventListener(screen.QTermEventListener listener)
          Add a listener to the list of objects that are listening for events.
 int CaptureStart(java.lang.String captureFileName)
           
 void CaptureStop()
           
 void ClearCapture()
           
 int Connect(java.lang.String hostDefn)
          Establish a tcp/ip connection to the specified host
 void Copy()
          Copy current screen selection to the clipboard
 void CopyTable()
          Copy current screen selection to the clipboard as a tab separated table
 void Cut()
          Cut current screen selection and paste to the clipboard
 void DeleteInDisplay()
          Delete a character and move all following unprotected screen data back one position
 void DeleteInLine()
          Ddelete a character and move all following unprotected row data back one position
 void DeleteLine()
          Delete a line by moving screen up from current row
 void Disconnect()
          Disconnect from host
 void Display(java.lang.String pTextString)
          Display text on the screen at the current cursor position
 void DisplayAbout()
          Display an About dialog
 void DisplayFF()
          Display a FF (form feed) on the screen at the current cursor position
 void DisplayHelp()
          Display help information
 void DisplayLF()
          Display a LF (line feed) on the screen at the current cursor position
 void DisplayScroll(java.lang.String text, int row, boolean scrollBefore, boolean scrollAfter, boolean scrollUp)
          Display a string at the current cursor position and scroll screen
 void DisplaySOE()
          Display an SOE (start of entry) on the screen at the current cursor position
 void DisplayTab()
          Display a tab character on the screen at the current cursor position
 void DuplicateLine()
          Duplicate the current screen row
 void EraseCharacter()
          Erase character at current cursor position
 void EraseDisplay(boolean eraseCompletely)
          Erase the display, including protected data if eraseCompletely is true
 void EraseEOF()
          Erase unprotected dsta to end of field
 void EraseField()
          Erase unprotected data in the current field
 void EraseLine()
          Erase unprotected data in the current row to end of line
 void EraseUnprotected()
          Erase unprotected data from current cursor position to end of screen
 int FindKey(int key, boolean shift, boolean ctl, boolean alt, boolean ext)
           
 int FindText(java.lang.String pTextString)
          Find specified text
static java.lang.String getAboutInfo()
          Get AboutInfo setting
 int GetAttribute()
          Get attribute at the current cursor position
 int GetAttribute(int row, int col)
          Get attribute at the specified cursor position
 short[] GetAttributes(int startRow, int startCol, int endRow, int endCol)
          Get the attributes from the specified screen row(s)
 int GetBackColor()
          Get background color at currrent cursor position
 java.lang.String getCmdName(int cmd)
           
 byte[] GetColors(int startRow, int startCol, int endRow, int endCol)
          Get the colors from the specified screen row(s)
 int GetConnectionStatus()
          Get host connection status
 int GetCursorColumn()
          Get column position of cursor
 int GetCursorRow()
          Get row position of cursor
 java.lang.String GetFieldText(int maxBytes)
          Get the text from the current screen field
 int GetForeColor()
          Get foreground color at currrent cursor position
 boolean getKeyboardLocked()
          Get keyboard locked status
 java.lang.String getKeyName(char key, boolean shift, boolean ctl, boolean alt, boolean ext)
           
 int GetMsgArrivedCount()
          Get count of messages received from the host since the last time this check was made
 boolean getOptAutoAlign()
          Get AutoAlign setting
 boolean getOptAutoReconnect()
          Get AutoReconnect setting
 boolean getOptBackspaceNonDelete()
          Get BackspaceNonDelete setting
 boolean getOptBlockModeSelect()
          Get BlockModeSelect setting
 boolean getOptEraseOnDisconnect()
          Get EraseOnDisconnect setting
 boolean getOptFlashingCursor()
          Get FlashingCursor setting
 boolean getOptFontBold()
          Get FontBold option
 boolean getOptFontItalic()
          Get FontItalic option
 boolean getOptForceUpperCase()
          Get ForceUpperCase option
 boolean getOptFullErase()
          Get FullErase option
 boolean getOptIgnoreDollarMsgs()
          Get IgnoreDollarMsgs option
 boolean getOptInsertMode()
          Get InsertMode option
 boolean getOptInsertModeInDisp()
          Get InsertModeInDisp option
 boolean getOptNoCursorWrap()
          Get NoCursorWrap option
 boolean getOptNoFlashers()
          Get NoFlashers option
 boolean getOptNonDestructSpace()
          Get NonDestructiveSpace option
 boolean getOptPassThruPrinter()
          Get PassThruPrinter option
 boolean getOptPrintAll()
          Get PrintAll option
 boolean getOptShowAllCharacters()
          Get ShowAllCharacters option
 boolean getOptSmoothScroll()
          Get smooth scroll option
 boolean getOptUnderlineCursor()
          Get underline cursor option
 int getPageNumber()
          Get current screen page number
 int getPrtEolAction()
          Get print end of line action
 java.lang.String getPrtFontName()
          Get printer font name
 int getPrtFontSize()
          Get printer font size
 int getPrtLinesPerPage()
          Get lines per page setting
 boolean getPrtOnFormFeed()
          Get PrtOnFormFeed setting
 boolean getPrtOnPages()
          Get PrtOnPages setting
 boolean getPrtOnString()
          Get PrtOnString setting
 boolean getPrtOnTimeout()
          Get PrtOnTimeout option
 boolean getPrtOptIgnoreFF()
          Get PrtOptIgnoreFF option
 boolean getPrtOptIgnoreHostPrint()
          Get PrtOptIgnoreHostPrint setting
 boolean getPrtOptLandscape()
          Get landscape print option
 boolean getPrtOptMetricMargins()
           
 boolean getPrtOptNoBlankPages()
          Get PrtOptNoBlankPages option
 boolean getPrtOptNoFFafterPrint()
          Get PrtOptNoFFafterPrint setting
 boolean getPrtOptNoPrintDialog()
          Get PrtNoPrintDialog option
 boolean getPrtOptPassthruFilterDC2()
          Get PassthruFilterDC2 option
 boolean getPrtOptPassthruPrintEol()
          Get PassthruPrintEol option
 boolean getPrtOptPassthruPrintEscapes()
          Get PassthruPrintEscapes option
 boolean getPrtOptPrintToFile()
          Get current PrintToFile setting
 boolean getPrtOptShadowPrintFile()
           
 boolean getPrtOptStripTabs()
          Get PrtOptStripTabs option
 boolean getPrtOptTranslate()
          Get PrtOptTranslate option
 boolean getPrtOptTrashAfterFF()
          Get PrtOptTrashAfterFF option
 java.lang.String getPrtPrinterName()
          Get current printer name
 boolean getPrtPrintFileFF()
          Get PrintFileFF option
 java.lang.String getPrtTranslateFileName()
          Get printer translation file name
 int getPrtWhenPages()
          Get PrtWhenPages setting
 int getPrtWhenSeconds()
          Get PrtWhenSecondss setting
 java.lang.String getPrtWhenString()
          Get PrtWhenString setting
 int getPrtXparAction()
          Get XPAR action code
 java.lang.String GetRowText(int row, int startCol, int columns)
          Get the text from the specified screen row
 boolean getStatusMsgWait()
          Get MsgWait status
 int getTermAutoFont()
          AutoFont sizing
 int getTermBackColor(int fieldType)
          Get configured background color for specified field type
 int getTermColumns()
          Get number of screen columns
 java.lang.String getTermFontName()
          Get current font name
 int getTermFontSize()
          Get font size
 int getTermForeColor(int fieldType)
          Get configured foreground color for specified field type
 int GetTerminalStatus()
          Get T27 terminal status
 java.lang.String getTermLastHost()
          Get the name of the last host to which a connection was made
 java.lang.String getTermName()
          Get terminal name
 int getTermNetworkChar()
          Get NetworkChar setting
 int getTermPages()
          Get number of screen pages
 int getTermRows()
          Get number of screen rows
 int getTermType()
          Get terminal type
 int getTermXmitMode()
          Get terminal xmit mode
 java.lang.String GetText(int startRow, int startCol, int endRow, int endCol)
          Get the text from the specified screen row(s)
 short[] GetTextArray(int startRow, int startCol, int endRow, int endCol)
          Get the text from the specified screen row(s)
 void InputAttention()
          Call this method to simulate an attention message received from the host
 void InputData(byte[] pInputData, int byteCount)
          Call this method with a string that represents terminal datstream as received from the host
 void InsertInDisplay()
          Insert a space and move all following unprotected screen data forward one position
 void InsertInLine()
          Insert a space and move all following unprotected row data forward one position
 void InsertLine()
          Insert a new line by moving screen down from current row
 void LineSwapDown()
          Swap current row with the row below
 void LineSwapUp()
          Swap current row with the row above
 void MoveBackspace()
          Backspace
 void MoveBackTab()
          Back tab
 void MoveDown()
          Move cursor down
 void MoveHome()
          Move to home position
 void MoveLeft()
          Move cursor left
 void MoveReturn()
          Move to first unprotected position on next row
 void MoveRight()
          Move cursor right
 void MoveScrollUp()
          Scroll the screen up
 void MoveTab()
          Tab forward
 void MoveTo(int row, int col)
          Move to specified row and column
 void MoveToEOF()
          Move to end of field
 void MoveToLineBegin()
          Move to beginning of current row
 void MoveToLineEnd()
          Move to end of text on current row
 void MoveToUnprotected()
          Move forward to unprotected data
 void MoveUp()
          Move cursor up
 void NextPage()
          Display next page
 void NextRecall()
          Display next command recall string at cursor position
 void Paste()
          Paste text from the clipboard to the screen at the current cursor position
 void PreviousPage()
          Display previous page
 void PreviousRecall()
          Display previous command recall string at cursor position
 void PrintCancel()
          Abort any current printing
 void PrintEject()
          Terminate any current printing
 void PrintFromSOE()
          Print the screen from the SOE to the cursor position
 void PrintPageSetup()
          Display print set up dialog
 void PrintScreen()
          Print the screen
 void PrintSelected()
          Print the currently selected screen text
 void PrintToFile()
          Begin printing to file
 boolean RemoveKey(int cmd, char key, boolean shift, boolean ctl, boolean alt, boolean ext)
           
 void removeQTermEventListener(screen.QTermEventListener listener)
          Remove the listener for list of objects that are listening for events.
 void Reset()
          Reset the terminal screen
 void ResumeInput()
          Allow host input to resume if previously stoppped by StopInput
 void RollDown()
          Roll screen down one line and move bottom row to the top
 void RollUp()
          Roll screen up one line and move top row to the bottom
 void SelectDown()
          Emulate drag select down
 void SelectLeft()
          Emulate drag select to the left
 void SelectRight()
          Emulate drag select to the right
 void SelectUp()
          Emulate drag select up
 int SendFkey(int keyNumber)
          Send a function key to the host
 void SendMsgWait()
          Send a MsgWait to the host
 int SendText(java.lang.String pTextString)
          Send string to host without displaying it on the screen
 void setOptAutoAlign(boolean bNewValue)
          Set AutoAlign, if true then the screen will be scrolled if necessary to display the current cursor position
 void setOptAutoReconnect(boolean bNewValue)
          Set AutoReconnect, if true then the tcp connection will be re-attempted if the host disconnects
 void setOptBackspaceNonDelete(boolean bNewValue)
          Set BackspaceNonDelete option, if true this allows backspacing without deleting characters (functions like cursor left)
 void setOptBlockModeSelect(boolean bNewValue)
          Set BlockModeSelect option to drag select in block mode
 void setOptEraseOnDisconnect(boolean bNewValue)
          Set EraseOnDisconnect to erase the screen when disconnected from the host
 void setOptFireScreenUpdates(boolean bNewValue)
          Set FireScreenUpdates to fire ScreenUpdate events, note that ScreenUpdate events are always fired if there is no graphics context (the screen is hidden)
 void setOptFlashingCursor(boolean bNewValue)
          Set FlashingCursor option to make the screen cursor flash
 void setOptFontBold(boolean bNewValue)
          Set FontBold option to display screen text in bold font
 void setOptFontItalic(boolean bNewValue)
          Set FontItalic option to display screen text in italic font
 void setOptForceUpperCase(boolean bNewValue)
          Set ForceUpperCase option to force all keyboard input to upper case
 void setOptFullErase(boolean bNewValue)
          Set FullErase option to clear all protected and unprotected data when using clear screen
 void setOptIgnoreDollarMsgs(boolean bNewValue)
          Set IgnoreDollarMsgs option to ignore network control messages that start with $$ (eg $$OPEN)
 void setOptInsertMode(boolean bNewValue)
          Set InsertMode option, to move row characters to the right when typing
 void setOptInsertModeInDisp(boolean bNewValue)
          Set InsertModeInDisp option, to move all characters to the right when typing
 void setOptNoCursorWrap(boolean bNewValue)
          Set NoCursorWrap option, to prevent cursor at end of screen wrapping to the home position
 void setOptNoFlashers(boolean bNewValue)
          Set NoFlashers option, to inhibit any flashing fields
 void setOptNonDestructSpace(boolean bNewValue)
          Set NonDestructiveSpace option, to not delete characters when pressing the space bar (acts like cursor right)
 void setOptPassThruPrinter(boolean bNewValue)
          Set PassThruPrinter option, to make the terminal function like a passthru printer
 void setOptPrintAll(boolean bNewValue)
          Set PrintAll, true if every received message is to be printed
 void setOptShowAllCharacters(boolean bNewValue)
          Set ShowAllCharacters option, to display characters that are normally hidden such as tabs and CRs
 void setOptSmoothScroll(boolean bNewValue)
          Set smooth scroll
 void setOptUnderlineCursor(boolean bNewValue)
          Set underline cursor option
 void setPrtEolAction(int prtEolAction)
          Set PrtEolAction to control the printing action at the end of a line
 void setPrtFontName(java.lang.String lpszNewValue)
          Set printer font name
 void setPrtFontSize(int nNewValue)
          Set printer font size
 void setPrtLinesPerPage(int nNewValue)
          Set lines per page, set to zero to allow automatic caLculation
 void setPrtOnFormFeed(boolean bNewValue)
          Set PrtOnFormFeed option to begin printing when a form feed character is received
 void setPrtOnPages(boolean bNewValue)
          Set PrtOnPages option to start printing after a specified number of pages have been spooled
 void setPrtOnString(boolean bNewValue)
          Set PrtOnString option to start printing when a specified string is received
 void setPrtOnTimeout(boolean bNewValue)
          Set PrtOnTimeout to start printing after a specified time of no print data
 void setPrtOptIgnoreFF(boolean bNewValue)
          Set PrtOptIgnoreFF to ignore FF characters when printing
 void setPrtOptIgnoreHostPrint(boolean bNewValue)
          Set PrtOptIgnoreHostPrint to ignore all host printing
 void setPrtOptLandscape(boolean bNewValue)
          Set landscape print option
 void setPrtOptMetricMargins(boolean bNewValue)
           
 void setPrtOptNoBlankPages(boolean bNewValue)
          Set PrtOptNoBlankPagesto skip any blank pages
 void setPrtOptNoFFafterPrint(boolean bNewValue)
          Set PrtOptNoFFafterPrint to keep the print spool open
 void setPrtOptNoPrintDialog(boolean bNewValue)
          Set PrtNoPrintDialog to inhibit display of the print dialog
 void setPrtOptPassthruFilterDC2(boolean bNewValue)
          Set PassthruFilterDC2 option
 void setPrtOptPassthruPrintEol(boolean bNewValue)
          Set PassthruPrintEol option
 void setPrtOptPassthruPrintEscapes(boolean bNewValue)
          Set PassthruPrintEscapes option
 void setPrtOptPrintToFile(boolean printToFile)
          Set PrintToFile
 void setPrtOptShadowPrintFile(boolean bNewValue)
           
 void setPrtOptStripTabs(boolean bNewValue)
          Set PrtOptStripTabs to ignore yabs when printing
 void setPrtOptTranslate(boolean bNewValue)
          Set PrtOptTranslateto enable print data translation
 void setPrtOptTrashAfterFF(boolean bNewValue)
          Set PrtOptTrashAfterFF to ignore all data after FF
 void setPrtPrinterName(java.lang.String lpszNewValue)
          Set printer name
 void setPrtPrintFileFF(boolean bNewValue)
          Set PrintFileFF option to write received form feeds to file when printing to file
 void setPrtTranslateFileName(java.lang.String lpszNewValue)
          Set printer translation file name to translate printed characters
 void setPrtWhenPages(int nNewValue)
          Set page count when start printing
 void setPrtWhenSeconds(int nNewValue)
          Set number of seconds of no print activity before printing is to start
 void setPrtWhenString(java.lang.String lpszNewValue)
          Set string to check whether to start on printing
 void setPrtXparAction(int nNewValue)
          Set XPAR action code
 void setTermAutoFont(int autoFont)
          Set auto font sizing
 void setTermBackColor(int fieldType, int color, boolean overrideHostColor)
          Set configured background color for specified field type
 void setTermColumns(int columns)
          Set number of screen columns
 void setTermFontName(java.lang.String fontName)
          Set screen font name
 void setTermFontSize(int size)
          Set font size
 void setTermForeColor(int fieldType, int color, boolean overrideHostColor)
          Set configured foreground color for specified field type
 void setTermLastHost(java.lang.String host)
          Set the name of the last host to which a connection was made
 void setTermName(java.lang.String termName)
          Set terminal name as required by host
 void setTermNetworkChar(int networkChar)
          Set NetworkChar character, used to recognize network message susch as $$OPEN, the default character is a $ sign
 void setTermPages(int pages)
          Set number of screen pages
 void setTermRows(int rows)
          Set number of screen rows
 void setTermType(int termType)
          Set terminal type
 void setTermXmitMode(int xmitMode)
          Set terminal xmit mode
 int StartTrace(java.lang.String fileName)
          Start tracing events to specified file
 void StopInput()
          Temporarily suspend host input
 void StopTrace()
          Stop tracing
 void SwitchPage(int pageNum)
          Switch terminal page
 void ToggleTrace(java.lang.String fileName)
          Toggle tracing on/off
 void UnlockKeyboard()
          Unlock keyboard
 boolean Wait(int timeout)
          Wait for a message to arrive from the host
 boolean WaitConnected(boolean needConnected, int timeout)
          Wait to connect or to disconnect
 boolean WaitScreenText(int row, int col, java.lang.String text, int timeout)
          Wait for specified text at the given screen position
 void Xmit()
          Transmit screen to host
 
Methods inherited from class screen.QScreen
actionPerformed, DumpScreen, OnKey, OnMouseDragged, OnMousePressed, OnMouseReleased, paint, processEvent, run, scrLogCommand, scrLogCommand, start, stop, Timer
 
Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QScreenTerm

public QScreenTerm()
Method Detail

addQTermEventListener

public void addQTermEventListener(screen.QTermEventListener listener)
Add a listener to the list of objects that are listening for events.

Parameters:
listener - QTermEventListener

removeQTermEventListener

public void removeQTermEventListener(screen.QTermEventListener listener)
Remove the listener for list of objects that are listening for events.

Parameters:
listener - QTermEventListener

CaptureStart

public int CaptureStart(java.lang.String captureFileName)

CaptureStop

public void CaptureStop()

ClearCapture

public void ClearCapture()

Connect

public int Connect(java.lang.String hostDefn)
Establish a tcp/ip connection to the specified host

Parameters:
hostDefn - Host definition string

   where the hostDefn is defined as:

      hostname,appname,IPadr,port,transport(T),csuname

	       hostname  = a name for reference only
	       appname   = the host app name (eg TIP), anything for T27
	       IPadr     = either an IP address or a domain name
	       port      = tcp port number (eg 102 for UTS, 23 for T27)
	       transport = typically T(tcp) or D(dcp) for older UTS systems, not needed for T27
	       csuname   = CSU name (eg TIPCSU or RSDCSU), not needed for T27
Returns:
Result of connection attempt, 0=no error

Copy

public void Copy()
Copy current screen selection to the clipboard


CopyTable

public void CopyTable()
Copy current screen selection to the clipboard as a tab separated table


Cut

public void Cut()
Cut current screen selection and paste to the clipboard


DeleteInDisplay

public void DeleteInDisplay()
Delete a character and move all following unprotected screen data back one position


DeleteInLine

public void DeleteInLine()
Ddelete a character and move all following unprotected row data back one position


DeleteLine

public void DeleteLine()
Delete a line by moving screen up from current row


Disconnect

public void Disconnect()
Disconnect from host


Display

public void Display(java.lang.String pTextString)
Display text on the screen at the current cursor position

Parameters:
pTextString - Text string to display

DisplayAbout

public void DisplayAbout()
Display an About dialog

Specified by:
DisplayAbout in class screen.QScreen

DisplayHelp

public void DisplayHelp()
Display help information

Specified by:
DisplayHelp in class screen.QScreen

DisplayFF

public void DisplayFF()
Display a FF (form feed) on the screen at the current cursor position


DisplayLF

public void DisplayLF()
Display a LF (line feed) on the screen at the current cursor position


DisplayScroll

public void DisplayScroll(java.lang.String text,
                          int row,
                          boolean scrollBefore,
                          boolean scrollAfter,
                          boolean scrollUp)
Display a string at the current cursor position and scroll screen

Parameters:
text - String to display
row - Scroll row number
scrollBefore - True/False
scrollAfter - True/False
scrollUp - True/False

DisplaySOE

public void DisplaySOE()
Display an SOE (start of entry) on the screen at the current cursor position


DisplayTab

public void DisplayTab()
Display a tab character on the screen at the current cursor position


DuplicateLine

public void DuplicateLine()
Duplicate the current screen row


EraseCharacter

public void EraseCharacter()
Erase character at current cursor position


EraseDisplay

public void EraseDisplay(boolean eraseCompletely)
Erase the display, including protected data if eraseCompletely is true

Parameters:
eraseCompletely - True/False

EraseEOF

public void EraseEOF()
Erase unprotected dsta to end of field


EraseField

public void EraseField()
Erase unprotected data in the current field


EraseLine

public void EraseLine()
Erase unprotected data in the current row to end of line


EraseUnprotected

public void EraseUnprotected()
Erase unprotected data from current cursor position to end of screen


FindText

public int FindText(java.lang.String pTextString)
Find specified text

Parameters:
pTextString - Text to search for
Returns:
True/False

GetAttribute

public int GetAttribute()
Get attribute at the current cursor position

Returns:
Attribute value
      atEntryMask     = 0x0003   // entry mask (none,alpha,num,prot)
      atMunprot       = 0x00     //  - unprotected
      atMalpha        = 0x01     //  - alpha only
      atMnumeric      = 0x02     //  - numeric only
      atMprotect      = 0x03     //  - protected field
      atRight         = 0x0004   // right justified field
      atFlash         = 0x0008   // flashing field
      atOff           = 0x0010   // video off
      atReverse       = 0x0020   // reverse video
      atNoChange      = 0x0040   // not a changed field
      atNoTab         = 0x0080   // no tab stop here
      atColSep        = 0x0100   // column separator
      atEmProt        = 0x0200   // special emphasis protect
      atUnder         = 0x0400   // underscore
      atStrike        = 0x0800   // strike through
      atSOprot        = 0x1000   // SO protected (or T27 prot xmit)
      atFull          = 0x2000   // right justified field is full
      atIntensity     = 0x4000   // alternate intensity
      atFCC           = 0x8000   // there's an FCC here 

GetAttribute

public int GetAttribute(int row,
                        int col)
Get attribute at the specified cursor position

Parameters:
row - Row number
col - Column number
Returns:
Attribute value
      atEntryMask     = 0x0003   // entry mask (none,alpha,num,prot)
      atMunprot       = 0x00     //  - unprotected
      atMalpha        = 0x01     //  - alpha only
      atMnumeric      = 0x02     //  - numeric only
      atMprotect      = 0x03     //  - protected field
      atRight         = 0x0004   // right justified field
      atFlash         = 0x0008   // flashing field
      atOff           = 0x0010   // video off
      atReverse       = 0x0020   // reverse video
      atNoChange      = 0x0040   // not a changed field
      atNoTab         = 0x0080   // no tab stop here
      atColSep        = 0x0100   // column separator
      atEmProt        = 0x0200   // special emphasis protect
      atUnder         = 0x0400   // underscore
      atStrike        = 0x0800   // strike through
      atSOprot        = 0x1000   // SO protected (or T27 prot xmit)
      atFull          = 0x2000   // right justified field is full
      atIntensity     = 0x4000   // alternate intensity
      atFCC           = 0x8000   // there's an FCC here 

GetAttributes

public short[] GetAttributes(int startRow,
                             int startCol,
                             int endRow,
                             int endCol)
Get the attributes from the specified screen row(s)

Parameters:
startRow - Start row
startCol - Start column
endRow - End row
endCol - End column
Returns:
Screen attributes (see GetAttribute)

GetColors

public byte[] GetColors(int startRow,
                        int startCol,
                        int endRow,
                        int endCol)
Get the colors from the specified screen row(s)

Parameters:
startRow - Start row
startCol - Start column
endRow - End row
endCol - End column
Returns:
Screen colors array (see getTermForeColor). Each color entry is a single byte, the high order four bits are the background color index and the low order four bits are the foreground color index

GetForeColor

public int GetForeColor()
Get foreground color at currrent cursor position

Returns:
The color index (see getTermForeColor)

GetBackColor

public int GetBackColor()
Get background color at currrent cursor position

Returns:
The color index (see getTermForeColor)

GetCursorRow

public int GetCursorRow()
Get row position of cursor

Returns:
Row number

GetCursorColumn

public int GetCursorColumn()
Get column position of cursor

Returns:
Column number

GetConnectionStatus

public int GetConnectionStatus()
Get host connection status

Returns:
Connection status
 ctsDisconnected	= 0
 ctsConnecting	= 1
 ctsConnected	    = 2
 tsDisconnecting	= 3

GetTerminalStatus

public int GetTerminalStatus()
Get T27 terminal status

Returns:
terminal status
 0	= Rcv
 1	= Local
 2	= xmit

getKeyboardLocked

public boolean getKeyboardLocked()
Get keyboard locked status

Returns:
True if keyboard is locked

GetMsgArrivedCount

public int GetMsgArrivedCount()
Get count of messages received from the host since the last time this check was made

Returns:
Message count

GetFieldText

public java.lang.String GetFieldText(int maxBytes)
Get the text from the current screen field

Parameters:
maxBytes - maximum number of bytes to return
Returns:
Field text

GetRowText

public java.lang.String GetRowText(int row,
                                   int startCol,
                                   int columns)
Get the text from the specified screen row

Parameters:
row - Row number
startCol - Start column
columns - Number of columns
Returns:
Row Text

GetText

public java.lang.String GetText(int startRow,
                                int startCol,
                                int endRow,
                                int endCol)
Get the text from the specified screen row(s)

Parameters:
startRow - Start row
startCol - Start column
endRow - End row
endCol - End column
Returns:
Screen text

GetTextArray

public short[] GetTextArray(int startRow,
                            int startCol,
                            int endRow,
                            int endCol)
Get the text from the specified screen row(s)

Parameters:
startRow - Start row
startCol - Start column
endRow - End row
endCol - End column
Returns:
Screen text as an array of shorts

InputData

public void InputData(byte[] pInputData,
                      int byteCount)
Call this method with a string that represents terminal datstream as received from the host

Parameters:
pInputData - Input data
byteCount - Number of bytes

InputAttention

public void InputAttention()
Call this method to simulate an attention message received from the host


InsertInDisplay

public void InsertInDisplay()
Insert a space and move all following unprotected screen data forward one position


InsertInLine

public void InsertInLine()
Insert a space and move all following unprotected row data forward one position


InsertLine

public void InsertLine()
Insert a new line by moving screen down from current row


LineSwapDown

public void LineSwapDown()
Swap current row with the row below


LineSwapUp

public void LineSwapUp()
Swap current row with the row above


MoveBackspace

public void MoveBackspace()
Backspace


MoveBackTab

public void MoveBackTab()
Back tab


MoveDown

public void MoveDown()
Move cursor down


MoveHome

public void MoveHome()
Move to home position


MoveLeft

public void MoveLeft()
Move cursor left


MoveReturn

public void MoveReturn()
Move to first unprotected position on next row


MoveRight

public void MoveRight()
Move cursor right


MoveTo

public void MoveTo(int row,
                   int col)
Move to specified row and column

Parameters:
row - Row number
col - Column number

MoveToEOF

public void MoveToEOF()
Move to end of field


MoveUp

public void MoveUp()
Move cursor up


MoveScrollUp

public void MoveScrollUp()
Scroll the screen up


MoveTab

public void MoveTab()
Tab forward


MoveToLineEnd

public void MoveToLineEnd()
Move to end of text on current row


MoveToLineBegin

public void MoveToLineBegin()
Move to beginning of current row


MoveToUnprotected

public void MoveToUnprotected()
Move forward to unprotected data


NextPage

public void NextPage()
Display next page


NextRecall

public void NextRecall()
Display next command recall string at cursor position


PreviousPage

public void PreviousPage()
Display previous page


PreviousRecall

public void PreviousRecall()
Display previous command recall string at cursor position


Paste

public void Paste()
Paste text from the clipboard to the screen at the current cursor position


PrintScreen

public void PrintScreen()
Print the screen


PrintFromSOE

public void PrintFromSOE()
Print the screen from the SOE to the cursor position


PrintSelected

public void PrintSelected()
Print the currently selected screen text


PrintEject

public void PrintEject()
Terminate any current printing


PrintCancel

public void PrintCancel()
Abort any current printing


PrintToFile

public void PrintToFile()
Begin printing to file


PrintPageSetup

public void PrintPageSetup()
Display print set up dialog


Reset

public void Reset()
Reset the terminal screen


ResumeInput

public void ResumeInput()
Allow host input to resume if previously stoppped by StopInput


RollDown

public void RollDown()
Roll screen down one line and move bottom row to the top


RollUp

public void RollUp()
Roll screen up one line and move top row to the bottom


SelectLeft

public void SelectLeft()
Emulate drag select to the left


SelectRight

public void SelectRight()
Emulate drag select to the right


SelectDown

public void SelectDown()
Emulate drag select down


SelectUp

public void SelectUp()
Emulate drag select up


SendFkey

public int SendFkey(int keyNumber)
Send a function key to the host

Parameters:
keyNumber - Function key number (1-22)
Returns:
Result, 0=no error

SendMsgWait

public void SendMsgWait()
Send a MsgWait to the host


SendText

public int SendText(java.lang.String pTextString)
Send string to host without displaying it on the screen

Parameters:
pTextString - Text string
Returns:
Result, 0=no error

StartTrace

public int StartTrace(java.lang.String fileName)
Start tracing events to specified file

Parameters:
fileName - Full or relative file parh
Returns:
Result, 0=no error

StopTrace

public void StopTrace()
Stop tracing


SwitchPage

public void SwitchPage(int pageNum)
Switch terminal page

Parameters:
pageNum - Required page number

ToggleTrace

public void ToggleTrace(java.lang.String fileName)
Toggle tracing on/off

Specified by:
ToggleTrace in class screen.QScreen
Parameters:
fileName - Trace file name, leave blank for default

StopInput

public void StopInput()
Temporarily suspend host input


UnlockKeyboard

public void UnlockKeyboard()
Unlock keyboard


Xmit

public void Xmit()
Transmit screen to host


getTermAutoFont

public int getTermAutoFont()
AutoFont sizing

Returns:
AutoFont sizing if true

setTermAutoFont

public void setTermAutoFont(int autoFont)
Set auto font sizing

Parameters:
autoFont - Non-zero for auto font sizing

getTermColumns

public int getTermColumns()
Get number of screen columns

Returns:
Number of screen columns

setTermColumns

public void setTermColumns(int columns)
Set number of screen columns

Parameters:
columns - Number of screen columns

getTermFontSize

public int getTermFontSize()
Get font size

Returns:
Font size

setTermFontSize

public void setTermFontSize(int size)
Set font size

Parameters:
size - Font size

getTermLastHost

public java.lang.String getTermLastHost()
Get the name of the last host to which a connection was made

Returns:
Host name

setTermLastHost

public void setTermLastHost(java.lang.String host)
Set the name of the last host to which a connection was made

Parameters:
host - Host name

getTermName

public java.lang.String getTermName()
Get terminal name

Returns:
Terminal name

setTermName

public void setTermName(java.lang.String termName)
Set terminal name as required by host

Parameters:
termName - Terminal name

getTermFontName

public java.lang.String getTermFontName()
Get current font name

Returns:
Font name

setTermFontName

public void setTermFontName(java.lang.String fontName)
Set screen font name

Parameters:
fontName - Font name (must be a fixed width font)

getTermForeColor

public int getTermForeColor(int fieldType)
Get configured foreground color for specified field type

Parameters:
fieldType - The field type index
  COLOR_FIELD_UNPROT          = 0
  COLOR_FIELD_UNPROT_LOW      = 1
  COLOR_FIELD_ALPHA           = 2
  COLOR_FIELD_ALPHA_LOW       = 3
  COLOR_FIELD_NUM             = 4
  COLOR_FIELD_NUM_LOW         = 5
  COLOR_FIELD_PROT            = 6
  COLOR_FIELD_PROT_LOW        = 7
  COLOR_FIELD_PROTXMIT        = 8
  COLOR_FIELD_SECURE          = 9
  COLOR_FIELD_SECURE_LOW      = 10
  COLOR_FIELD_RIGHT           = 11
  COLOR_FIELD_RIGHT_LOW       = 12
  COLOR_FIELD_REVERSE         = 13
  COLOR_FIELD_REVERSE_LOW     = 14
  COLOR_FIELD_FLASH           = 15
  COLOR_FIELD_FLASH_LOW       = 16
  COLOR_FIELD_STATUSLINE      = 17
  COLOR_FIELD_UNDERLINE       = 18
  COLOR_FIELD_UNDERLINE_LOW   = 19
  COLOR_FIELD_UNDERLINE_FLASH = 20
  COLOR_FIELD_UNDERLINE_FLASH_LOW     = 21
  COLOR_FIELD_PROT_UNDERLINE          = 22
  COLOR_FIELD_PROT_UNDERLINE_LOW      = 23
  COLOR_FIELD_PROT_REVERSE_FLASH      = 24
  COLOR_FIELD_PROT_REVERSE_FLASH_LOW  = 25
Returns:
The color index
  COLOR_BLACK         = 0
  COLOR_RED           = 1
  COLOR_GREEN         = 2
  COLOR_YELLOW        = 3
  COLOR_BLUE          = 4
  COLOR_MAGENTA       = 5
  COLOR_CYAN          = 6
  COLOR_WHITE         = 7
  COLOR_BLACK_ALT     = 8
  COLOR_RED_ALT       = 9
  COLOR_GREEN_ALT     = 10
  COLOR_YELLOW_ALT    = 11
  COLOR_BLUE_ALT      = 12
  COLOR_MAGENTA_ALT   = 13
  COLOR_CYAN_ALT      = 14
  COLOR_WHITE_ALT     = 15

setTermForeColor

public void setTermForeColor(int fieldType,
                             int color,
                             boolean overrideHostColor)
Set configured foreground color for specified field type

Parameters:
fieldType - The field type index (see getTermForeColor)
color - The color index (see getTermForeColor)
overrideHostColor - True to override host colors for this field type

getTermBackColor

public int getTermBackColor(int fieldType)
Get configured background color for specified field type

Parameters:
fieldType - The field type index (see getTermForeColor)
Returns:
The color index (see getTermForeColor)

setTermBackColor

public void setTermBackColor(int fieldType,
                             int color,
                             boolean overrideHostColor)
Set configured background color for specified field type

Parameters:
fieldType - The field type index (see getTermForeColor)
color - The color index (see getTermForeColor)
overrideHostColor - True to override host colors for this field type

getTermPages

public int getTermPages()
Get number of screen pages

Returns:
Number of screen pages

setTermPages

public void setTermPages(int pages)
Set number of screen pages

Parameters:
pages - Number of screen pages

getTermRows

public int getTermRows()
Get number of screen rows

Returns:
Number of screen rows

setTermRows

public void setTermRows(int rows)
Set number of screen rows

Parameters:
rows - Number of screen rows

getStatusMsgWait

public boolean getStatusMsgWait()
Get MsgWait status

Returns:
True if msgWait outstanding

getTermType

public int getTermType()
Get terminal type

Returns:
Terminal type

setTermType

public void setTermType(int termType)
Set terminal type

Parameters:
termType - Terminal type (UTS20=0, UTS40=1, U200=2, U300=3, UTS60=4) (TD830ascii=0, TD830=1, TD830ndl=2)

getTermXmitMode

public int getTermXmitMode()
Get terminal xmit mode

Returns:
xmit mode (see setTermXmitMode)

setTermXmitMode

public void setTermXmitMode(int xmitMode)
Set terminal xmit mode

Parameters:
xmitMode - The transmit mode
  CPAGE_XMIT_VAR   = 0    // transmit variable (unprotected)
  CPAGE_XMIT_CHAN  = 1    // transmit changed
  CPAGE_XMIT_ALL   = 2    // transmit all

getOptAutoReconnect

public boolean getOptAutoReconnect()
Get AutoReconnect setting

Returns:
True if AutoReconnect

setOptAutoReconnect

public void setOptAutoReconnect(boolean bNewValue)
Set AutoReconnect, if true then the tcp connection will be re-attempted if the host disconnects

Parameters:
bNewValue - True if AutoConnect is required

getAboutInfo

public static java.lang.String getAboutInfo()
Get AboutInfo setting

Returns:
string containing "About" information

getOptAutoAlign

public boolean getOptAutoAlign()
Get AutoAlign setting

Returns:
True if AutoAlign

setOptAutoAlign

public void setOptAutoAlign(boolean bNewValue)
Set AutoAlign, if true then the screen will be scrolled if necessary to display the current cursor position

Parameters:
bNewValue - True if AutoAlign required

getOptBackspaceNonDelete

public boolean getOptBackspaceNonDelete()
Get BackspaceNonDelete setting

Returns:
True if BackspaceNonDelete is set

setOptBackspaceNonDelete

public void setOptBackspaceNonDelete(boolean bNewValue)
Set BackspaceNonDelete option, if true this allows backspacing without deleting characters (functions like cursor left)

Parameters:
bNewValue - True to set BackspaceNonDelete

getOptBlockModeSelect

public boolean getOptBlockModeSelect()
Get BlockModeSelect setting

Returns:
True if BlockModeSelect

setOptBlockModeSelect

public void setOptBlockModeSelect(boolean bNewValue)
Set BlockModeSelect option to drag select in block mode

Parameters:
bNewValue - True if BlockModeSelect

getOptEraseOnDisconnect

public boolean getOptEraseOnDisconnect()
Get EraseOnDisconnect setting

Returns:
True if EraseOnDisconnect

setOptEraseOnDisconnect

public void setOptEraseOnDisconnect(boolean bNewValue)
Set EraseOnDisconnect to erase the screen when disconnected from the host

Parameters:
bNewValue - True if EraseOnDisconnect

setOptFireScreenUpdates

public void setOptFireScreenUpdates(boolean bNewValue)
Set FireScreenUpdates to fire ScreenUpdate events, note that ScreenUpdate events are always fired if there is no graphics context (the screen is hidden)

Parameters:
bNewValue - True to set FireScreenUpdates

getOptFlashingCursor

public boolean getOptFlashingCursor()
Get FlashingCursor setting

Returns:
True if FlashingCursor is set

setOptFlashingCursor

public void setOptFlashingCursor(boolean bNewValue)
Set FlashingCursor option to make the screen cursor flash

Parameters:
bNewValue - True to set FlashingCursor

getOptFontBold

public boolean getOptFontBold()
Get FontBold option

Returns:
True if FontBold is set

setOptFontBold

public void setOptFontBold(boolean bNewValue)
Set FontBold option to display screen text in bold font

Parameters:
bNewValue - True to set FontBold

getOptFontItalic

public boolean getOptFontItalic()
Get FontItalic option

Returns:
True if FontItalic is set

setOptFontItalic

public void setOptFontItalic(boolean bNewValue)
Set FontItalic option to display screen text in italic font

Parameters:
bNewValue - True to set FontItalic

getOptForceUpperCase

public boolean getOptForceUpperCase()
Get ForceUpperCase option

Returns:
True if ForceUpperCase is set

setOptForceUpperCase

public void setOptForceUpperCase(boolean bNewValue)
Set ForceUpperCase option to force all keyboard input to upper case

Parameters:
bNewValue - True to set ForceUpperCase

getOptFullErase

public boolean getOptFullErase()
Get FullErase option

Returns:
True if FullErase is set

setOptFullErase

public void setOptFullErase(boolean bNewValue)
Set FullErase option to clear all protected and unprotected data when using clear screen

Parameters:
bNewValue - True True to set FullErase

getOptIgnoreDollarMsgs

public boolean getOptIgnoreDollarMsgs()
Get IgnoreDollarMsgs option

Returns:
True if IgnoreDollarMsgs is set

setOptIgnoreDollarMsgs

public void setOptIgnoreDollarMsgs(boolean bNewValue)
Set IgnoreDollarMsgs option to ignore network control messages that start with $$ (eg $$OPEN)

Parameters:
bNewValue - True to set IgnoreDollarMsgs

getPrtOptIgnoreHostPrint

public boolean getPrtOptIgnoreHostPrint()
Get PrtOptIgnoreHostPrint setting

Returns:
True if PrtOptIgnoreHostPrint is set

setPrtOptIgnoreHostPrint

public void setPrtOptIgnoreHostPrint(boolean bNewValue)
Set PrtOptIgnoreHostPrint to ignore all host printing

Parameters:
bNewValue - True to set PrtOptIgnoreHostPrint

getOptInsertMode

public boolean getOptInsertMode()
Get InsertMode option

Returns:
True if InsertMode is set

setOptInsertMode

public void setOptInsertMode(boolean bNewValue)
Set InsertMode option, to move row characters to the right when typing

Parameters:
bNewValue - True to set InsertMode

getOptInsertModeInDisp

public boolean getOptInsertModeInDisp()
Get InsertModeInDisp option

Returns:
True if InsertModeInDisp is set

setOptInsertModeInDisp

public void setOptInsertModeInDisp(boolean bNewValue)
Set InsertModeInDisp option, to move all characters to the right when typing

Parameters:
bNewValue - True to set InsertModeInDisp

getOptNoCursorWrap

public boolean getOptNoCursorWrap()
Get NoCursorWrap option

Returns:
True if NoCursorWrap is set

setOptNoCursorWrap

public void setOptNoCursorWrap(boolean bNewValue)
Set NoCursorWrap option, to prevent cursor at end of screen wrapping to the home position

Parameters:
bNewValue - True to set NoCursorWrap

getOptNoFlashers

public boolean getOptNoFlashers()
Get NoFlashers option

Returns:
True if NoFlashers is set

setOptNoFlashers

public void setOptNoFlashers(boolean bNewValue)
Set NoFlashers option, to inhibit any flashing fields

Parameters:
bNewValue - True to set NoFlashers

getOptNonDestructSpace

public boolean getOptNonDestructSpace()
Get NonDestructiveSpace option

Returns:
True if NonDestructiveSpace is set

setOptNonDestructSpace

public void setOptNonDestructSpace(boolean bNewValue)
Set NonDestructiveSpace option, to not delete characters when pressing the space bar (acts like cursor right)

Parameters:
bNewValue - True to set NonDestructiveSpace

getOptPassThruPrinter

public boolean getOptPassThruPrinter()
Get PassThruPrinter option

Returns:
True if PassThruPrinter is set

setOptPassThruPrinter

public void setOptPassThruPrinter(boolean bNewValue)
Set PassThruPrinter option, to make the terminal function like a passthru printer

Parameters:
bNewValue - True to set PassThruPrinter

getOptPrintAll

public boolean getOptPrintAll()
Get PrintAll option

Returns:
True if PrintAll is set

setOptPrintAll

public void setOptPrintAll(boolean bNewValue)
Set PrintAll, true if every received message is to be printed

Parameters:
bNewValue - True to set PrintAll

getOptShowAllCharacters

public boolean getOptShowAllCharacters()
Get ShowAllCharacters option

Returns:
True if ShowAllCharacters is set

setOptShowAllCharacters

public void setOptShowAllCharacters(boolean bNewValue)
Set ShowAllCharacters option, to display characters that are normally hidden such as tabs and CRs

Parameters:
bNewValue - True to set ShowAllCharacters

getOptSmoothScroll

public boolean getOptSmoothScroll()
Get smooth scroll option

Returns:
True if smooth scroll is on

setOptSmoothScroll

public void setOptSmoothScroll(boolean bNewValue)
Set smooth scroll

Parameters:
bNewValue - True for smooth scroll

getOptUnderlineCursor

public boolean getOptUnderlineCursor()
Get underline cursor option

Returns:
True if underline cursor is on

setOptUnderlineCursor

public void setOptUnderlineCursor(boolean bNewValue)
Set underline cursor option

Parameters:
bNewValue - True for underline cursor, else block cursor

getPageNumber

public int getPageNumber()
Get current screen page number

Returns:
Page number

getPrtEolAction

public int getPrtEolAction()
Get print end of line action

Returns:
Print end of line action

setPrtEolAction

public void setPrtEolAction(int prtEolAction)
Set PrtEolAction to control the printing action at the end of a line

Parameters:
prtEolAction -
 0 = none
 1 = CRLF
 2 = LF

getPrtFontName

public java.lang.String getPrtFontName()
Get printer font name

Returns:
Printer font name

setPrtFontName

public void setPrtFontName(java.lang.String lpszNewValue)
Set printer font name

Parameters:
lpszNewValue - Printer font name

getPrtFontSize

public int getPrtFontSize()
Get printer font size

Returns:
Printer font size

setPrtFontSize

public void setPrtFontSize(int nNewValue)
Set printer font size

Parameters:
nNewValue - Printer font size

getPrtLinesPerPage

public int getPrtLinesPerPage()
Get lines per page setting

Returns:
Lines per page

setPrtLinesPerPage

public void setPrtLinesPerPage(int nNewValue)
Set lines per page, set to zero to allow automatic caLculation

Parameters:
nNewValue - Lines per page

getPrtOnFormFeed

public boolean getPrtOnFormFeed()
Get PrtOnFormFeed setting

Returns:
True if PrtOnFormFeed is set

setPrtOnFormFeed

public void setPrtOnFormFeed(boolean bNewValue)
Set PrtOnFormFeed option to begin printing when a form feed character is received

Parameters:
bNewValue - True to set PrtOnFormFeed

getPrtOnPages

public boolean getPrtOnPages()
Get PrtOnPages setting

Returns:
True if PrtOnPages is set

setPrtOnPages

public void setPrtOnPages(boolean bNewValue)
Set PrtOnPages option to start printing after a specified number of pages have been spooled

Parameters:
bNewValue - True to set PrtOnPages

getPrtOnString

public boolean getPrtOnString()
Get PrtOnString setting

Returns:
True if PrtOnString is set

setPrtOnString

public void setPrtOnString(boolean bNewValue)
Set PrtOnString option to start printing when a specified string is received

Parameters:
bNewValue - True to set PrtOnString

getPrtPrintFileFF

public boolean getPrtPrintFileFF()
Get PrintFileFF option

Returns:
True if PrintFileFF is set

setPrtPrintFileFF

public void setPrtPrintFileFF(boolean bNewValue)
Set PrintFileFF option to write received form feeds to file when printing to file

Parameters:
bNewValue - True to set PrintFileFF

getPrtPrinterName

public java.lang.String getPrtPrinterName()
Get current printer name

Returns:
Printer name

setPrtPrinterName

public void setPrtPrinterName(java.lang.String lpszNewValue)
Set printer name

Parameters:
lpszNewValue - Printer name

getPrtTranslateFileName

public java.lang.String getPrtTranslateFileName()
Get printer translation file name

Returns:
File name

setPrtTranslateFileName

public void setPrtTranslateFileName(java.lang.String lpszNewValue)
Set printer translation file name to translate printed characters

Parameters:
lpszNewValue - File name

getPrtWhenPages

public int getPrtWhenPages()
Get PrtWhenPages setting

Returns:
Number of pages when to start printing

setPrtWhenPages

public void setPrtWhenPages(int nNewValue)
Set page count when start printing

Parameters:
nNewValue - Number of pages

getPrtWhenSeconds

public int getPrtWhenSeconds()
Get PrtWhenSecondss setting

Returns:
Number of seconds of no printer activity

setPrtWhenSeconds

public void setPrtWhenSeconds(int nNewValue)
Set number of seconds of no print activity before printing is to start

Parameters:
nNewValue - Number of seconds

getPrtWhenString

public java.lang.String getPrtWhenString()
Get PrtWhenString setting

Returns:
String to check to start printing

setPrtWhenString

public void setPrtWhenString(java.lang.String lpszNewValue)
Set string to check whether to start on printing

Parameters:
lpszNewValue - String to check

getPrtXparAction

public int getPrtXparAction()
Get XPAR action code

Returns:
Action code

setPrtXparAction

public void setPrtXparAction(int nNewValue)
Set XPAR action code

Parameters:
nNewValue - XPAR action code

getPrtOptIgnoreFF

public boolean getPrtOptIgnoreFF()
Get PrtOptIgnoreFF option

Returns:
True if PrtOptIgnoreFF is set

setPrtOptIgnoreFF

public void setPrtOptIgnoreFF(boolean bNewValue)
Set PrtOptIgnoreFF to ignore FF characters when printing

Parameters:
bNewValue - True if PrtOptIgnoreFF is set

getPrtOptLandscape

public boolean getPrtOptLandscape()
Get landscape print option

Returns:

setPrtOptLandscape

public void setPrtOptLandscape(boolean bNewValue)
Set landscape print option

Parameters:
bNewValue - landscape print

getPrtOptMetricMargins

public boolean getPrtOptMetricMargins()
Returns:

setPrtOptMetricMargins

public void setPrtOptMetricMargins(boolean bNewValue)
Parameters:
bNewValue -

getPrtOptNoFFafterPrint

public boolean getPrtOptNoFFafterPrint()
Get PrtOptNoFFafterPrint setting

Returns:
True if PrtOptNoFFafterPrint is set

setPrtOptNoFFafterPrint

public void setPrtOptNoFFafterPrint(boolean bNewValue)
Set PrtOptNoFFafterPrint to keep the print spool open

Parameters:
bNewValue - True to set PrtOptNoFFafterPrint

getPrtOptNoBlankPages

public boolean getPrtOptNoBlankPages()
Get PrtOptNoBlankPages option

Returns:
Trtue if PrtOptNoBlankPages is set

setPrtOptNoBlankPages

public void setPrtOptNoBlankPages(boolean bNewValue)
Set PrtOptNoBlankPagesto skip any blank pages

Parameters:
bNewValue - True to set PrtOptNoBlankPages

getPrtOptNoPrintDialog

public boolean getPrtOptNoPrintDialog()
Get PrtNoPrintDialog option

Returns:
True if PrtNoPrintDialog is set

getPrtOptPassthruPrintEscapes

public boolean getPrtOptPassthruPrintEscapes()
Get PassthruPrintEscapes option

Returns:
True if PassthruPrintEscapes is set

getPrtOptPassthruFilterDC2

public boolean getPrtOptPassthruFilterDC2()
Get PassthruFilterDC2 option

Returns:
True if PassthruFilterDC2 is set

getPrtOptPassthruPrintEol

public boolean getPrtOptPassthruPrintEol()
Get PassthruPrintEol option

Returns:
True if PassthruPrintEol is set

setPrtOptNoPrintDialog

public void setPrtOptNoPrintDialog(boolean bNewValue)
Set PrtNoPrintDialog to inhibit display of the print dialog

Parameters:
bNewValue - True to set PrtNoPrintDialog

setPrtOptPassthruPrintEscapes

public void setPrtOptPassthruPrintEscapes(boolean bNewValue)
Set PassthruPrintEscapes option

Parameters:
bNewValue - True to send escape characters to the printer in Passthru mode

setPrtOptPassthruFilterDC2

public void setPrtOptPassthruFilterDC2(boolean bNewValue)
Set PassthruFilterDC2 option

Parameters:
bNewValue - True to flter out DC2 characters in Passthru mode

setPrtOptPassthruPrintEol

public void setPrtOptPassthruPrintEol(boolean bNewValue)
Set PassthruPrintEol option

Parameters:
bNewValue - True to process EOL options in Passthru mode

getPrtOptShadowPrintFile

public boolean getPrtOptShadowPrintFile()
Returns:

setPrtOptShadowPrintFile

public void setPrtOptShadowPrintFile(boolean bNewValue)
Parameters:
bNewValue -

getPrtOptStripTabs

public boolean getPrtOptStripTabs()
Get PrtOptStripTabs option

Returns:
True if PrtOptStripTabs is set

setPrtOptStripTabs

public void setPrtOptStripTabs(boolean bNewValue)
Set PrtOptStripTabs to ignore yabs when printing

Parameters:
bNewValue - True to set PrtOptStripTabs

getPrtOptTranslate

public boolean getPrtOptTranslate()
Get PrtOptTranslate option

Returns:
True if PrtOptTranslate is set

setPrtOptTranslate

public void setPrtOptTranslate(boolean bNewValue)
Set PrtOptTranslateto enable print data translation

Parameters:
bNewValue - True to set PrtOptTranslate

getPrtOptTrashAfterFF

public boolean getPrtOptTrashAfterFF()
Get PrtOptTrashAfterFF option

Returns:
True if PrtOptTrashAfterFF is set

setPrtOptTrashAfterFF

public void setPrtOptTrashAfterFF(boolean bNewValue)
Set PrtOptTrashAfterFF to ignore all data after FF

Parameters:
bNewValue - True to set PrtOptTrashAfterFF

getPrtOptPrintToFile

public boolean getPrtOptPrintToFile()
Get current PrintToFile setting

Returns:
PrintToFile setting

setPrtOptPrintToFile

public void setPrtOptPrintToFile(boolean printToFile)
Set PrintToFile

Parameters:
printToFile - True if to print to file

getPrtOnTimeout

public boolean getPrtOnTimeout()
Get PrtOnTimeout option

Returns:
True if PrtOnTimeout is set

setPrtOnTimeout

public void setPrtOnTimeout(boolean bNewValue)
Set PrtOnTimeout to start printing after a specified time of no print data

Parameters:
bNewValue - True to set PrtOnTimeout

AddKey

public void AddKey(int cmd,
                   char key,
                   boolean shift,
                   boolean ctl,
                   boolean alt,
                   boolean ext)

RemoveKey

public boolean RemoveKey(int cmd,
                         char key,
                         boolean shift,
                         boolean ctl,
                         boolean alt,
                         boolean ext)

FindKey

public int FindKey(int key,
                   boolean shift,
                   boolean ctl,
                   boolean alt,
                   boolean ext)

getCmdName

public java.lang.String getCmdName(int cmd)

getKeyName

public java.lang.String getKeyName(char key,
                                   boolean shift,
                                   boolean ctl,
                                   boolean alt,
                                   boolean ext)

WaitScreenText

public boolean WaitScreenText(int row,
                              int col,
                              java.lang.String text,
                              int timeout)
Wait for specified text at the given screen position

Parameters:
row - Start row
col - Start col
text - Text to wait for
timeout - Miliseconds to wait

WaitConnected

public boolean WaitConnected(boolean needConnected,
                             int timeout)
Wait to connect or to disconnect

Parameters:
needConnected - True if waiting to connect else waiting to disconnect
timeout - Miliseconds to wait

Wait

public boolean Wait(int timeout)
Wait for a message to arrive from the host

Parameters:
timeout - Miliseconds to wait

getTermNetworkChar

public int getTermNetworkChar()
Get NetworkChar setting

Returns:
NetworkChar character

setTermNetworkChar

public void setTermNetworkChar(int networkChar)
Set NetworkChar character, used to recognize network message susch as $$OPEN, the default character is a $ sign

Parameters:
networkChar - The character to be used