com.goldencode.p2j.ui

Class HelpService

java.lang.Object

com.goldencode.p2j.ui.HelpService

public class HelpService
extends java.lang.Object

A class that collects option information about a SYSTEM-HELP statement using chained methods.

Each public method emulates an option of the statement. They do a quick validation. If successful they return a reference to this object to allow other method to be chained.

The execute() method does the final checks, send the request with gathered options to client.

Field Summary

Fields

Modifier and Type	Field and Description
private SystemHelpAction	action The help system primitive to be executed.
private java.lang.String	altKey The alternative keyword for the desired help topic.
private java.lang.String	command The help macro to execute.
private boolean	contents The flag for CONTENTS option.
private int	contentTopic The context number for the new contents help topic in a SET-CONTENTS help stmt.
private int	context Flag that CONTEXT mode was configured.
private int	contextPopup The context number for the help topic in a CONTEXT-POPUP help statement.
private boolean	finder Flags the FINDER option is activated
private boolean	forceFile Flags the FORCE-FILE option is activated
private int	height The HEIGHT of the help window.
private boolean	help Flags the HELP option is activated
private java.lang.String	helpFile Specifies the pathname of a help file.
private java.lang.String	key The keyword for the desired help topic.
private static CentralLogger	LOG Logger
private boolean	maximized Flag to maximize an existing (already opened) help window.
private java.lang.String	multipleKey The keyword that is located in the keyword table in a MULTIPLE-KEY help statement.
private java.lang.String	partialKey The partial key for the desired help topic in a PARTIAL-KEY statement.
private boolean	quit Flags the help application that help is no longer required.
private java.lang.Object[]	specificParams The list of specific parameters to current action (optional).
private java.lang.String	tableId The single character keyword table identifier for the required table in a MULTIPLE-KEY help statement.
private java.lang.String	topic The HELP-TOPIC option active if this is not null.
private int	width The WIDTH of the help window.
private java.lang.String	windowName The window-name parameter represents the primary or secondary window name as defined in the [WINDOWS] section of the help project file.
private int	x The X coordinate for the help window.
private int	y The Y coordinate for the help window.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HelpService() Private constructor.

Method Summary

Modifier and Type	Method and Description
HelpService	contents() Activates the CONTENTS mode.
void	execute() The chain-terminator method.
HelpService	finder() Activates the FINDER mode.
HelpService	forceFile() Activates the FORCE-FILE mode: Ensures that the correct help file is open and displayed.
static java.lang.String	getSystemHelpServicePath() Get the system help service path relative to the service host for accessing the system help resources from the browser.
HelpService	help() Activates the HELP mode.
HelpService	maximized() Activates the POSITION MAXIMIZE mode, when executed, it maximizes an existing (already opened) help window.
static HelpService	prepare(java.lang.String helpFile) Prepares a new configuration based on helpFile.
static HelpService	prepare(Text helpFile) Prepares a new configuration based on helpFile.
HelpService	quit() Activates the QUIT mode.
private void	setAction(SystemHelpAction a) Validates and sets the current action to be executed.
HelpService	setAlternateKey(java.lang.String altKey) Activates the ALTERNATE-KEY mode.
HelpService	setAlternateKey(Text altKey) Activates the ALTERNATE-KEY mode.
HelpService	setCommand(java.lang.String command) Activates the COMMAND mode.
HelpService	setCommand(Text command) Activates the COMMAND mode.
HelpService	setContents(long contents) Activates the SET-CONTENTS mode.
HelpService	setContents(NumberType contents) Activates the SET-CONTENTS mode.
HelpService	setContext(long context) Activates the CONTEXT mode.
HelpService	setContext(NumberType context) Activates the CONTEXT mode.
HelpService	setContextPopup(long contextPopup) Activates the CONTEXT-POPUP mode.
HelpService	setContextPopup(NumberType contextPopup) Activates the CONTEXT-POPUP mode.
HelpService	setKey(java.lang.String key) Activates the KEY mode.
HelpService	setKey(Text key) Activates the KEY mode.
HelpService	setMultipleKey(java.lang.String tableId, java.lang.String multipleKey) Activates the MULTIPLE-KEY mode.
HelpService	setMultipleKey(java.lang.String tableId, Text multipleKey) Activates the MULTIPLE-KEY mode.
HelpService	setMultipleKey(Text tableId, java.lang.String multipleKey) Activates the MULTIPLE-KEY mode.
HelpService	setMultipleKey(Text tableId, Text multipleKey) Activates the MULTIPLE-KEY mode.
HelpService	setPartialKey(java.lang.String partialKey) Activates the PARTIAL-KEY mode.
HelpService	setPartialKey(Text partialKey) Activates the PARTIAL-KEY mode.
HelpService	setPosition(long x, long y, long width, long height) Sets the new POSITION and geometry to help window.
HelpService	setPosition(NumberType x, NumberType y, NumberType width, NumberType height) Sets the new POSITION and geometry to help window.
HelpService	setTopic(java.lang.String topic) Activates the HELP-TOPIC mode.
HelpService	setTopic(Text topic) Activates the HELP-TOPIC mode.
HelpService	setWindowName(java.lang.String windowName) Configures the name of the to be created as child of a certain windows.
HelpService	setWindowName(Text windowName) Configures the name of the to be created as child of a certain windows.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final CentralLogger LOG

Logger

action

private SystemHelpAction action

The help system primitive to be executed.

specificParams

private java.lang.Object[] specificParams

The list of specific parameters to current action (optional).

helpFile

private java.lang.String helpFile

Specifies the pathname of a help file. On ABL:

• if the file has a .chm extension (the extension for compiled Microsoft HTML Help files), the Microsoft HTML Help viewer is launched;
• if the file has a .hlp file extension, the Microsoft Windows Help viewer is launched.

TODO: We will decide in #1827 how this will be implemented in FWD.

windowName

private java.lang.String windowName

The window-name parameter represents the primary or secondary window name as defined in the [WINDOWS] section of the help project file. If the window name is omitted, or if "main" is specified, the primary help window is used.

contents

private boolean contents

The flag for CONTENTS option.

context

private int context

Flag that CONTEXT mode was configured. In this mode, the statements displays the help topic that the context number identifies. The context numbers are defined in the [MAP] section of the help project file. The int-expr parameter is the context number for the help topic.

topic

private java.lang.String topic

The HELP-TOPIC option active if this is not null. The value that indicates the topic (.htm/.html file) within the compiled Microsoft HTML Help (.chm) file to display.

key

private java.lang.String key

The keyword for the desired help topic.

altKey

private java.lang.String altKey

The alternative keyword for the desired help topic.

command

private java.lang.String command

The help macro to execute.

partialKey

private java.lang.String partialKey

The partial key for the desired help topic in a PARTIAL-KEY statement.

tableId

private java.lang.String tableId

The single character keyword table identifier for the required table in a MULTIPLE-KEY help statement.

multipleKey

private java.lang.String multipleKey

The keyword that is located in the keyword table in a MULTIPLE-KEY help statement.

quit

private boolean quit

Flags the help application that help is no longer required.

finder

private boolean finder

Flags the FINDER option is activated

forceFile

private boolean forceFile

Flags the FORCE-FILE option is activated

help

private boolean help

Flags the HELP option is activated

contextPopup

private int contextPopup

The context number for the help topic in a CONTEXT-POPUP help statement.

contentTopic

private int contentTopic

The context number for the new contents help topic in a SET-CONTENTS help stmt.

maximized

private boolean maximized

Flag to maximize an existing (already opened) help window.

x

private int x

The X coordinate for the help window.

y

private int y

The Y coordinate for the help window.

width

private int width

The WIDTH of the help window.

height

private int height

The HEIGHT of the help window.

Constructor Detail

HelpService

private HelpService()

Private constructor. Use the prepare(java.lang.String) factory method to create an object.

Method Detail

prepare

public static HelpService prepare(java.lang.String helpFile)

Prepares a new configuration based on helpFile.

Parameters:

helpFile - The pathname of a help file

Returns:

The reference to a new HelpService. Used for chaining.

prepare

public static HelpService prepare(Text helpFile)

Prepares a new configuration based on helpFile.

Parameters:

helpFile - The pathname of a help file

Returns:

The reference to a new HelpService. Used for chaining.

getSystemHelpServicePath

public static java.lang.String getSystemHelpServicePath()

Get the system help service path relative to the service host for accessing the system help resources from the browser.

Returns:

The system help service path relative to the service host.

execute

public void execute()

The chain-terminator method. Evaluates all the options and issues commands to client to show on help window.

setWindowName

public HelpService setWindowName(Text windowName)

Configures the name of the to be created as child of a certain windows.

Parameters:

windowName - The help window name.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

windowName

setWindowName

public HelpService setWindowName(java.lang.String windowName)

Configures the name of the to be created as child of a certain windows.

Parameters:

windowName - The help window name.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

windowName

contents

public HelpService contents()

Activates the CONTENTS mode.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

contents

setTopic

public HelpService setTopic(java.lang.String topic)

Activates the HELP-TOPIC mode.

Parameters:

topic - The help window name.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

topic

setTopic

public HelpService setTopic(Text topic)

Activates the HELP-TOPIC mode.

Parameters:

topic - The help window name.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

topic

setContext

public HelpService setContext(long context)

Activates the CONTEXT mode.

Parameters:

context - The context number for the help topic. Displays the help topic that the context number identifies. You define context numbers in the [MAP] section of the help project file.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

context

setContext

public HelpService setContext(NumberType context)

Activates the CONTEXT mode.

Parameters:

context - The context number for the help topic. Displays the help topic that the context number identifies. You define context numbers in the [MAP] section of the help project file.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

context

setKey

public HelpService setKey(java.lang.String key)

Activates the KEY mode.

For HTML Help, this option displays the topic matching the string found in the keyword index. Use semicolons in the string parameter to delimit multiple keywords. If no match is found, Microsoft HTML Help displays the help viewer with the Index tab on top.

For Windows Help, this option displays the help topic matching the string found in the index keyword list. If there is more than one match, it displays the first topic containing the keyword. If there is no match or the string is omitted, a message is displayed indicating that the keyword is invalid.

Parameters:

key - The keyword for the desired help topic.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

key

setKey

public HelpService setKey(Text key)

Activates the KEY mode.

For HTML Help, this option displays the topic matching the string found in the keyword index. Use semicolons in the string parameter to delimit multiple keywords. If no match is found, Microsoft HTML Help displays the help viewer with the Index tab on top.

For Windows Help, this option displays the help topic matching the string found in the index keyword list. If there is more than one match, it displays the first topic containing the keyword. If there is no match or the string is omitted, a message is displayed indicating that the keyword is invalid.

Parameters:

key - The keyword for the desired help topic.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

key

setAlternateKey

public HelpService setAlternateKey(java.lang.String altKey)

Activates the ALTERNATE-KEY mode. Displays a help topic matching the string found in the alternate keyword (Alink) index.

Parameters:

altKey - The keyword in the alternate keyword index.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

altKey

setAlternateKey

public HelpService setAlternateKey(Text altKey)

Activates the ALTERNATE-KEY mode. Displays a help topic matching the string found in the alternate keyword (Alink) index.

Parameters:

altKey - The keyword in the alternate keyword index.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

altKey

setPartialKey

public HelpService setPartialKey(java.lang.String partialKey)

Activates the PARTIAL-KEY mode. Displays the help topic matching the string found in the keyword list. In Windows, if there is more than one match, no match, or if the string is omitted, it displays the Help Topics: Window Help Topics dialog box with the Index tab on top.

Parameters:

partialKey - The partial key for the desired help topic.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

partialKey

setPartialKey

public HelpService setPartialKey(Text partialKey)

Activates the PARTIAL-KEY mode. Displays the help topic matching the string found in the keyword list. In Windows, if there is more than one match, no match, or if the string is omitted, it displays the Help Topics: Window Help Topics dialog box with the Index tab on top.

Parameters:

partialKey - The partial key for the desired help topic.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

partialKey

setMultipleKey

public HelpService setMultipleKey(java.lang.String tableId,
                                  java.lang.String multipleKey)

Activates the MULTIPLE-KEY mode. Displays the help topic matching a keyword from an alternate keyword table.

Parameters:

tableId - The single character keyword table identifier for the required table.

multipleKey - The keyword that is located in the keyword table.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

tableId, multipleKey

setMultipleKey

public HelpService setMultipleKey(Text tableId,
                                  java.lang.String multipleKey)

Activates the MULTIPLE-KEY mode. Displays the help topic matching a keyword from an alternate keyword table.

Parameters:

tableId - The single character keyword table identifier for the required table.

multipleKey - The keyword that is located in the keyword table.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

tableId, multipleKey

setMultipleKey

public HelpService setMultipleKey(java.lang.String tableId,
                                  Text multipleKey)

Activates the MULTIPLE-KEY mode. Displays the help topic matching a keyword from an alternate keyword table.

Parameters:

tableId - The single character keyword table identifier for the required table.

multipleKey - The keyword that is located in the keyword table.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

tableId, multipleKey

setMultipleKey

public HelpService setMultipleKey(Text tableId,
                                  Text multipleKey)

Activates the MULTIPLE-KEY mode. Displays the help topic matching a keyword from an alternate keyword table.

Parameters:

tableId - The single character keyword table identifier for the required table.

multipleKey - The keyword that is located in the keyword table.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

tableId, multipleKey

setCommand

public HelpService setCommand(java.lang.String command)

Activates the COMMAND mode. Executes a help macro

Parameters:

command - The command to be executed.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

command

setCommand

public HelpService setCommand(Text command)

Activates the COMMAND mode. Executes a help macro

Parameters:

command - The command to be executed.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

command

quit

public HelpService quit()

Activates the QUIT mode. Informs the help application that help is no longer required. The system closes the help window.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

quit

finder

public HelpService finder()

Activates the FINDER mode. Displays the Help Topics: Windows Help Topics dialog box, which contains an Index tab, a Find tab, and optionally a Contents tab, with the most recently used tab displayed on top. If a Contents tab file (.CNT file) is present when the user initially call the Help Topics: Windows Help dialog box, then the Content tab displays on top. However, if a .CNT file is not present, then the dialog box displays with the Index tab on top; the Contents tab is not available.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

finder

forceFile

public HelpService forceFile()

Activates the FORCE-FILE mode: Ensures that the correct help file is open and displayed.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

forceFile

help

public HelpService help()

Activates the HELP mode. In this mode, teh statement displays the contents of the Help-on-Help file. In Windows, HELP displays the Help Topics: Windows Help Topics dialog box.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

help

setContextPopup

public HelpService setContextPopup(NumberType contextPopup)

Activates the CONTEXT-POPUP mode. In this mode, when executed, it displays the help topic in a pop-up window that the context number identifies. The context numbers are defined in the [MAP] section of the help project file. If a non-scrolling region exists in a help topic, only that region displays when you use the CONTEXT-POPUP option to display the topic.

Parameters:

contextPopup - The context number for the help topic.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

contextPopup

setContextPopup

public HelpService setContextPopup(long contextPopup)

Activates the CONTEXT-POPUP mode. In this mode, when executed, it displays the help topic in a pop-up window that the context number identifies. The context numbers are defined in the [MAP] section of the help project file. If a non-scrolling region exists in a help topic, only that region displays when you use the CONTEXT-POPUP option to display the topic.

Parameters:

contextPopup - The context number for the help topic.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

contextPopup

maximized

public HelpService maximized()

Activates the POSITION MAXIMIZE mode, when executed, it maximizes an existing (already opened) help window.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

maximized

setContents

public HelpService setContents(long contents)

Activates the SET-CONTENTS mode.

Dynamically re-maps the contents help topic from what is defined in the [OPTIONS] section of the help project file. When a CONTENTS call is made, the new contents help topic is displayed.

Parameters:

contents - The help window name.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

contentTopic

setContents

public HelpService setContents(NumberType contents)

Activates the SET-CONTENTS mode.

Dynamically re-maps the contents help topic from what is defined in the [OPTIONS] section of the help project file. When a CONTENTS call is made, the new contents help topic is displayed.

Parameters:

contents - The help window name.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

contentTopic

setPosition

public HelpService setPosition(NumberType x,
                               NumberType y,
                               NumberType width,
                               NumberType height)

Sets the new POSITION and geometry to help window.

Parameters:

x - The new X coordinate.

y - The new Y coordinate.

width - The new width of the window.

height - The new height of the window.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

x, y, height, width

setPosition

public HelpService setPosition(long x,
                               long y,
                               long width,
                               long height)

Sets the new POSITION and geometry to help window.

Parameters:

x - The new X coordinate.

y - The new Y coordinate.

width - The new width of the window.

height - The new height of the window.

Returns:

The reference to current HelpService. Used for chaining.

See Also:

x, y, height, width

setAction

private void setAction(SystemHelpAction a)

Validates and sets the current action to be executed.

Parameters:

a - The action to be executed.