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.
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 |
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 |
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) |
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) |
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.
-
ACCESSIBILITY_ENABLED
- accessibilityEnabled property keyword
-
AUTO_FONT_SIZE
- autoFontSize property keyword
-
AUTO_PACK
- autoPack property keyword
-
BLOCK_CURSOR
- blockCursor property keyword
-
BOX_DOWN
-
-
BOX_LEFT
-
-
BOX_RIGHT
-
-
BOX_UP
-
-
CENTERED
- centered property keyword
-
CODE_PAGE
- codePage property keyword
-
CURSOR_VISIBLE
- cursor visible property keyword
-
DBCSINPUT_VISIBLE
- DBCSInputVisible property keyword
-
FONT_NAME
- fontName property keyword
-
FONT_SIZE
- fontSize property keyword
-
FONT_SIZE_BOUNDED
- fontSizeBounded property keyword
-
FONT_STYLE
- fontStyle property keyword
-
LIGHT_PEN_MODE
- lightPenMode property keyword
-
MARKED_AREA_PRINTING_ENABLED
- markedAreaPrintingEnabled property keyword
-
MOUSE_ENABLED
- mouse enabled property keyword
-
OIA_VISIBLE
- OIAVisible property keyword
-
RULE
- rule property keyword
-
SCREEN_3D
- 3D property keyword
-
SESSION_TYPE
- sessionType property keyword
-
Screen()
- Screen Bean null constructor.
-
Screen(Properties)
- Constructor that takes a Properties object containing the initial
property settings.
-
addKeyListener(KeyListener)
- Adds a java.awt.event.KeyListener to the Screen Bean.
-
addScreenListener(ScreenListener)
- Adds a ScreenListener.
-
addScreenMotionListener(ScreenMotionListener)
- Adds a ScreenMotionListener.
-
addScreenMouseListener(ScreenMouseListener)
- Adds a ScreenMouseListener.
-
addSendKeyListener(SendKeyListener)
- Adds a SendKeyListener.
-
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.
-
copyToClipboard()
- Copies the selected box to the clipboard.
-
copyToClipboard(boolean)
- Copies the selected box to the clipboard with conditional appending
-
cutToClipboard()
- Copies the selected box to clipboard and clears the unprotected areas
of the Screen.
-
defaults()
- Returns a Properties object containing the default properties
for this Bean.
-
dispose()
- Disposes of Screen and all of its resources.
-
drawBox(int)
- Draws the cut and paste selection box on the screen.
-
getCodePage()
- Returns the value of the codePage property.
-
getColumns()
- Returns the number of columns represented on the screen.
-
getFont()
- Returns the current Screen font.
-
getFontName()
- Returns the value of the fontName property.
-
getFontSize()
- Returns the value of the fontSize property.
-
getFontStyle()
- Returns the value of the fontStyle property.
-
getRows()
- Returns the number of rows represented on the screen.
-
getSelected(boolean)
- Returns an Insets object containing the coordinates, in Screen
rows and columns, for the selected box.
-
getSessionType()
- Returns the value of the sessionType property.
-
getTraceName()
- Returns a trace identifier for this bean.
-
GUIEvent(GUIEvent)
- Handler method for GUIEvents.
-
is3D()
- Returns the value of the 3D property.
-
isAccessibilityEnabled()
- Returns the value of the accessibilityEnabled property.
-
isAutoFontSize()
- Returns the value of the autoFontSize property.
-
isAutoPack()
- Returns the value of the autoPack property.
-
isBlockCursor()
- Returns the value of the block cursor property.
-
isCentered()
- Returns the value of the centered property.
-
isCursorVisible()
- Returns whether cursor is made visible by Screen.
-
isDBCSInputVisible()
- Returns the value of the DBCSInputVisible property.
-
isFontSizeBounded()
- Returns the value of the fontSizeBounded property.
-
isLightPenMode()
- Returns the value of the lightPenMode property.
-
isMarkedAreaPrintingEnabled()
- Returns the value of the markedAreaPrintingEnabled property.
-
isMorePasteDataAvailable()
- Once a paste or paste-next operation occurs, this method returns whether
there is more data available that did not paste.
-
isMouseEnabled()
- Returns whether mouse events are being handled by Screen.
-
isOIAVisible()
- Returns the value of the OIAVisible property.
-
isRule()
- Returns the value of the rule property.
-
listFontNames(String)
- Enumerates the list of valid monospaced fonts available on the
system.
-
listFontStyles()
- Enumerates a list of valid font styles.
-
moveBox(int)
- Moves the cut and paste selection box on the screen.
-
OIAEvent(OIAEvent)
- Handler method for OIAEvents.
-
pasteFromClipboard()
- Pastes the data from the clipboard at the current cursor location.
-
pasteFromClipboard(boolean)
- Pastes the data from the clipboard at the current cursor location with
conditional paste next functionality
-
printScreen()
- Prints the current Screen contents to the default printer.
-
PSEvent(PSEvent)
- Handler method for PSEvents.
-
remapBlink(BlinkRemapEvent)
- Handler method for BlinkRemapEvents.
-
remapColor(ColorRemapEvent)
- Handler method for ColorRemapEvents.
-
removeKeyListener(KeyListener)
- Removes a java.awt.event.KeyListener from the Screen Bean.
-
removeScreenListener(ScreenListener)
- Removes a ScreenListener.
-
removeScreenMotionListener(ScreenMotionListener)
- Removes a ScreenMotionListener.
-
removeScreenMouseListener(ScreenMouseListener)
- Removes a ScreenMouseListener.
-
removeSendKeyListener(SendKeyListener)
- Removes a SendKeyListener.
-
requestFocus()
- Requests focus on Screen.
-
selectAll()
- Selects the entire Screen for the purpose of copying or cutting the area.
-
sendKeys(SendKeyEvent)
- Handler method for SendKeyEvents.
-
set3D(boolean)
- Sets the 3D property.
-
setAccessibilityEnabled(boolean)
- Sets the accessibilityEnabled property.
-
setAutoFontSize(boolean)
- Sets the autoFontSize property.
-
setAutoPack(boolean)
- Sets the autoPack property.
-
setBlockCursor(boolean)
- Sets the block cursor property.
-
setCentered(boolean)
- Sets the centered property.
-
setCodePage(String)
- Sets the codePage property.
-
setCursorVisible(boolean)
- Sets whether the cursor should be made visible by Screen.
-
setDBCSInputVisible(boolean)
- Sets the DBCSinputVisible property (3270 and 5250 DBCS sessions only).
-
setFont(Font)
- Sets the Screen font.
-
setFontName(String)
- Sets the fontName property.
-
setFontSize(int)
- Sets the fontSize property.
-
setFontSizeBounded(boolean)
- Sets the fontSizeBounded property.
-
setFontStyle(int)
- Sets the fontStyle property.
-
setLightPenMode(boolean)
- Sets the lightPenMode property (3270 and CICS sessions only).
-
setMarkedAreaPrintingEnabled(boolean)
- Sets the markedAreaPrintingEnabled property.
-
setMouseEnabled(boolean)
- Sets whether mouse events will be handled by Screen.
-
setOIAVisible(boolean)
- Sets the OIAVisible property.
-
setRule(boolean)
- Sets the rule property.
-
setSessionType(String)
- Sets the sessionType property.
-
unMark()
- Unmarks the selected box on the Screen.
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 String FONT_NAME
- fontName property keyword
FONT_STYLE
public static final String FONT_STYLE
- fontStyle property keyword
FONT_SIZE
public static final String FONT_SIZE
- fontSize property keyword
OIA_VISIBLE
public static final String OIA_VISIBLE
- OIAVisible property keyword
DBCSINPUT_VISIBLE
public static final String DBCSINPUT_VISIBLE
- DBCSInputVisible property keyword
SCREEN_3D
public static final String SCREEN_3D
- 3D property keyword
AUTO_FONT_SIZE
public static final String AUTO_FONT_SIZE
- autoFontSize property keyword
FONT_SIZE_BOUNDED
public static final String FONT_SIZE_BOUNDED
- fontSizeBounded property keyword
AUTO_PACK
public static final String AUTO_PACK
- autoPack property keyword
CENTERED
public static final String CENTERED
- centered property keyword
RULE
public static final String RULE
- rule property keyword
BLOCK_CURSOR
public static final String BLOCK_CURSOR
- blockCursor property keyword
LIGHT_PEN_MODE
public static final String LIGHT_PEN_MODE
- lightPenMode property keyword
CODE_PAGE
public static final String CODE_PAGE
- codePage property keyword
SESSION_TYPE
public static final String SESSION_TYPE
- sessionType property keyword
MOUSE_ENABLED
public static final String MOUSE_ENABLED
- mouse enabled property keyword
CURSOR_VISIBLE
public static final String CURSOR_VISIBLE
- cursor visible property keyword
ACCESSIBILITY_ENABLED
public static final String ACCESSIBILITY_ENABLED
- accessibilityEnabled property keyword
MARKED_AREA_PRINTING_ENABLED
public static final String MARKED_AREA_PRINTING_ENABLED
- markedAreaPrintingEnabled property keyword
Screen
public Screen()
- Screen Bean null constructor. This constructor uses the default values
for all properties.
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.
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 Font getFont()
- Returns the current Screen font.
- Overrides:
- getFont
- See Also:
- setFont
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
- See Also:
- getFont
getColumns
public synchronized int getColumns()
- Returns the number of columns represented on the screen.
getRows
public synchronized 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 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.
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.
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
- See Also:
- removeKeyListener
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
- See Also:
- addKeyListener
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
removeScreenListener
public synchronized void removeScreenListener(ScreenListener l)
- Removes a ScreenListener.
- Parameters:
- l - ScreenListener that will be removed
- See Also:
- addScreenListener, ScreenEvent
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
removeScreenMouseListener
public synchronized void removeScreenMouseListener(ScreenMouseListener l)
- Removes a ScreenMouseListener.
- Parameters:
- l - ScreenMouseListener that will be removed
- See Also:
- addScreenMouseListener, ScreenMouseEvent
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
removeScreenMotionListener
public synchronized void removeScreenMotionListener(ScreenMotionListener l)
- Removes a ScreenMotionListener.
- Parameters:
- l - ScreenMotionListener that will be removed
- See Also:
- addScreenMotionListener, ScreenMouseEvent
addSendKeyListener
public synchronized void addSendKeyListener(SendKeyListener l)
- Adds a SendKeyListener. SendKeyListeners are notified
when Screen fires a SendKeyEvent.
- See Also:
- removeSendKeyListener, SendKeyEvent
removeSendKeyListener
public synchronized void removeSendKeyListener(SendKeyListener l)
- Removes a SendKeyListener.
- See Also:
- addSendKeyListener, 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- Parameters:
- evt - A GUIEvent generated by the Session Bean.
requestFocus
public void requestFocus()
- Requests focus on Screen.
- Overrides:
- requestFocus
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
getFontName
public String getFontName()
- Returns the value of the fontName property.
- See Also:
- setFontName
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
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
getFontSize
public int getFontSize()
- Returns the value of the fontSize property.
- See Also:
- setFontSize
setFontStyle
public void setFontStyle(int fontStyle) throws PropertyVetoException
- Sets the fontStyle property.
Valid values:
- java.awt.Font.BOLD
- java.awt.Font.ITALIC
- java.awt.Font.PLAIN
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
getFontStyle
public int getFontStyle()
- Returns the value of the fontStyle property.
- See Also:
- setFontStyle
listFontStyles
public static Enumeration listFontStyles()
- Enumerates a list of valid font styles.
- See Also:
- getFontStyle, setFontStyle
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
isFontSizeBounded
public boolean isFontSizeBounded()
- Returns the value of the fontSizeBounded property.
- See Also:
- setFontSizeBounded
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
is3D
public boolean is3D()
- Returns the value of the 3D property.
- See Also:
- set3D
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
isOIAVisible
public boolean isOIAVisible()
- Returns the value of the OIAVisible property.
- See Also:
- setOIAVisible
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
isDBCSInputVisible
public boolean isDBCSInputVisible()
- Returns the value of the DBCSInputVisible property.
- See Also:
- setDBCSInputVisible
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
isAutoFontSize
public boolean isAutoFontSize()
- Returns the value of the autoFontSize property.
- See Also:
- setAutoFontSize
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
isAutoPack
public boolean isAutoPack()
- Returns the value of the autoPack property.
- See Also:
- setAutoPack
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
isCentered
public boolean isCentered()
- Returns the value of the centered property.
- See Also:
- setCentered
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
isRule
public boolean isRule()
- Returns the value of the rule property.
- See Also:
- setRule
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
isMouseEnabled
public boolean isMouseEnabled()
- Returns whether mouse events are being handled by Screen.
- See Also:
- setMouseEnabled
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
isCursorVisible
public boolean isCursorVisible()
- Returns whether cursor is made visible by Screen.
- See Also:
- setCursorVisible
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
isBlockCursor
public boolean isBlockCursor()
- Returns the value of the block cursor property.
- See Also:
- setBlockCursor
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
isLightPenMode
public boolean isLightPenMode()
- Returns the value of the lightPenMode property.
- See Also:
- setLightPenMode
getSessionType
public String getSessionType()
- Returns the value of the sessionType property.
- See Also:
- setSessionType
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.
getCodePage
public String getCodePage()
- Returns the value of the codePage property.
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.
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
isAccessibilityEnabled
public boolean isAccessibilityEnabled()
- Returns the value of the accessibilityEnabled property.
- See Also:
- setAccessibilityEnabled
isMarkedAreaPrintingEnabled
public boolean isMarkedAreaPrintingEnabled()
- Returns the value of the markedAreaPrintingEnabled property.
- See Also:
- setMarkedAreaPrintingEnabled
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
defaults
public static Properties defaults()
- Returns a Properties object containing the default properties
for this Bean.
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