cli

Class Help

java.lang.Object

cli.NativeObject

cli.ResourceString

cli.Help

public final class Help
extends ResourceString

Help class. Useful for all CLI element objects.

Field Summary

Fields inherited from class cli.ResourceString

LANG_COUNT, LANG_EN, LANG_FR

Constructor Summary

Constructors

Constructor and Description
Help() Default constructor.
Help(Help CLI_Help) Copy constructor.

Method Summary

Modifier and Type	Method and Description
Help	addHelp(int E_Lang, java.lang.String J_Help) Help addition for a given language.
protected static void	createFromNative(long I64_NativeHelpRef) Creation from native code.
java.lang.String	getHelp(int E_Lang) Retrieves help resource for the given language.
boolean	hasHelp(int E_Lang) States whether the help object has a help resource for the given language.

Methods inherited from class cli.ResourceString

getString, hasString, setString

Methods inherited from class cli.NativeObject

createdFromNative, dontFinalize, finalize, forget, getbDoFinalize, getNativeRef, getObject, remember

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help()

Default constructor.

Help

public Help(Help CLI_Help)

Copy constructor.

Parameters:

CLI_Help - Source object.

Method Detail

createFromNative

protected static void createFromNative(long I64_NativeHelpRef)

Creation from native code. Useful for help members of other classes.

Parameters:

I64_NativeHelpRef - Native instance reference.

addHelp

public final Help addHelp(int E_Lang,
                          java.lang.String J_Help)

Help addition for a given language.

Parameters:

E_Lang - Language identifier (LANG_EN, LANG_FR...)

J_Help - Help string.

Returns:

The help instance itself.

hasHelp

public final boolean hasHelp(int E_Lang)

States whether the help object has a help resource for the given language.

Parameters:

E_Lang - Language identifier (LANG_EN, LANG_FR...)

Returns:

true if the help object contains resource for the given language, false otherwise.

getHelp

public final java.lang.String getHelp(int E_Lang)

Retrieves help resource for the given language.

Parameters:

E_Lang - Language identifier (LANG_EN, LANG_FR...)

Returns:

Help resource.