se.entra.phantom.client

Enum Beep

java.lang.Object

java.lang.Enum<Beep>

se.entra.phantom.client.Beep

All Implemented Interfaces:

Serializable, Comparable<Beep>

public enum Beep
extends Enum<Beep>

Plays a beep of a specific type. The beep may be suppressed using the command line parameter "NOBEEP".

The parameter takes one or several parameters listed below, separated by ':'.

• *
  All beeps.
  
• MSGBOX
  Message box shown with non-question type.
  
• INVALID
  Invalid operation.
  
• MOUSE
  Invalid mouse operation such as click, drag.
  
• HOST
  3270/5250 host-induced terminal alarm beeps.
  
• HOST_ERR
  Alarm for server error in the 3270/5250 session.
  
• TERMINAL
  Invalid operation in the 3270/5250 terminal.
  
• SERVER
  Server-side, API-induced from REXX, Java or System.

Author:

Christopher Mindus

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOST Host induced 3270/5250 terminal alarm.
HOST_ERR Alarm for server error in 3270/5250 terminal.
INVALID Beep for general invalid operations.
MOUSE Beep for invalid mouse operation such as click, drag, etc.
MSGBOX Beep when message box is shown with non-question types.
SERVER Server-side API induced beep (REXX, Java or System).
TERMINAL Beep for invalid 3270/5250 terminal operations.

Method Summary

Modifier and Type	Method and Description
void	enable(boolean on) Enables or disables the beep.
boolean	isEnabled() Verifies if the beep is enabled.
static void	parse(String spec) Parses the command line option parameter NOBEEP, after the string NOBEEP:.
void	play() Plays the beep, perhaps disabled using command line options, using the default Toolkit.
void	play(Component component) Plays the beep, perhaps disabled using command line options.
static Beep	valueOf(String name) Returns the enum constant of this type with the specified name.
static Beep[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MSGBOX

public static final Beep MSGBOX

Beep when message box is shown with non-question types.

INVALID

public static final Beep INVALID

Beep for general invalid operations.

MOUSE

public static final Beep MOUSE

Beep for invalid mouse operation such as click, drag, etc.

HOST

public static final Beep HOST

Host induced 3270/5250 terminal alarm.

HOST_ERR

public static final Beep HOST_ERR

Alarm for server error in 3270/5250 terminal.

TERMINAL

public static final Beep TERMINAL

Beep for invalid 3270/5250 terminal operations.

SERVER

public static final Beep SERVER

Server-side API induced beep (REXX, Java or System).

Method Detail

values

public static Beep[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Beep c : Beep.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Beep valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

play

public void play()

Plays the beep, perhaps disabled using command line options, using the default Toolkit.

play

public void play(Component component)

Plays the beep, perhaps disabled using command line options.

Parameters:

component - The component, or null to use the default Toolkit.

enable

public void enable(boolean on)

Enables or disables the beep.

Parameters:

on - Flag for beep enabled if true, disabled when false.

isEnabled

public boolean isEnabled()

Verifies if the beep is enabled.

Returns:

true if the beep is enabled, false if disabled.

parse

public static void parse(String spec)

Parses the command line option parameter NOBEEP, after the string NOBEEP:. The console will print the disabled and enabled beeps.

Parameters:

spec - The parameters for NOBEEP option separated by ':'.