All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.Screen

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.ibm.eNetwork.beans.HOD.HODPanelBean
                                   |
                                   +----com.ibm.eNetwork.beans.HOD.Screen

public class Screen
extends HODPanelBean
implements ECLConstants, HODConstants, SendKeyListener, ColorRemapListener, BlinkRemapListener, PSListener, OIAListener, 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
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
DBCSInputVisible boolean false read/write
fontName enum* Monospaced read/write
fontSize int 12 read/write
fontSizeBounded boolean true read/write
fontStyle enum* java.awt.Font.PLAIN read/write
lightPenMode boolean false read/write
OIAVisible boolean true read/write
sessionType enum* See Session read/write
rule boolean false read/write
3D boolean true read/write
accessibilityEnabled boolean false read/write
markedAreaPrintingEnabled boolean true 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)
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, 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.


Variable Index

 o ACCESSIBILITY_ENABLED
accessibilityEnabled property keyword
 o AUTO_FONT_SIZE
autoFontSize property keyword
 o AUTO_PACK
autoPack property keyword
 o BLOCK_CURSOR
blockCursor property keyword
 o BOX_DOWN
 o BOX_LEFT
 o BOX_RIGHT
 o BOX_UP
 o CENTERED
centered property keyword
 o CODE_PAGE
codePage property keyword
 o CURSOR_VISIBLE
cursor visible property keyword
 o DBCSINPUT_VISIBLE
DBCSInputVisible property keyword
 o FONT_NAME
fontName property keyword
 o FONT_SIZE
fontSize property keyword
 o FONT_SIZE_BOUNDED
fontSizeBounded property keyword
 o FONT_STYLE
fontStyle property keyword
 o LIGHT_PEN_MODE
lightPenMode property keyword
 o MARKED_AREA_PRINTING_ENABLED
markedAreaPrintingEnabled property keyword
 o MOUSE_ENABLED
mouse enabled property keyword
 o OIA_VISIBLE
OIAVisible property keyword
 o RULE
rule property keyword
 o SCREEN_3D
3D property keyword
 o SESSION_TYPE
sessionType property keyword

Constructor Index

 o Screen()
Screen Bean null constructor.
 o Screen(Properties)
Constructor that takes a Properties object containing the initial property settings.

Method Index

 o addKeyListener(KeyListener)
Adds a java.awt.event.KeyListener to the Screen Bean.
 o addScreenListener(ScreenListener)
Adds a ScreenListener.
 o addScreenMotionListener(ScreenMotionListener)
Adds a ScreenMotionListener.
 o addScreenMouseListener(ScreenMouseListener)
Adds a ScreenMouseListener.
 o addSendKeyListener(SendKeyListener)
Adds a SendKeyListener.
 o 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.

 o copyToClipboard()
Copies the selected box to the clipboard.
 o copyToClipboard(boolean)
Copies the selected box to the clipboard with conditional appending
 o cutToClipboard()
Copies the selected box to clipboard and clears the unprotected areas of the Screen.
 o defaults()
Returns a Properties object containing the default properties for this Bean.
 o dispose()
Disposes of Screen and all of its resources.
 o drawBox(int)
Draws the cut and paste selection box on the screen.
 o getCodePage()
Returns the value of the codePage property.
 o getColumns()
Returns the number of columns represented on the screen.
 o getFont()
Returns the current Screen font.
 o getFontName()
Returns the value of the fontName property.
 o getFontSize()
Returns the value of the fontSize property.
 o getFontStyle()
Returns the value of the fontStyle property.
 o getRows()
Returns the number of rows represented on the screen.
 o getSelected(boolean)
Returns an Insets object containing the coordinates, in Screen rows and columns, for the selected box.
 o getSessionType()
Returns the value of the sessionType property.
 o getTraceName()
Returns a trace identifier for this bean.
 o GUIEvent(GUIEvent)
Handler method for GUIEvents.
 o is3D()
Returns the value of the 3D property.
 o isAccessibilityEnabled()
Returns the value of the accessibilityEnabled property.
 o isAutoFontSize()
Returns the value of the autoFontSize property.
 o isAutoPack()
Returns the value of the autoPack property.
 o isBlockCursor()
Returns the value of the block cursor property.
 o isCentered()
Returns the value of the centered property.
 o isCursorVisible()
Returns whether cursor is made visible by Screen.
 o isDBCSInputVisible()
Returns the value of the DBCSInputVisible property.
 o isFontSizeBounded()
Returns the value of the fontSizeBounded property.
 o isLightPenMode()
Returns the value of the lightPenMode property.
 o isMarkedAreaPrintingEnabled()
Returns the value of the markedAreaPrintingEnabled property.
 o isMorePasteDataAvailable()
Once a paste or paste-next operation occurs, this method returns whether there is more data available that did not paste.
 o isMouseEnabled()
Returns whether mouse events are being handled by Screen.
 o isOIAVisible()
Returns the value of the OIAVisible property.
 o isRule()
Returns the value of the rule property.
 o listFontNames(String)
Enumerates the list of valid monospaced fonts available on the system.
 o listFontStyles()
Enumerates a list of valid font styles.
 o moveBox(int)
Moves the cut and paste selection box on the screen.
 o OIAEvent(OIAEvent)
Handler method for OIAEvents.
 o pasteFromClipboard()
Pastes the data from the clipboard at the current cursor location.
 o pasteFromClipboard(boolean)
Pastes the data from the clipboard at the current cursor location with conditional paste next functionality
 o printScreen()
Prints the current Screen contents to the default printer.
 o PSEvent(PSEvent)
Handler method for PSEvents.
 o remapBlink(BlinkRemapEvent)
Handler method for BlinkRemapEvents.
 o remapColor(ColorRemapEvent)
Handler method for ColorRemapEvents.
 o removeKeyListener(KeyListener)
Removes a java.awt.event.KeyListener from the Screen Bean.
 o removeScreenListener(ScreenListener)
Removes a ScreenListener.
 o removeScreenMotionListener(ScreenMotionListener)
Removes a ScreenMotionListener.
 o removeScreenMouseListener(ScreenMouseListener)
Removes a ScreenMouseListener.
 o removeSendKeyListener(SendKeyListener)
Removes a SendKeyListener.
 o requestFocus()
Requests focus on Screen.
 o selectAll()
Selects the entire Screen for the purpose of copying or cutting the area.
 o sendKeys(SendKeyEvent)
Handler method for SendKeyEvents.
 o set3D(boolean)
Sets the 3D property.
 o setAccessibilityEnabled(boolean)
Sets the accessibilityEnabled property.
 o setAutoFontSize(boolean)
Sets the autoFontSize property.
 o setAutoPack(boolean)
Sets the autoPack property.
 o setBlockCursor(boolean)
Sets the block cursor property.
 o setCentered(boolean)
Sets the centered property.
 o setCodePage(String)
Sets the codePage property.
 o setCursorVisible(boolean)
Sets whether the cursor should be made visible by Screen.
 o setDBCSInputVisible(boolean)
Sets the DBCSinputVisible property (3270 and 5250 DBCS sessions only).
 o setFont(Font)
Sets the Screen font.
 o setFontName(String)
Sets the fontName property.
 o setFontSize(int)
Sets the fontSize property.
 o setFontSizeBounded(boolean)
Sets the fontSizeBounded property.
 o setFontStyle(int)
Sets the fontStyle property.
 o setLightPenMode(boolean)
Sets the lightPenMode property (3270 and CICS sessions only).
 o setMarkedAreaPrintingEnabled(boolean)
Sets the markedAreaPrintingEnabled property.
 o setMouseEnabled(boolean)
Sets whether mouse events will be handled by Screen.
 o setOIAVisible(boolean)
Sets the OIAVisible property.
 o setRule(boolean)
Sets the rule property.
 o setSessionType(String)
Sets the sessionType property.
 o unMark()
Unmarks the selected box on the Screen.

Variables

 o BOX_UP
 public static final int BOX_UP
 o BOX_DOWN
 public static final int BOX_DOWN
 o BOX_LEFT
 public static final int BOX_LEFT
 o BOX_RIGHT
 public static final int BOX_RIGHT
 o FONT_NAME
 public static final String FONT_NAME
fontName property keyword

 o FONT_STYLE
 public static final String FONT_STYLE
fontStyle property keyword

 o FONT_SIZE
 public static final String FONT_SIZE
fontSize property keyword

 o OIA_VISIBLE
 public static final String OIA_VISIBLE
OIAVisible property keyword

 o DBCSINPUT_VISIBLE
 public static final String DBCSINPUT_VISIBLE
DBCSInputVisible property keyword

 o SCREEN_3D
 public static final String SCREEN_3D
3D property keyword

 o AUTO_FONT_SIZE
 public static final String AUTO_FONT_SIZE
autoFontSize property keyword

 o FONT_SIZE_BOUNDED
 public static final String FONT_SIZE_BOUNDED
fontSizeBounded property keyword

 o AUTO_PACK
 public static final String AUTO_PACK
autoPack property keyword

 o CENTERED
 public static final String CENTERED
centered property keyword

 o RULE
 public static final String RULE
rule property keyword

 o BLOCK_CURSOR
 public static final String BLOCK_CURSOR
blockCursor property keyword

 o LIGHT_PEN_MODE
 public static final String LIGHT_PEN_MODE
lightPenMode property keyword

 o CODE_PAGE
 public static final String CODE_PAGE
codePage property keyword

 o SESSION_TYPE
 public static final String SESSION_TYPE
sessionType property keyword

 o MOUSE_ENABLED
 public static final String MOUSE_ENABLED
mouse enabled property keyword

 o CURSOR_VISIBLE
 public static final String CURSOR_VISIBLE
cursor visible property keyword

 o ACCESSIBILITY_ENABLED
 public static final String ACCESSIBILITY_ENABLED
accessibilityEnabled property keyword

 o MARKED_AREA_PRINTING_ENABLED
 public static final String MARKED_AREA_PRINTING_ENABLED
markedAreaPrintingEnabled property keyword

Constructors

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

 o Screen
 public Screen(Properties newProperties) throws 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: PropertyVetoException
Fired if an invalid property value is given.

Methods

 o 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
 o getFont
 public Font getFont()
Returns the current Screen font.

Overrides:
getFont in class Component
See Also:
setFont
 o setFont
 public void setFont(Font f)
Sets the Screen font. The font specified must be a monospaced font.

Parameters:
f - The new font for Screen. Must be a monospaced font.
Overrides:
setFont in class Component
See Also:
getFont
 o getColumns
 public synchronized int getColumns()
Returns the number of columns represented on the screen.

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

 o 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.

 o getSelected
 public 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.

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

 o 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.

 o 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
 o 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.

 o 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.

 o 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.

 o 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.

 o 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.

 o 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.

 o 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.

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

 o addKeyListener
 public synchronized void addKeyListener(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.

Parameters:
l - KeyListener that receives KeyEvents.
Overrides:
addKeyListener in class Component
See Also:
removeKeyListener
 o removeKeyListener
 public synchronized void removeKeyListener(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.

Parameters:
l - KeyListener that no longer receive KeyEvents.
Overrides:
removeKeyListener in class Component
See Also:
addKeyListener
 o addScreenListener
 public synchronized 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, ScreenEvent
 o removeScreenListener
 public synchronized void removeScreenListener(ScreenListener l)
Removes a ScreenListener.

Parameters:
l - ScreenListener that will be removed
See Also:
addScreenListener, ScreenEvent
 o addScreenMouseListener
 public synchronized void addScreenMouseListener(ScreenMouseListener l)
Adds a ScreenMouseListener. ScreenMouseListeners are notified when mouse events occur.

Parameters:
l - ScreenMouseListener that receives ScreenMouseEvents
See Also:
removeScreenMouseListener, ScreenMouseEvent
 o removeScreenMouseListener
 public synchronized void removeScreenMouseListener(ScreenMouseListener l)
Removes a ScreenMouseListener.

Parameters:
l - ScreenMouseListener that will be removed
See Also:
addScreenMouseListener, ScreenMouseEvent
 o addScreenMotionListener
 public synchronized void addScreenMotionListener(ScreenMotionListener l)
Adds a ScreenMotionListener. ScreenMotionListeners are notified when mouse motion events occur.

Parameters:
l - ScreenMotionListener that receives ScreenMouseEvents
See Also:
removeScreenMotionListener, ScreenMouseEvent
 o removeScreenMotionListener
 public synchronized void removeScreenMotionListener(ScreenMotionListener l)
Removes a ScreenMotionListener.

Parameters:
l - ScreenMotionListener that will be removed
See Also:
addScreenMotionListener, ScreenMouseEvent
 o addSendKeyListener
 public synchronized void addSendKeyListener(SendKeyListener l)
Adds a SendKeyListener. SendKeyListeners are notified when Screen fires a SendKeyEvent.

See Also:
removeSendKeyListener, SendKeyEvent
 o removeSendKeyListener
 public synchronized void removeSendKeyListener(SendKeyListener l)
Removes a SendKeyListener.

See Also:
addSendKeyListener, SendKeyEvent
 o 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.

Parameters:
evt - SendKeyEvent that is refired to Screen-owned SendKeyListeners.
 o remapColor
 public void remapColor(ColorRemapEvent evt)
Handler method for ColorRemapEvents. ColorRemapEvents can be fired to Screen to change the normal colors.

Parameters:
evt - ColorRemapEvent which changes some default color on the Screen.
 o remapBlink
 public void remapBlink(BlinkRemapEvent evt)
Handler method for BlinkRemapEvents. BlinkRemapEvents can be fired to Screen to change the behaviour of blinking fields.

Parameters:
evt - BlinkRemapEvent which changes default blink property off the Screen.
 o PSEvent
 public void PSEvent(PSEvent evt)
Handler method for PSEvents. Screen reacts to the PSEvents to display the presentation space.

Parameters:
evt - A PSEvent generated by the Session Bean.
 o OIAEvent
 public void OIAEvent(OIAEvent evt)
Handler method for OIAEvents. Screen reacts to the OIAEvents to display the operator information area.

Parameters:
evt - An OIAEvent generated by the Session Bean.
 o 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.

Parameters:
evt - A GUIEvent generated by the Session Bean.
 o requestFocus
 public void requestFocus()
Requests focus on Screen.

Overrides:
requestFocus in class Component
 o setFontName
 public void setFontName(String fontName) throws 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: PropertyVetoException
Thrown if the specified font name is not a monospaced font.
See Also:
listFontNames, getFontName
 o getFontName
 public String getFontName()
Returns the value of the fontName property.

See Also:
setFontName
 o listFontNames
 public static Enumeration listFontNames(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, getCodePage
 o setFontSize
 public void setFontSize(int fontSize) throws PropertyVetoException
Sets the fontSize property. This property is ignored when the autoFontSize property is set to true.

Parameters:
fontSize - The new font size.
Throws: PropertyVetoException
Thrown if the specified font size is too large.
See Also:
getFontSize
 o getFontSize
 public int getFontSize()
Returns the value of the fontSize property.

See Also:
setFontSize
 o setFontStyle
 public void setFontStyle(int fontStyle) throws PropertyVetoException
Sets the fontStyle property.

Valid values:

The styles can be combined for mixed styles.

Parameters:
fontStyle - The new font style.
Throws: PropertyVetoException
Thrown if the specified font style is not valid.
See Also:
listFontStyles, getFontStyle
 o getFontStyle
 public int getFontStyle()
Returns the value of the fontStyle property.

See Also:
setFontStyle
 o listFontStyles
 public static Enumeration listFontStyles()
Enumerates a list of valid font styles.

See Also:
getFontStyle, setFontStyle
 o setFontSizeBounded
 public void setFontSizeBounded(boolean bounded) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isFontSizeBounded
 o isFontSizeBounded
 public boolean isFontSizeBounded()
Returns the value of the fontSizeBounded property.

See Also:
setFontSizeBounded
 o set3D
 public void set3D(boolean threeD) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
is3D
 o is3D
 public boolean is3D()
Returns the value of the 3D property.

See Also:
set3D
 o setOIAVisible
 public void setOIAVisible(boolean showOIA) throws PropertyVetoException
Sets the OIAVisible property. When true, Screen displays the Operator Information Area (OIA).

Parameters:
showOIA - Whether the Screen shows OIA or not.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isOIAVisible
 o isOIAVisible
 public boolean isOIAVisible()
Returns the value of the OIAVisible property.

See Also:
setOIAVisible
 o setDBCSInputVisible
 public void setDBCSInputVisible(boolean showDBCSInput) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isDBCSInputVisible
 o isDBCSInputVisible
 public boolean isDBCSInputVisible()
Returns the value of the DBCSInputVisible property.

See Also:
setDBCSInputVisible
 o setAutoFontSize
 public void setAutoFontSize(boolean autoFontSize) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isAutoFontSize
 o isAutoFontSize
 public boolean isAutoFontSize()
Returns the value of the autoFontSize property.

See Also:
setAutoFontSize
 o setAutoPack
 public void setAutoPack(boolean autoPack) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isAutoPack
 o isAutoPack
 public boolean isAutoPack()
Returns the value of the autoPack property.

See Also:
setAutoPack
 o setCentered
 public void setCentered(boolean center) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isCentered
 o isCentered
 public boolean isCentered()
Returns the value of the centered property.

See Also:
setCentered
 o setRule
 public void setRule(boolean rule) throws 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: 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
 o isRule
 public boolean isRule()
Returns the value of the rule property.

See Also:
setRule
 o setMouseEnabled
 public void setMouseEnabled(boolean val) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isMouseEnabled
 o isMouseEnabled
 public boolean isMouseEnabled()
Returns whether mouse events are being handled by Screen.

See Also:
setMouseEnabled
 o setCursorVisible
 public void setCursorVisible(boolean val) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isCursorVisible
 o isCursorVisible
 public boolean isCursorVisible()
Returns whether cursor is made visible by Screen.

See Also:
setCursorVisible
 o setBlockCursor
 public void setBlockCursor(boolean block) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isBlockCursor
 o isBlockCursor
 public boolean isBlockCursor()
Returns the value of the block cursor property.

See Also:
setBlockCursor
 o setLightPenMode
 public void setLightPenMode(boolean lightPenMode) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isLightPenMode
 o isLightPenMode
 public boolean isLightPenMode()
Returns the value of the lightPenMode property.

See Also:
setLightPenMode
 o getSessionType
 public String getSessionType()
Returns the value of the sessionType property.

See Also:
setSessionType
 o setSessionType
 public void setSessionType(String type) throws PropertyVetoException
Sets the sessionType property. The valid values are defined in ECLSession.

Parameters:
type - Session type.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
 o getCodePage
 public String getCodePage()
Returns the value of the codePage property.

 o setCodePage
 public void setCodePage(String codePage) throws PropertyVetoException
Sets the codePage property. The valid values are defined in ECLSession.

Parameters:
codePage - The new codepage.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
 o setAccessibilityEnabled
 public void setAccessibilityEnabled(boolean accessibility) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isAccessibilityEnabled
 o isAccessibilityEnabled
 public boolean isAccessibilityEnabled()
Returns the value of the accessibilityEnabled property.

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

See Also:
setMarkedAreaPrintingEnabled
 o setMarkedAreaPrintingEnabled
 public void setMarkedAreaPrintingEnabled(boolean markedAreaPrinting) throws 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: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isMarkedAreaPrintingEnabled
 o defaults
 public static Properties defaults()
Returns a Properties object containing the default properties for this Bean.

 o getTraceName
 public String getTraceName()
Returns a trace identifier for this bean.

Overrides:
getTraceName in class HODPanelBean

All Packages  Class Hierarchy  This Package  Previous  Next  Index