Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help  API User's Guide 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.ibm.eNetwork.beans.HOD
Class Screen

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ibm.eNetwork.HOD.common.gui.HPanel
                                |
                                +--com.ibm.eNetwork.beans.HOD.HODPanelBean
                                      |
                                      +--com.ibm.eNetwork.beans.HOD.Screen
All Implemented Interfaces:
javax.accessibility.Accessible, BlinkRemapListener, java.lang.Cloneable, ColorRemapListener, com.ibm.eNetwork.ECL.ECLConstants, com.ibm.eNetwork.ECL.event.ECLPSGraphicsListener, java.util.EventListener, java.io.Externalizable, GUIListener, com.ibm.eNetwork.HOD.common.HODConstants, java.awt.image.ImageObserver, java.awt.MenuContainer, OIAListener, java.beans.PropertyChangeListener, PSListener, SendKeyListener, java.io.Serializable, TraceProducer
public class Screen
extends HODPanelBean
implements com.ibm.eNetwork.ECL.ECLConstants, com.ibm.eNetwork.HOD.common.HODConstants, SendKeyListener, ColorRemapListener, BlinkRemapListener, PSListener, OIAListener, com.ibm.eNetwork.ECL.event.ECLPSGraphicsListener, GUIListener

Screen is a Bean which interprets and displays the PSEvents and OIAEvents which are fired by the Session Bean. PSEvents must be wired from the Session Bean to the Screen Bean. Screen uses the information in the PSEvents to display the host screen. The Screen Bean also incorporates the Operator Information Area (OIA) that can be turned on or off by the oiaVisible boolean property.

Screen is sensitive to both the session type and code page and has a different behavior for the different session types and for single-byte, double-byte, and bi-directional codePages. The OIA of Screen also displays different information based on the session type and code page.

The Screen Bean has a set of public properties that can be accessed through the standard bean accessor methods. For example, Screen has a sessionType property that affects its display of host data. The sessionType property is read and write and correspondingly has a getSessionType() method and a setSessionType() method that provide access to the property.

The properties can also be initialized when the bean is constructed using a java.util.Properties object with the appropriate keyword/value pairs. In the java.util.Properties object, the keyword for properties is the same as the property name. The keyword for the sessionType property is "sessionType". The valid values are determined by the property type. The sessionType property is an enumeration for which the valid values are "1" for 3270, "2" for 5250, "3" for VT, and "4" for CICS.

Properties

The following table lists the properties of the Screen Bean:

* - Properties with type "enum" are String types that accept a specific set of string values. The valid values for an enum property can be obtained by calling the list <property name> method. The set method for enum properties validates the value before any changes are accepted, and a PropertyVetoException is thrown if an incorrect value is given.

Note: All properties are bound and vetoable. A PropertyChangeEvent is fired to all PropertyChangeListeners after a property is changed. A vetoable PropertyChangeEvent is fired to all VetoableChangeListeners before a property is changed. VetoableChangeListeners can veto a property change by throwing a PropertyVetoException.

Property Name Type Default Access
3D boolean true read/write
accessibilityEnabled boolean false read/write
autoFontSize boolean true read/write
autoPack boolean false read/write
blockCursor boolean false read/write
centered boolean true read/write
codePage enum* See Session read/write
cursorVisible boolean true read/write
DBCSInputVisible boolean false read/write
fontName enum* Monospaced read/write
fontSize int 10 read/write
fontSizeBounded boolean true read/write
fontStyle enum* java.awt.Font.PLAIN read/write
footerPlace enum* PRT_SCRN_PLACE_CENTER read/write
footerText enum* null read/write
headerPlace enum* PRT_SCRN_PLACE_CENTER read/write
headerText enum* null read/write
lightPenMode boolean false read/write
markedAreaPrintingEnabled boolean true read/write
mouseEnabled boolean true read/write
OIAVisible boolean true read/write
rule boolean false read/write
sessionType enum* See Session read/write
skipPrintDialog boolean false read/write

Events Fired

Event Type Fired To Event Handler Method
SendKeyEvent - Fired when Screen receives a keystroke and has NO external java.awt.event.KeyListeners. Screen also acts as a concentrator for SendKeyEvents--it refires SendKeyEvents that are fired to it from any of the other Beans such as KeyRemap or KeyPad, regardless of the number of java.awt.event.KeyListeners. Contains the keystroke or function formatted as an ECLPS.SendKeys() style mnemonic keyword. Session, Macro, MacroManager sendKeys(SendKeyEvent)
ScreenEvent - Fired when a URL is selected on the Screen or when a cut/paste box is selected, unselected, sized, or moved on the Screen. The event contains the URL or coordinates of the rectangle in presentation space coordinates. MacroManager boxSelected(ScreenEvent) boxUnSelected(ScreenEvent) URLSelected(ScreenEvent)
ScreenMouseEvent - Fired when a mouse or mouse motion event occurs on Screen. ColorRemap, Any ScreenMouseListener or Any ScreenMotionListener mouseEvent(ScreenMouseEvent) mouseMotionEvent(ScreenMouseEvent)
KeyEvent - Standard Java awt event fired when the Screen has focus and any key on the keyboard is pressed. If Screen has one or more KeyListeners to receive the Java KeyEvent, it will NOT fire a SendKeyEvent/ KeyRemap keyPressed(java.awt.event.KeyEvent), keyTyped(java.awt.event.KeyEvent), keyReleased(java.awt.event.KeyEvent)
MouseEvent - Standard Java awt event fired when the mouse enters, exits, or is clicked within Screen. Any MouseListener Any of the MouseListener methods
MouseMotionEvent - Standard Java awt event fired when the mouse is moved or an item is dragged over Screen. Any MouseMotionListener Any of the MouseMotionListener methods
PropertyChangeEvent - Fired when a property is changed. Any PropertyChangeListener propertyChange(PropertyChangeEvent)
Vetoable PropertyChangeEvent - Fired when a vetoable property is changed. Any VetoableChangeListener vetoableChange(PropertyChangeEvent)

Events Accepted

Event Type Fired From Event Handler Method
SendKeyEvent - Contains the keystroke or function formatted as an ECLPS.SendKeys() style mnemonic keyword. Screen refires this event to its own SendKeyListeners. KeyRemap, KeyPad sendKeys(SendKeyEvent)
PSEvent - Fired when the presentation space of a Session is updated. Screen reacts to the PSEvents to display the presentation space. Session PSEvent(PSEvent)
OIAEvent - Fired when the Operator Information Area (OIA) of a Session is updated. Screen reacts to the OIAEvents to display the OIA. Session OIAEvent(OIAEvent)
GUIEvent - Fired from Session when a GUI event is issued. Session GUIEvent(GUIEvent)
PropertyChangeEvent - Fired when a property of the source Bean is changed. Because Screen is sensitive to the sessionType and codePage properties, it can listen to Property change events of other Beans and sync its own properties to correspond to those of the source Bean. Session propertyChange(PropertyChangeEvent)

Programming Note

There are methods that will cause a NullPointerException if the graphical object element of Screen has not been instantiated. Those methods are: copyToClipboard, copyToClipboardAsTable, cutToClipboard, pasteFromClipboard, clearTrimRect, selectAll, getSelected, drawBox and setRule. The graphical object element is certain to be instantiated when this sequence has occurred at least once: Terminal() -> frame.add(Terminal) -> frame.show() -> Terminal.startCommunication(). Or the equivalent code actions.

Class Inheritance

The libraries containing this class are available in two versions: java2 and jdk1.1.8. This class document represents a compilation using Java 2 and its core libraries. The class inheritance scheme is shown above.

The alternative library was compiled with JDK 1.1.8. The result is a slightly different derivation, illustrated in this following class inheritance fragment. 

                 |
                 +--java.awt.Container
                               |
                               +--java.awt.Panel
                                         |
                                         +--com.ibm.eNetwork.HOD.common.gui.HPanel
                                                       |
                                                       +--

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
static java.lang.String ACCESSIBILITY_ENABLED
          accessibilityEnabled property keyword
static java.lang.String AUTO_FONT_SIZE
          autoFontSize property keyword
static java.lang.String AUTO_PACK
          autoPack property keyword
static java.lang.String BACKGROUND_3D
          3DBackgroundColour
static java.lang.String BLOCK_CURSOR
          blockCursor property keyword
static int BOX_DOWN
           
static int BOX_LEFT
           
static int BOX_RIGHT
           
static int BOX_UP
           
static java.lang.String CENTERED
          centered property keyword
static java.lang.String CODE_PAGE
          codePage property keyword
static java.lang.String CURSOR_VISIBLE
          cursor visible property keyword
static java.lang.String DBCSINPUT_VISIBLE
          DBCSInputVisible property keyword
static java.lang.String DONT_SHOW_UNPROTECTED_URLS
          dontShowUnprotectedURLs property keyword
static java.lang.String FIXED_FONT_SIZE
          fixedFontSize property keyword
static java.lang.String FONT_NAME
          fontName property keyword
static java.lang.String FONT_SIZE
          fontSize property keyword
static java.lang.String FONT_SIZE_BOUNDED
          fontSizeBounded property keyword
static java.lang.String FONT_STYLE
          fontStyle property keyword
static java.lang.String IME_AUTOSTART
          autoIME property keyword
static java.lang.String INPUT_AREA_INDIC_3270
           
static java.lang.String LIGHT_PEN_MODE
          lightPenMode property keyword
static java.lang.String MARKED_AREA_PRINTING_ENABLED
          markedAreaPrintingEnabled property keyword
static java.lang.String MOUSE_ENABLED
          mouse enabled property keyword
static java.lang.String OIA_VISIBLE
          OIAVisible property keyword
static java.lang.String OLD_SHOW_URLS_MODE
           
static java.lang.String PRT_SCRN_FOOTER_PLACE
          footerPlace property keyword
static java.lang.String PRT_SCRN_FOOTER_TEXT
          footerText property keyword
static java.lang.String PRT_SCRN_HEADER_PLACE
          headerPlace property keyword
static java.lang.String PRT_SCRN_HEADER_TEXT
          headerText property keyword
static java.lang.String PRT_SCRN_NOT_SHOW_DIALOG
          skipPrintDialog property keyword
static java.lang.String PRT_SCRN_PLACE_CENTER
          header/footer place center
static java.lang.String PRT_SCRN_PLACE_LEFT
          header/footer place left
static java.lang.String PRT_SCRN_PLACE_RIGHT
          header/footer place right
static java.lang.String RULE
          rule property keyword
static java.lang.String SCREEN_3D
          3D property keyword
static java.lang.String SESSION_TYPE
          sessionType property keyword
static java.lang.String SHOW_URLS_MODE
          showURLsMode property keyword
static java.lang.String STYLE3D_LOWERED
          style3dLowered
static java.lang.String STYLE3D_RAISED
          3DRaised
static java.lang.String UNDER_DOT
          Underdot
static java.lang.String UNDER_LINE
          Underline Property keyword
static java.lang.String UNPROTECTED_DISPLAY
          unProtectedDisplay keyword
static java.lang.String UNPROTECTED_NonDISPLAY
          UnProtectedNonDisplay keyword
static java.lang.String URLS_3DBOX_OPTION
           
static java.lang.String URLS_DISABLE_OPTION
           
static java.lang.String URLS_UNDERLINE_OPTION
           
 
Fields inherited from class com.ibm.eNetwork.beans.HOD.HODPanelBean
BEAN_VERSION_STRING, TRACE_LEVEL, TRACE_MAXIMUM, TRACE_MINIMUM, TRACE_NONE, TRACE_NORMAL
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface com.ibm.eNetwork.ECL.ECLConstants
ALL_FIELDS, ALL_PLANES, ALPHANUM_FIELD, ALTCUR_STR, ALTVIEW_STR, ATTN_STR, ATTR_5250_ALPHA_ONLY, ATTR_5250_ALPHANUM, ATTR_5250_ALPHANUM_MASK, ATTR_5250_BIDI_RTL, ATTR_5250_BRIGHT, ATTR_5250_DBCS_KATAKANA, ATTR_5250_DISPLAY, ATTR_5250_MAG_STRIPE, ATTR_5250_MODIFIED, ATTR_5250_NORMAL, ATTR_5250_NUM_ONLY, ATTR_5250_NUM_PLUS, ATTR_5250_NUM_SHIFT, ATTR_5250_NUM_SIGNED, ATTR_5250_PROTECTED, ATTR_ALPHANUM, ATTR_DISPLAY1, ATTR_DISPLAY2, ATTR_MDT, ATTR_PROTECTED, AUTOPUSH_STR, AUTOREV_STR, BACKSP_STR, BACKTAB_STR, BACKTABWORD_STR, BASE_STR, BEGINFLD_STR, BIDI_MODE_OFF_STR, BIDI_MODE_ON_STR, BIDIL_STR, BLUE_3270, CANCELPJOB_STR, CLEAR_STR, CLEARRECT_STR, CLOSE_STR, COLOR_ATTRIBUTES_PLANE, COLOR_PLANE, COLUMNHEAD_STR, CONTEXT_DISP_STR, CONTINUEPJOB_STR, COPY_STR, COPY_TABLE_STR, COPYALL_STR, COPYAPPEND_STR, CRSEL_STR, CSD_STR, CURDOWN_STR, CURLEFT_STR, CURRIGHT_STR, CURSOR_DIRECTION_STR, CURUP_STR, CUT_STR, DB_CA_EXIST, DB_CLEAR, DB_DB1, DB_DBCS, DB_DBHIGH, DB_DEAD, DB_MIX, DB_SI, DB_SO, DB_SOSI_EXIST, DBATTR_DEFAULT, DBATTR_EITHER, DBATTR_ONLY, DBATTR_OPEN, DBATTR_PURE, DBCS_PLANE, DBCSINP_STR, DBDEFALT, DEF_3270, DELCHAR_STR, DELWORD_STR, DISPLAYABLE_FIELD, DOCMODE_STR, DSPSOSI_STR, DUP_CHAR, DUP_STR, EBC_SI, EBC_SO, ENDLINE_STR, ENDPUSH_STR, ENTER_STR, ENTERRESET_STR, ERASEEOF_STR, ERASEFLD_STR, ERASEINPUT_STR, EXFIELD_PLANE, EXT_ATTR_3270_APL, EXT_ATTR_3270_BLINK, EXT_ATTR_3270_CHAR, EXT_ATTR_3270_DBCS, EXT_ATTR_3270_EBCDIC, EXT_ATTR_3270_REVERSE, EXT_ATTR_3270_UNDERLINE, EXT_ATTR_5250_BLINK, EXT_ATTR_5250_COLUMN_SEP, EXT_ATTR_5250_REVERSE, EXT_ATTR_5250_UNDERLINE, EXT_BLINK, EXT_COL_SEP, EXT_D_BOTH, EXT_D_LEFT, EXT_D_OVER, EXT_D_RIGHT, EXT_D_UNDER, EXT_DBCS, EXT_EFA_APL_SET, EXT_EFA_FG_SET, EXT_G_ALL, EXT_G_LEFT, EXT_G_OVER, EXT_G_RIGHT, EXT_G_UNDER, EXT_LINEATTR_CHECK, EXT_LINEATTR_DBLWID, EXT_LINEATTR_DBLWID_DBLHT_BOT, EXT_LINEATTR_DBLWID_DBLHT_TOP, EXT_LINEATTR_NORMAL, EXT_NON_ERASEABLE, EXT_NORMAL, EXT_OPAQUE, EXT_REVERSE, EXT_UNDERLN, F1_STR, F10_STR, F11_STR, F12_STR, F13_STR, F14_STR, F15_STR, F16_STR, F17_STR, F18_STR, F19_STR, F2_STR, F20_STR, F21_STR, F22_STR, F23_STR, F24_STR, F3_STR, F4_STR, F5_STR, F6_STR, F7_STR, F8_STR, F9_STR, FIELD_MARK, FIELD_PLANE, FINAL_STR, FLDBASE_STR, FLDEXT_STR, FLDMINUS_STR, FLDMRK_STR, FLDPLUS_STR, FLDREV_STR, FLDSHAPE_STR, FORMFEED_STR, FWDTAB_STR, GRCURSOR_STR, GREEN_3270, GRID_PLANE, HELP_STR, HILIGHT_FIELD, HINDIL_STR, HOME_STR, HOST_PLANE, HOSTPRT_STR, INITIAL_STR, INSERT_STR, ISOLATED_STR, JUMP_STR, KEYPAD0_STR, KEYPAD1_STR, KEYPAD2_STR, KEYPAD3_STR, KEYPAD4_STR, KEYPAD5_STR, KEYPAD6_STR, KEYPAD7_STR, KEYPAD8_STR, KEYPAD9_STR, KEYPADCOMMA_STR, KEYPADDOT_STR, KEYPADENTER_STR, KEYPADMINUS_STR, LATINL_STR, LOGICAL_DISP_STR, LOLIGHT_FIELD, MARKDOWN_STR, MARKLEFT_STR, MARKRIGHT_STR, MARKUP_STR, MIDDLE_STR, MODIFIED_FIELD, MOVEDOWN_STR, MOVELEFT_STR, MOVERIGHT_STR, MOVEUP_STR, MSR_STR, NATIONAL_DISP_STR, NEUT_3270, NEWLINE_STR, NEXTWORD_STR, NLS_PLANE, NO_TIMEOUT, NOMINAL_DISP_STR, NON_DISPLAYABLE_FIELD, NON_PENDETECTABLE_FIELD, NUMCONTEXT_STR, NUMERIC_FIELD, NUMNATIONAL_STR, NUMNOMINAL_STR, OICR_STR, PA1_STR, PA2_STR, PA3_STR, PAGEDWN_STR, PAGEUP_STR, PASTE_STR, PASTENEXT_STR, PENDETECTABLE_FIELD, PINK_3270, PREVIOUSWORD_STR, PRINT_STR, PROTECTED_FIELD, PRTESTPAGE_STR, PUSH_STR, RAWTEXT_PLANE, RED_3270, RESET_STR, RETRYPRT_STR, ROUNDTRIP_OFF_STR, ROUNDTRIP_ON_STR, RULE_STR, SCREENREV_STR, SEARCH_BACKWARD, SEARCH_FORWARD, SELECTALL_STR, SHIFT_F1_STR, SHIFT_F10_STR, SHIFT_F11_STR, SHIFT_F12_STR, SHIFT_F13_STR, SHIFT_F14_STR, SHIFT_F15_STR, SHIFT_F16_STR, SHIFT_F17_STR, SHIFT_F18_STR, SHIFT_F19_STR, SHIFT_F2_STR, SHIFT_F20_STR, SHIFT_F3_STR, SHIFT_F4_STR, SHIFT_F5_STR, SHIFT_F6_STR, SHIFT_F7_STR, SHIFT_F8_STR, SHIFT_F9_STR, SMARTORDERING_OFF_STR, SMARTORDERING_ON_STR, STARTMAC_STR, SYSREQ_STR, TABWORD_STR, TEST_STR, TEXT_PLANE, THAIL_STR, TOGGLEHEB_STR, TURQ_3270, TXTORL2R_STR, TXTORR2L_STR, TXTTYPEL_STR, TXTTYPEV_STR, UNMARK_STR, UNMODIFIED_FIELD, UNPROTECTED_FIELD, VISUAL_DISP_STR, VTPRINTCONVERT_STR, WORDLFT_STR, WORDRGT_STR, WORDWRAP_STR, YELLOW_3270
 
Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_HOD_API, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_COMPID_ZIPPRINT, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
Screen()
          Screen Bean null constructor.
Screen(java.util.Properties newProperties)
          Constructor that takes a Properties object containing the initial property settings.
 
Method Summary
 void addKeyListener(java.awt.event.KeyListener l)
          Adds a java.awt.event.KeyListener to the Screen Bean.
 void addScreenListener(ScreenListener l)
          Adds a ScreenListener.
 void addScreenMotionListener(ScreenMotionListener l)
          Adds a ScreenMotionListener.
 void addScreenMouseListener(ScreenMouseListener l)
          Adds a ScreenMouseListener.
 void addSendKeyListener(SendKeyListener l)
          Adds a SendKeyListener.
 void clearTrimRect()
          Clears the selected box (all unprotected areas)
 void copyToClipboard()
          Copies the selected box to the clipboard.
 void copyToClipboard(boolean append)
          Copies the selected box to the clipboard with conditional appending
 void copyToClipboardAsTable()
          Copies the selected box to the clipboard as a table
 void cutToClipboard()
          Copies the selected box to clipboard and clears the unprotected areas of the Screen.
static java.util.Properties defaults()
          Returns a Properties object containing the default properties for this Bean.
 void dispose()
          Disposes of Screen and all of its resources.
 void drawBox(int direction)
          Draws the cut and paste selection box on the screen.
 java.lang.String get3270InputAreaIndication()
          Returns what the current setting is for indicating how input fields are indicated.
 java.awt.Color getBackground3DColour()
          Returns Color object indicating what the current color is for 3D input fields.
 java.lang.String getCodePage()
          Returns the value of the codePage property.
 int getColumns()
          Returns the number of columns represented on the screen.
 com.ibm.eNetwork.beans.HOD.keyremap.DefaultKeyboardRemap getDefaultKeyboardRemap()
           
 java.awt.Font getFont()
          Returns the current Screen font.
 java.lang.String getFontName()
          Returns the value of the fontName property.
 int getFontSize()
          Returns the value of the fontSize property.
 int getFontStyle()
          Returns the value of the fontStyle property.
 java.lang.String getFooterPlace()
          Return the value of the footerPlace property.
 java.lang.String getFooterText()
          Return the value of the footerText property.
 java.lang.String getHeaderPlace()
          Return the value of the headerPlace property.
 java.lang.String getHeaderText()
          Return the value of the headerText property.
 boolean getHideUnprotectedURLsMode()
          Returns the value of the dontShowUnprotectedURLs property.
 int getRows()
          Returns the number of rows represented on the screen.
 java.awt.Insets getSelected(boolean unMark)
          Returns an Insets object containing the coordinates, in Screen rows and columns, for the selected box.
 java.lang.String getSessionType()
          Returns the value of the sessionType property.
 java.lang.String getShowURLsMode()
          Returns the value of the showURLsMode property
 java.lang.String getTraceName()
          Returns a trace identifier for this bean.
 void GUIEvent(GUIEvent evt)
          Handler method for GUIEvents.
 boolean is3D()
          Returns the value of the 3D property.
 boolean isAccessibilityEnabled()
          Returns the value of the accessibilityEnabled property.
 boolean isAutoFontSize()
          Returns the value of the autoFontSize property.
 boolean isAutoPack()
          Returns the value of the autoPack property.
 boolean isBlockCursor()
          Returns the value of the block cursor property.
 boolean isCentered()
          Returns the value of the centered property.
 boolean isCursorVisible()
          Returns whether cursor is made visible by Screen.
 boolean isDBCSInputVisible()
          Returns the value of the DBCSInputVisible property.
 boolean isFixedFontSize()
          Returns the value of the fixedFontSize property.
 boolean isFontSizeBounded()
          Returns the value of the fontSizeBounded property.
 boolean isIMEAutoStart()
          Returns the value of the IMEAutoStart property.
 boolean isLightPenMode()
          Returns the value of the lightPenMode property.
 boolean isMarkedAreaPrintingEnabled()
          Returns the value of the markedAreaPrintingEnabled property.
 boolean isMorePasteDataAvailable()
          Once a paste or paste-next operation occurs, this method returns whether there is more data available that did not paste.
 boolean isMouseEnabled()
          Returns whether mouse events are being handled by Screen.
 boolean isOIAVisible()
          Returns the value of the OIAVisible property.
 boolean isRule()
          Returns the value of the rule property.
 boolean isSkipPrintDialog()
          Return the value of skipPrintDialog property.
static java.util.Enumeration listFixedFonts(java.lang.String codepage)
          Enumerates the list of valid fonts available for displaying screen in fixed font mode.
static java.util.Enumeration listFontNames(java.lang.String codepage)
          Enumerates the list of valid monospaced fonts available on the system.
static java.util.Enumeration listFontSizes(java.lang.String codepage)
          Enumerates the list of valid fixed font sizes available on the system.
static java.util.Enumeration listFontStyles()
          Enumerates a list of valid font styles.
 void moveBox(int direction)
          Moves the cut and paste selection box on the screen.
 void OIAEvent(OIAEvent evt)
          Handler method for OIAEvents.
 void pasteFromClipboard()
          Pastes the data from the clipboard at the current cursor location.
 void pasteFromClipboard(boolean next)
          Pastes the data from the clipboard at the current cursor location with conditional paste next functionality
 void printScreen()
          Prints the current Screen contents to the default printer.
 void PSEvent(PSEvent evt)
          Handler method for PSEvents.
 void remapBlink(BlinkRemapEvent evt)
          Handler method for BlinkRemapEvents.
 void remapColor(ColorRemapEvent evt)
          Handler method for ColorRemapEvents.
 void removeKeyListener(java.awt.event.KeyListener l)
          Removes a java.awt.event.KeyListener from the Screen Bean.
 void removeScreenListener(ScreenListener l)
          Removes a ScreenListener.
 void removeScreenMotionListener(ScreenMotionListener l)
          Removes a ScreenMotionListener.
 void removeScreenMouseListener(ScreenMouseListener l)
          Removes a ScreenMouseListener.
 void removeSendKeyListener(SendKeyListener l)
          Removes a SendKeyListener.
 void requestFocus()
          Requests focus on Screen.
 void selectAll()
          Selects the entire Screen for the purpose of copying or cutting the area.
 void sendKeys(SendKeyEvent evt)
          Handler method for SendKeyEvents.
 void set3270InputAreaIndication(java.lang.String whatKind)
          Sets how the input fields should be indicated.
 void set3D(boolean threeD)
          Sets the 3D property.
 void setAccessibilityEnabled(boolean accessibility)
          Sets the accessibilityEnabled property.
 void setAutoFontSize(boolean autoFontSize)
          Sets the autoFontSize property.
 void setAutoPack(boolean autoPack)
          Sets the autoPack property.
 void setBackground3DColour(java.awt.Color whatColour)
          Sets what the background color should be for 3D input fields.
 void setBlockCursor(boolean block)
          Sets the block cursor property.
 void setCentered(boolean center)
          Sets the centered property.
 void setCodePage(java.lang.String codePage)
          Sets the codePage property.
 void setCursorVisible(boolean val)
          Sets whether the cursor should be made visible by Screen.
 void setDBCSInputVisible(boolean showDBCSInput)
          Sets the DBCSinputVisible property (3270 and 5250 DBCS sessions only).
 void setFixedFontSize(boolean fixedFontSize)
          Sets the fixed font property.
 void setFont(java.awt.Font f)
          Sets the Screen font.
 void setFontName(java.lang.String fontName)
          Sets the fontName property.
 void setFontSize(int fontSize)
          Sets the fontSize property.
 void setFontSizeBounded(boolean bounded)
          Sets the fontSizeBounded property.
 void setFontStyle(int fontStyle)
          Sets the fontStyle property.
 void setFooterPlace(java.lang.String footerPlace)
          Set the footerPlace property.
 void setFooterText(java.lang.String footerText)
          Set the footerText property.
 void setHeaderPlace(java.lang.String headerPlace)
          Set the headerPlace property.
 void setHeaderText(java.lang.String headerText)
          Set the headerText property.
 void setHideUnprotectedURLsMode(boolean hideUnprotected)
          This determines whether URLs in unprotected fields are rendered as hotspots.
 void setIMEAutoStart(boolean IME)
          Sets the IMEAutoStart property.
 void setLightPenMode(boolean lightPenMode)
          Sets the lightPenMode property (3270 and CICS sessions only).
 void setMarkedAreaPrintingEnabled(boolean markedAreaPrinting)
          Sets the markedAreaPrintingEnabled property.
 void setMouseEnabled(boolean val)
          Sets whether mouse events will be handled by Screen.
 void setOIAVisible(boolean showOIA)
          Sets the OIAVisible property.
 void setPageFormat(java.lang.Object pageFormat)
          Set PageFormat Object for printing screen.
 void setRule(boolean rule)
          Sets the rule property.
 void setSessionType(java.lang.String type)
          Sets the sessionType property.
 void setShowURLsMode(java.lang.String urlMode)
          This property determines whether URLs are displayed as hotspots, and if so, whether they are rendered as underlines or buttons.
 void setSkipPrintDialog(boolean isSkipPrintDialog)
          Set the skipPrintDialog property.
 void unMark()
          Unmarks the selected box on the Screen.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.HODPanelBean
addPropertyChangeListener, addTraceListener, addVetoableChangeListener, clone, getComponent, getFunction, getProperties, getTraceLevel, propertyChange, readExternal, removePropertyChangeListener, removeTraceListener, removeVetoableChangeListener, setProperties, setTraceLevel, toString, writeExternal
 
Methods inherited from class com.ibm.eNetwork.HOD.common.gui.HPanel
add, createAssociation, paintComponent, setAccessDesc, setAccessibleName
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, repaint, repaint, requestDefaultFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.ECL.event.ECLPSGraphicsListener
graphicsEvent, graphicsUpdated
 

Field Detail

BOX_UP

public static final int BOX_UP

BOX_DOWN

public static final int BOX_DOWN

BOX_LEFT

public static final int BOX_LEFT

BOX_RIGHT

public static final int BOX_RIGHT

FONT_NAME

public static final java.lang.String FONT_NAME
fontName property keyword

FONT_STYLE

public static final java.lang.String FONT_STYLE
fontStyle property keyword

FIXED_FONT_SIZE

public static final java.lang.String FIXED_FONT_SIZE
fixedFontSize property keyword

FONT_SIZE

public static final java.lang.String FONT_SIZE
fontSize property keyword

OIA_VISIBLE

public static final java.lang.String OIA_VISIBLE
OIAVisible property keyword

DBCSINPUT_VISIBLE

public static final java.lang.String DBCSINPUT_VISIBLE
DBCSInputVisible property keyword

SCREEN_3D

public static final java.lang.String SCREEN_3D
3D property keyword

UNDER_LINE

public static final java.lang.String UNDER_LINE
Underline Property keyword

UNPROTECTED_DISPLAY

public static final java.lang.String UNPROTECTED_DISPLAY
unProtectedDisplay keyword

UNPROTECTED_NonDISPLAY

public static final java.lang.String UNPROTECTED_NonDISPLAY
UnProtectedNonDisplay keyword

UNDER_DOT

public static final java.lang.String UNDER_DOT
Underdot

STYLE3D_RAISED

public static final java.lang.String STYLE3D_RAISED
3DRaised

STYLE3D_LOWERED

public static final java.lang.String STYLE3D_LOWERED
style3dLowered

BACKGROUND_3D

public static final java.lang.String BACKGROUND_3D
3DBackgroundColour

AUTO_FONT_SIZE

public static final java.lang.String AUTO_FONT_SIZE
autoFontSize property keyword

FONT_SIZE_BOUNDED

public static final java.lang.String FONT_SIZE_BOUNDED
fontSizeBounded property keyword

AUTO_PACK

public static final java.lang.String AUTO_PACK
autoPack property keyword

CENTERED

public static final java.lang.String CENTERED
centered property keyword

RULE

public static final java.lang.String RULE
rule property keyword

BLOCK_CURSOR

public static final java.lang.String BLOCK_CURSOR
blockCursor property keyword

LIGHT_PEN_MODE

public static final java.lang.String LIGHT_PEN_MODE
lightPenMode property keyword

CODE_PAGE

public static final java.lang.String CODE_PAGE
codePage property keyword

SESSION_TYPE

public static final java.lang.String SESSION_TYPE
sessionType property keyword

MOUSE_ENABLED

public static final java.lang.String MOUSE_ENABLED
mouse enabled property keyword

CURSOR_VISIBLE

public static final java.lang.String CURSOR_VISIBLE
cursor visible property keyword

ACCESSIBILITY_ENABLED

public static final java.lang.String ACCESSIBILITY_ENABLED
accessibilityEnabled property keyword

MARKED_AREA_PRINTING_ENABLED

public static final java.lang.String MARKED_AREA_PRINTING_ENABLED
markedAreaPrintingEnabled property keyword

SHOW_URLS_MODE

public static final java.lang.String SHOW_URLS_MODE
showURLsMode property keyword

URLS_UNDERLINE_OPTION

public static final java.lang.String URLS_UNDERLINE_OPTION

URLS_3DBOX_OPTION

public static final java.lang.String URLS_3DBOX_OPTION

URLS_DISABLE_OPTION

public static final java.lang.String URLS_DISABLE_OPTION

OLD_SHOW_URLS_MODE

public static final java.lang.String OLD_SHOW_URLS_MODE

DONT_SHOW_UNPROTECTED_URLS

public static final java.lang.String DONT_SHOW_UNPROTECTED_URLS
dontShowUnprotectedURLs property keyword

IME_AUTOSTART

public static final java.lang.String IME_AUTOSTART
autoIME property keyword

INPUT_AREA_INDIC_3270

public static final java.lang.String INPUT_AREA_INDIC_3270

PRT_SCRN_HEADER_PLACE

public static final java.lang.String PRT_SCRN_HEADER_PLACE
headerPlace property keyword

PRT_SCRN_HEADER_TEXT

public static final java.lang.String PRT_SCRN_HEADER_TEXT
headerText property keyword

PRT_SCRN_FOOTER_PLACE

public static final java.lang.String PRT_SCRN_FOOTER_PLACE
footerPlace property keyword

PRT_SCRN_FOOTER_TEXT

public static final java.lang.String PRT_SCRN_FOOTER_TEXT
footerText property keyword

PRT_SCRN_NOT_SHOW_DIALOG

public static final java.lang.String PRT_SCRN_NOT_SHOW_DIALOG
skipPrintDialog property keyword

PRT_SCRN_PLACE_LEFT

public static final java.lang.String PRT_SCRN_PLACE_LEFT
header/footer place left

PRT_SCRN_PLACE_CENTER

public static final java.lang.String PRT_SCRN_PLACE_CENTER
header/footer place center

PRT_SCRN_PLACE_RIGHT

public static final java.lang.String PRT_SCRN_PLACE_RIGHT
header/footer place right
Constructor Detail

Screen

public Screen()
Screen Bean null constructor. This constructor uses the default values for all properties.

Screen

public Screen(java.util.Properties newProperties)
       throws java.beans.PropertyVetoException
Constructor that takes a Properties object containing the initial property settings. Any properties which are not specified in the Properties object are initialized to their default values.
Parameters:
newProperties - Properties for the Bean.
Throws:
java.beans.PropertyVetoException - Fired if an invalid property value is given.
Method Detail

dispose

public void dispose()
Disposes of Screen and all of its resources. This method should be called when a Screen instance is no longer needed.
Overrides:
dispose in class HODPanelBean

getFont

public java.awt.Font getFont()
Returns the current Screen font.
Overrides:
getFont in class java.awt.Component
See Also:
setFont(java.awt.Font)

setFont

public void setFont(java.awt.Font f)
Sets the Screen font. The font specified must be a monospaced font.
Overrides:
setFont in class javax.swing.JComponent
Parameters:
f - The new font for Screen. Must be a monospaced font.
See Also:
getFont()

getColumns

public int getColumns()
Returns the number of columns represented on the screen.

getRows

public int getRows()
Returns the number of rows represented on the screen.

selectAll

public void selectAll()
Selects the entire Screen for the purpose of copying or cutting the area.

Note that a call to this method is valid only if Screen has instantiated a graphical object.

getSelected

public java.awt.Insets getSelected(boolean unMark)
Returns an Insets object containing the coordinates, in Screen rows and columns, for the selected box. If nothing is selected, this method returns null.
Parameters:
unMark - If true, the selected box is unmarked. Otherwise the selected box is left marked.

Note that a call to this method is valid only if Screen has instantiated a graphical object.

unMark

public void unMark()
Unmarks the selected box on the Screen.

drawBox

public void drawBox(int direction)
Draws the cut and paste selection box on the screen.
Parameters:
direction - The direction to draw the box.

Valid values:

  • com.ibm.eNetwork.beans.HOD.Screen.BOX_UP
  • com.ibm.eNetwork.beans.HOD.Screen.BOX_DOWN
  • com.ibm.eNetwork.beans.HOD.Screen.BOX_LEFT
  • com.ibm.eNetwork.beans.HOD.Screen.BOX_RIGHT

Note that a call to this method is valid only if Screen has instantiated a graphical object.

moveBox

public void moveBox(int direction)
Moves the cut and paste selection box on the screen.
Parameters:
direction - The direction to move the box.

Valid values:

  • com.ibm.eNetwork.beans.HOD.Screen.BOX_UP
  • com.ibm.eNetwork.beans.HOD.Screen.BOX_DOWN
  • com.ibm.eNetwork.beans.HOD.Screen.BOX_LEFT
  • com.ibm.eNetwork.beans.HOD.Screen.BOX_RIGHT

copyToClipboard

public void copyToClipboard()
Copies the selected box to the clipboard.

Note that a call to this method is valid only if Screen has instantiated a graphical object.

copyToClipboard

public void copyToClipboard(boolean append)
Copies the selected box to the clipboard with conditional appending
Parameters:
append - Should the copied data be appended to the current clipboard

Note that a call to this method is valid only if Screen has instantiated a graphical object.

copyToClipboardAsTable

public void copyToClipboardAsTable()
Copies the selected box to the clipboard as a table

Note that a call to this method is valid only if Screen has instantiated a graphical object.

cutToClipboard

public void cutToClipboard()
Copies the selected box to clipboard and clears the unprotected areas of the Screen.

Note that a call to this method is valid only if Screen has instantiated a graphical object.

clearTrimRect

public void clearTrimRect()
Clears the selected box (all unprotected areas)

Note that a call to this method is valid only if Screen has instantiated a graphical object.

pasteFromClipboard

public void pasteFromClipboard()
Pastes the data from the clipboard at the current cursor location.

Note that a call to this method is valid only if Screen has instantiated a graphical object.

pasteFromClipboard

public void pasteFromClipboard(boolean next)
Pastes the data from the clipboard at the current cursor location with conditional paste next functionality
Parameters:
next - should the paste start from the last paste complete in the clipboard buffer

Note that a call to this method is valid only if Screen has instantiated a graphical object.

isMorePasteDataAvailable

public boolean isMorePasteDataAvailable()
Once a paste or paste-next operation occurs, this method returns whether there is more data available that did not paste. The value returned will be false if not all data pasted AND a Terminal/Session paste parameter was set to cause truncation.

printScreen

public void printScreen()
Prints the current Screen contents to the default printer.

getHeaderText

public java.lang.String getHeaderText()
Return the value of the headerText property. This method is valid only on Java2
See Also:
setHeaderText(java.lang.String)

setHeaderText

public void setHeaderText(java.lang.String headerText)
                   throws java.beans.PropertyVetoException
Set the headerText property. This method is valid only on Java2
Parameters:
String - headerText the header text of print screen
See Also:
getHeaderText()

getFooterText

public java.lang.String getFooterText()
Return the value of the footerText property. This method is valid only on Java2
See Also:
setFooterText(java.lang.String)

setFooterText

public void setFooterText(java.lang.String footerText)
                   throws java.beans.PropertyVetoException
Set the footerText property. This method is valid only on Java2
Parameters:
String - footerText the footer text of print screen
See Also:
getFooterText()

getHeaderPlace

public java.lang.String getHeaderPlace()
Return the value of the headerPlace property. This method is valid only on Java2
See Also:
setHeaderPlace(java.lang.String)

setHeaderPlace

public void setHeaderPlace(java.lang.String headerPlace)
                    throws java.beans.PropertyVetoException
Set the headerPlace property. This method is valid only on Java2
Parameters:
String - headerPlace the header place of print screen. Valid parameters are
  • PRT_SCRN_PLACE_LEFT
  • PRT_SCRN_PLACE_CENTER
  • PRT_SCRN_PLACE_RIGHT
See Also:
getHeaderPlace()

getFooterPlace

public java.lang.String getFooterPlace()
Return the value of the footerPlace property. This method is valid only on Java2
See Also:
setFooterPlace(java.lang.String)

setFooterPlace

public void setFooterPlace(java.lang.String footerPlace)
                    throws java.beans.PropertyVetoException
Set the footerPlace property. This method is valid only on Java2
Parameters:
String - footerPlace the footer place of print screen. Valid parameters are
  • PRT_SCRN_PLACE_LEFT
  • PRT_SCRN_PLACE_CENTER
  • PRT_SCRN_PLACE_RIGHT
See Also:
getFooterPlace()

isSkipPrintDialog

public boolean isSkipPrintDialog()
Return the value of skipPrintDialog property. This method is valid only on Java2
See Also:
setSkipPrintDialog(boolean)

setSkipPrintDialog

public void setSkipPrintDialog(boolean isSkipPrintDialog)
                        throws java.beans.PropertyVetoException
Set the skipPrintDialog property. This method is valid only on Java2
Parameters:
boolean - isSkipPrintDialog - Identifies whether or not the print dialog is suppressed in printing screen
See Also:
isSkipPrintDialog()

setPageFormat

public void setPageFormat(java.lang.Object pageFormat)
Set PageFormat Object for printing screen. This method is valid only on Java2
Parameters:
Object - pageFormat - should be java.awt.print.PageFormat.

addKeyListener

public void addKeyListener(java.awt.event.KeyListener l)
Adds a java.awt.event.KeyListener to the Screen Bean. When Screen has one or more KeyListeners, it will NOT fire SendKeyEvents. KeyListeners receive a java.awt.event.KeyEvent whenever the Screen has focus and a keyboard key is pressed.
Overrides:
addKeyListener in class java.awt.Component
Parameters:
l - KeyListener that receives KeyEvents.
See Also:
removeKeyListener(java.awt.event.KeyListener)

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener l)
Removes a java.awt.event.KeyListener from the Screen Bean. If Screen has no KeyListeners or when the last one is removed, it begins firing SendKeyEvents.
Overrides:
removeKeyListener in class java.awt.Component
Parameters:
l - KeyListener that no longer receive KeyEvents.
See Also:
addKeyListener(java.awt.event.KeyListener)

addScreenListener

public void addScreenListener(ScreenListener l)
Adds a ScreenListener. ScreenListeners are notified when cut/paste boxes are marked, unmarked, moved or resized, or when a valid URL is selected.
Parameters:
l - ScreenListener that receive ScreenEvents
See Also:
removeScreenListener(com.ibm.eNetwork.beans.HOD.event.ScreenListener), ScreenEvent

removeScreenListener

public void removeScreenListener(ScreenListener l)
Removes a ScreenListener.
Parameters:
l - ScreenListener that will be removed
See Also:
addScreenListener(com.ibm.eNetwork.beans.HOD.event.ScreenListener), ScreenEvent

addScreenMouseListener

public void addScreenMouseListener(ScreenMouseListener l)
Adds a ScreenMouseListener. ScreenMouseListeners are notified when mouse events occur.
Parameters:
l - ScreenMouseListener that receives ScreenMouseEvents
See Also:
removeScreenMouseListener(com.ibm.eNetwork.beans.HOD.event.ScreenMouseListener), ScreenMouseEvent

removeScreenMouseListener

public void removeScreenMouseListener(ScreenMouseListener l)
Removes a ScreenMouseListener.
Parameters:
l - ScreenMouseListener that will be removed
See Also:
addScreenMouseListener(com.ibm.eNetwork.beans.HOD.event.ScreenMouseListener), ScreenMouseEvent

addScreenMotionListener

public void addScreenMotionListener(ScreenMotionListener l)
Adds a ScreenMotionListener. ScreenMotionListeners are notified when mouse motion events occur.
Parameters:
l - ScreenMotionListener that receives ScreenMouseEvents
See Also:
removeScreenMotionListener(com.ibm.eNetwork.beans.HOD.event.ScreenMotionListener), ScreenMouseEvent

removeScreenMotionListener

public void removeScreenMotionListener(ScreenMotionListener l)
Removes a ScreenMotionListener.
Parameters:
l - ScreenMotionListener that will be removed
See Also:
addScreenMotionListener(com.ibm.eNetwork.beans.HOD.event.ScreenMotionListener), ScreenMouseEvent

addSendKeyListener

public void addSendKeyListener(SendKeyListener l)
Adds a SendKeyListener. SendKeyListeners are notified when Screen fires a SendKeyEvent.
See Also:
removeSendKeyListener(com.ibm.eNetwork.beans.HOD.event.SendKeyListener), SendKeyEvent

removeSendKeyListener

public void removeSendKeyListener(SendKeyListener l)
Removes a SendKeyListener.
See Also:
addSendKeyListener(com.ibm.eNetwork.beans.HOD.event.SendKeyListener), SendKeyEvent

sendKeys

public void sendKeys(SendKeyEvent evt)
Handler method for SendKeyEvents. Screen acts as a concentrator of SendKeyEvents for other Beans like KeyRemap and KeyPad. SendKeyEvents which are fired to Screen are refired to Screen-owned SendKeyListeners, which typically include Session.
Specified by:
sendKeys in interface SendKeyListener
Parameters:
evt - SendKeyEvent that is refired to Screen-owned SendKeyListeners.

remapColor

public void remapColor(ColorRemapEvent evt)
Handler method for ColorRemapEvents. ColorRemapEvents can be fired to Screen to change the normal colors.
Specified by:
remapColor in interface ColorRemapListener
Parameters:
evt - ColorRemapEvent which changes some default color on the Screen.

remapBlink

public void remapBlink(BlinkRemapEvent evt)
Handler method for BlinkRemapEvents. BlinkRemapEvents can be fired to Screen to change the behaviour of blinking fields.
Specified by:
remapBlink in interface BlinkRemapListener
Parameters:
evt - BlinkRemapEvent which changes default blink property off the Screen.

PSEvent

public void PSEvent(PSEvent evt)
Handler method for PSEvents. Screen reacts to the PSEvents to display the presentation space.
Specified by:
PSEvent in interface PSListener
Parameters:
evt - A PSEvent generated by the Session Bean.

OIAEvent

public void OIAEvent(OIAEvent evt)
Handler method for OIAEvents. Screen reacts to the OIAEvents to display the operator information area.
Specified by:
OIAEvent in interface OIAListener
Parameters:
evt - An OIAEvent generated by the Session Bean.

GUIEvent

public void GUIEvent(GUIEvent evt)
Handler method for GUIEvents. Screen reacts to GUI events that request some kind of change in the Screen display, such as changing to the alternate cursor.
Specified by:
GUIEvent in interface GUIListener
Parameters:
evt - A GUIEvent generated by the Session Bean.

requestFocus

public void requestFocus()
Requests focus on Screen.
Overrides:
requestFocus in class javax.swing.JComponent

setFontName

public void setFontName(java.lang.String fontName)
                 throws java.beans.PropertyVetoException
Sets the fontName property. The font name must be a monospaced font, such as Courier or Monospaced. See the listFontNames method for generating a list of valid monospaced fonts.
Parameters:
fontName - The new monospaced font name.
Throws:
java.beans.PropertyVetoException - Thrown if the specified font name is not a monospaced font.
See Also:
listFontNames(java.lang.String), getFontName()

getFontName

public java.lang.String getFontName()
Returns the value of the fontName property.
See Also:
setFontName(java.lang.String)

listFontNames

public static java.util.Enumeration listFontNames(java.lang.String codepage)
Enumerates the list of valid monospaced fonts available on the system. The current codepage affects which fonts are available.
Parameters:
codepage - The codepage for the screen.
See Also:
getFontName(), setFontName(java.lang.String), getCodePage()

listFontSizes

public static java.util.Enumeration listFontSizes(java.lang.String codepage)
Enumerates the list of valid fixed font sizes available on the system. The current codepage affects which font sizes are available.
Parameters:
codepage - The codepage for the screen.
See Also:
isFixedFontSize(), setFixedFontSize(boolean), getCodePage()

listFixedFonts

public static java.util.Enumeration listFixedFonts(java.lang.String codepage)
Enumerates the list of valid fonts available for displaying screen in fixed font mode. The current codepage affects which fonts are available.
Parameters:
codepage - The codepage for the screen.
See Also:
isFixedFontSize(), setFixedFontSize(boolean), getCodePage()

setFixedFontSize

public void setFixedFontSize(boolean fixedFontSize)
                      throws java.beans.PropertyVetoException
Sets the fixed font property. The font size will not change when the screen is resized. When the fixedFont property is true, centered, autoFontSize and autoPack properties are ignored. If screen area is smaller than required size, scroll bars will be added. If it is larger than required size, the host screen will be centered. This property cannot be set when using JVM less than 1.3 and the fixedFont property will remain false.
Parameters:
fixedFontSize - Whether or not the Screen should use fixed font size
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isFixedFontSize()

isFixedFontSize

public boolean isFixedFontSize()
Returns the value of the fixedFontSize property. This always returns false when running with JVM version less than 1.3.
See Also:
setFixedFontSize(boolean)

setFontSize

public void setFontSize(int fontSize)
                 throws java.beans.PropertyVetoException
Sets the fontSize property. This property is ignored when the autoFontSize property is set to true.
Parameters:
fontSize - The new font size.
Throws:
java.beans.PropertyVetoException - Thrown if the specified font size is too large.
See Also:
getFontSize()

getFontSize

public int getFontSize()
Returns the value of the fontSize property.
See Also:
setFontSize(int)

setFontStyle

public void setFontStyle(int fontStyle)
                  throws java.beans.PropertyVetoException
Sets the fontStyle property.

Valid values:

The styles can be combined for mixed styles.

Parameters:
fontStyle - The new font style.
Throws:
java.beans.PropertyVetoException - Thrown if the specified font style is not valid.
See Also:
listFontStyles(), getFontStyle()

getFontStyle

public int getFontStyle()
Returns the value of the fontStyle property.
See Also:
setFontStyle(int)

listFontStyles

public static java.util.Enumeration listFontStyles()
Enumerates a list of valid font styles.
See Also:
getFontStyle(), setFontStyle(int)

setFontSizeBounded

public void setFontSizeBounded(boolean bounded)
                        throws java.beans.PropertyVetoException
Sets the fontSizeBounded property. When true, this property causes the Screen to reject any font or font size which would cause the screen text to exceed current Screen boundaries.
Parameters:
bounded - Whether the Screen is font size bounded or not.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isFontSizeBounded()

isFontSizeBounded

public boolean isFontSizeBounded()
Returns the value of the fontSizeBounded property.
See Also:
setFontSizeBounded(boolean)

set3D

public void set3D(boolean threeD)
           throws java.beans.PropertyVetoException
Sets the 3D property. When true, this property causes the Screen to display a 3-dimensional border around the screen text area.
Parameters:
threeD - Whether the Screen displays the 3D border or not.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
is3D()

is3D

public boolean is3D()
Returns the value of the 3D property.
See Also:
set3D(boolean)

setIMEAutoStart

public void setIMEAutoStart(boolean IME)
                     throws java.beans.PropertyVetoException
Sets the IMEAutoStart property. When true, IMEAutoStart is enabled.
Parameters:
IME - Whether IMEAutoStart is enabled or not.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isIMEAutoStart()

isIMEAutoStart

public boolean isIMEAutoStart()
Returns the value of the IMEAutoStart property.
See Also:
setIMEAutoStart(boolean)

setOIAVisible

public void setOIAVisible(boolean showOIA)
                   throws java.beans.PropertyVetoException
Sets the OIAVisible property. When true, Screen displays the Operator Information Area (OIA).
Parameters:
showOIA - Whether the Screen shows OIA or not.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isOIAVisible()

isOIAVisible

public boolean isOIAVisible()
Returns the value of the OIAVisible property.
See Also:
setOIAVisible(boolean)

setDBCSInputVisible

public void setDBCSInputVisible(boolean showDBCSInput)
                         throws java.beans.PropertyVetoException
Sets the DBCSinputVisible property (3270 and 5250 DBCS sessions only). When true, Screen displays the DBCS Input field.
Parameters:
showDBCSInput - Whether the Screen shows DBCS Input field or not.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isDBCSInputVisible()

isDBCSInputVisible

public boolean isDBCSInputVisible()
Returns the value of the DBCSInputVisible property.
See Also:
setDBCSInputVisible(boolean)

setAutoFontSize

public void setAutoFontSize(boolean autoFontSize)
                     throws java.beans.PropertyVetoException
Sets the autoFontSize property. When true, this property causes the Screen to automatically select the best font size whenever it is resized, and any calls to setFontSize() is ignored.
Parameters:
autoFontSize - Whether or not Screen automatically adjusts the font when it is resized.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isAutoFontSize()

isAutoFontSize

public boolean isAutoFontSize()
Returns the value of the autoFontSize property.
See Also:
setAutoFontSize(boolean)

setAutoPack

public void setAutoPack(boolean autoPack)
                 throws java.beans.PropertyVetoException
Sets the autoPack property. When true this property causes the Screen to automatically pack its subcomponents.
Parameters:
autoPack - Whether or not the Screen autoPacks
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isAutoPack()

isAutoPack

public boolean isAutoPack()
Returns the value of the autoPack property.
See Also:
setAutoPack(boolean)

setCentered

public void setCentered(boolean center)
                 throws java.beans.PropertyVetoException
Sets the centered property. When true this property causes the Screen to automatically center the text area and OIA within its current boundaries.
Parameters:
center - Whether or not the Screen centers its text and OIA.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isCentered()

isCentered

public boolean isCentered()
Returns the value of the centered property.
See Also:
setCentered(boolean)

setRule

public void setRule(boolean rule)
             throws java.beans.PropertyVetoException
Sets the rule property. When true, this property causes the Screen to display rule lines.
Parameters:
rule - Whether or not the Screen displays rule lines.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

Note that a call to this method is valid only if Screen has instantiated a graphical object.

See Also:
isRule()

isRule

public boolean isRule()
Returns the value of the rule property.
See Also:
setRule(boolean)

setMouseEnabled

public void setMouseEnabled(boolean val)
                     throws java.beans.PropertyVetoException
Sets whether mouse events will be handled by Screen. The default for the Screen bean is true.
Parameters:
val - if true mouse events will be processed by screen.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isMouseEnabled()

isMouseEnabled

public boolean isMouseEnabled()
Returns whether mouse events are being handled by Screen.
See Also:
setMouseEnabled(boolean)

setCursorVisible

public void setCursorVisible(boolean val)
                      throws java.beans.PropertyVetoException
Sets whether the cursor should be made visible by Screen. The default for the Screen bean is true.
Parameters:
val - if true cursor will be made visible by screen.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isCursorVisible()

isCursorVisible

public boolean isCursorVisible()
Returns whether cursor is made visible by Screen.
See Also:
setCursorVisible(boolean)

setBlockCursor

public void setBlockCursor(boolean block)
                    throws java.beans.PropertyVetoException
Sets the block cursor property. When true, this property causes the Screen to display a full height block cursor. When false, this property causes the Screen to display an underscore cursor. If the screen is currently in insert mode, the block or underscore cursor is not displayed until you exit insert mode. When in insert mode, Screen displays a half-height cursor.
Parameters:
block - Whether or not the Screen displays a block cursor.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isBlockCursor()

isBlockCursor

public boolean isBlockCursor()
Returns the value of the block cursor property.
See Also:
setBlockCursor(boolean)

setLightPenMode

public void setLightPenMode(boolean lightPenMode)
                     throws java.beans.PropertyVetoException
Sets the lightPenMode property (3270 and CICS sessions only). When true, this property causes the Screen to enable light pen support.
Parameters:
lightPenMode - Whether or not the Screen enables light pen support.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isLightPenMode()

isLightPenMode

public boolean isLightPenMode()
Returns the value of the lightPenMode property.
See Also:
setLightPenMode(boolean)

setShowURLsMode

public void setShowURLsMode(java.lang.String urlMode)
                     throws java.beans.PropertyVetoException
This property determines whether URLs are displayed as hotspots, and if so, whether they are rendered as underlines or buttons. Sets the showURLsMode property.
Parameters:
String - urlMode Determines how URLs are displayed. Valid values are:
  • Screen.URLS_UNDERLINE_OPTION
  • Screen.URLS_3DBOX_OPTION
  • Screen.URLS_DISABLE_OPTION
    • .
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getShowURLsMode()

getShowURLsMode

public java.lang.String getShowURLsMode()
Returns the value of the showURLsMode property
Returns:
String Returns the value of the showURLsMode property.
See Also:
setShowURLsMode(String)

setHideUnprotectedURLsMode

public void setHideUnprotectedURLsMode(boolean hideUnprotected)
                                throws java.beans.PropertyVetoException
This determines whether URLs in unprotected fields are rendered as hotspots. Sets the dontShowUnprotectedURLs property (not VT).
Parameters:
boolean - hideUnprotected Value assigned to dontShowUnprotectedURLs.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getHideUnprotectedURLsMode()

getHideUnprotectedURLsMode

public boolean getHideUnprotectedURLsMode()
Returns the value of the dontShowUnprotectedURLs property.
Returns:
boolean Returns the value of the dontShowUnprotectedURLs property.
See Also:
setHideUnprotectedURLsMode(boolean)

getSessionType

public java.lang.String getSessionType()
Returns the value of the sessionType property.
See Also:
setSessionType(java.lang.String)

setSessionType

public void setSessionType(java.lang.String type)
                    throws java.beans.PropertyVetoException
Sets the sessionType property. The valid values are defined in ECLSession.
Parameters:
type - Session type.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

getCodePage

public java.lang.String getCodePage()
Returns the value of the codePage property.

setCodePage

public void setCodePage(java.lang.String codePage)
                 throws java.beans.PropertyVetoException
Sets the codePage property. The valid values are defined in ECLSession.
Parameters:
codePage - The new codepage.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

setAccessibilityEnabled

public void setAccessibilityEnabled(boolean accessibility)
                             throws java.beans.PropertyVetoException
Sets the accessibilityEnabled property. When true, this property enables the accessibility API in the terminal screen
Parameters:
accessibility - Whether accessibility is enabled of not
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isAccessibilityEnabled()

isAccessibilityEnabled

public boolean isAccessibilityEnabled()
Returns the value of the accessibilityEnabled property.
See Also:
setAccessibilityEnabled(boolean)

isMarkedAreaPrintingEnabled

public boolean isMarkedAreaPrintingEnabled()
Returns the value of the markedAreaPrintingEnabled property.
See Also:
setMarkedAreaPrintingEnabled(boolean)

setMarkedAreaPrintingEnabled

public void setMarkedAreaPrintingEnabled(boolean markedAreaPrinting)
                                  throws java.beans.PropertyVetoException
Sets the markedAreaPrintingEnabled property. When true, this property enables printing only marked area on the screen.
Parameters:
markedAreaPrinting - Whether marked area printing is enabled or not
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isMarkedAreaPrintingEnabled()

defaults

public static java.util.Properties defaults()
Returns a Properties object containing the default properties for this Bean.

getTraceName

public java.lang.String getTraceName()
Returns a trace identifier for this bean.
Overrides:
getTraceName in class HODPanelBean

set3270InputAreaIndication

public void set3270InputAreaIndication(java.lang.String whatKind)
                                throws java.beans.PropertyVetoException
Sets how the input fields should be indicated. For example, set3270InputAreaIndication ("Underline,Display")
Parameters:
String - A pair of values to indicate how an input field should be displayed:
  • First value (choose from):
    • Underline
    • Underdot
    • 3DRaised
    • 3DLowered
  • Second value (choose from):
    • Display
    • NonDisplay
    • DisplayAndNonDisplay
Throws:
java.beans.PropertyVetoException - Thrown if either of the values are not valid

get3270InputAreaIndication

public java.lang.String get3270InputAreaIndication()
Returns what the current setting is for indicating how input fields are indicated.

The set of possible values are:

setBackground3DColour

public void setBackground3DColour(java.awt.Color whatColour)
Sets what the background color should be for 3D input fields.
Parameters:
Color - Any color object.

getBackground3DColour

public java.awt.Color getBackground3DColour()
Returns Color object indicating what the current color is for 3D input fields.

getDefaultKeyboardRemap

public com.ibm.eNetwork.beans.HOD.keyremap.DefaultKeyboardRemap getDefaultKeyboardRemap()
Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help  API User's Guide 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD