org.vishia.libOffc.cfgui

Class WriteKeyAcclPrc

java.lang.Object

org.vishia.libOffc.cfgui.WriteKeyAcclPrc

public class WriteKeyAcclPrc
extends java.lang.Object

Operation class for a read XML file from LibreOffice Customize Keyboard Save to convert it in a human readable form.

This class is used in WriteKeyAccl.execute(), there only #exec(XmlDataLOffcKeyAccl, org.vishia.libOffc.cfgui.WriteKeyAccl.CmdArgs, LogMessage) is called with the already read XML data.

• This class organizes calling a translation from uno commands to a human readable text. This is done with the class ReadRegistryMain which reads XML files in the LibreOffice tool files called in #exec2(XmlDataLOffcKeyAccl).
• The key names in the XML file are translated, using an inner table idxKeyTranslateKeyNames filled in initKeyTranslate().
• Then it sorts the given data and builds the index of key acceleration idxKeyAccl.
• The index is written to a text file using #outKeys(). For that the OutTextPreparer capability ('gTxt') is used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteKeyAcclPrc.AcclKey Data class to store properties of one accelerator key.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) WriteKeyAccl.CmdArgs	cmdArgs Command arguments from WriteKeyAccl main class.
org.vishia.util.OutTextPreparer	gTxtKeyOutput The gTxt script which is used for output.
static org.vishia.util.OutTextPreparer	gTxtKeyOutputDefault The gTxt script OutTextPreparer as default for the output file as constant (final static).
(package private) java.util.Map<java.lang.String,WriteKeyAcclPrc.AcclKey>	idxKeyAccl Result accelerator key association to command.
(package private) java.util.Map<java.lang.String,WriteKeyAcclPrc.AcclKey>	idxKeyAcclShift Result accelerator key association to command in the order shift following no shift key.
(package private) java.util.Map<java.lang.String,java.lang.String>	idxKeyTranslateKeyNames Internal translation between key names in the XML file and human readable names.
java.util.Map<java.lang.String,org.vishia.util.OutTextPreparer>	idxScript Index of all read scripts, here only one expected.
(package private) ReadRegistryMain	reg Instance to translate the uno and other commands to human readable text.

Constructor Summary

Constructors

Constructor and Description
WriteKeyAcclPrc(WriteKeyAccl.CmdArgs cmdArgs) Ctor.

Method Summary

Modifier and Type	Method and Description
int	exec(XmlDataLOffcKeyAccl data, java.io.File fIn, org.vishia.msgDispatch.LogMessage log) execution operation in the instantiated class, also called pure as is in #exec(XmlDataLOffcKeyAccl, org.vishia.libOffc.cfgui.WriteKeyAccl.CmdArgs, LogMessage).
void	init(org.vishia.msgDispatch.LogMessage log)
private void	initKeyTranslate() Fills the idxKeyTranslateKeyNames.
(package private) void	outKeys(java.io.File fIn, org.vishia.msgDispatch.LogMessage log) Outputs the accelerator key setting in textual human readable form from the stored idxKeyAccl or idxKeyAcclShift.

Methods inherited from class java.lang.Object

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

Field Detail

cmdArgs

final WriteKeyAccl.CmdArgs cmdArgs

Command arguments from WriteKeyAccl main class.

idxKeyAccl

final java.util.Map<java.lang.String,WriteKeyAcclPrc.AcclKey> idxKeyAccl

Result accelerator key association to command.

idxKeyAcclShift

final java.util.Map<java.lang.String,WriteKeyAcclPrc.AcclKey> idxKeyAcclShift

Result accelerator key association to command in the order shift following no shift key.

idxKeyTranslateKeyNames

final java.util.Map<java.lang.String,java.lang.String> idxKeyTranslateKeyNames

Internal translation between key names in the XML file and human readable names.

reg

ReadRegistryMain reg

Instance to translate the uno and other commands to human readable text.

gTxtKeyOutput

public final org.vishia.util.OutTextPreparer gTxtKeyOutput

The gTxt script which is used for output. It is read from file, see cmdArgs WriteKeyAccl.CmdArgs.file_gTxt If this file is not given or faulty, then gTxtKeyOutputDefault is used.

gTxtKeyOutputDefault

public static final org.vishia.util.OutTextPreparer gTxtKeyOutputDefault

The gTxt script OutTextPreparer as default for the output file as constant (final static). It is completely parsed in its ctor (on class loading).

idxScript

public final java.util.Map<java.lang.String,org.vishia.util.OutTextPreparer> idxScript

Index of all read scripts, here only one expected.

Constructor Detail

WriteKeyAcclPrc

public WriteKeyAcclPrc(WriteKeyAccl.CmdArgs cmdArgs)

Ctor.

• calls initKeyTranslate()
• prepares the gTxt script given with cmdArgs WriteKeyAccl.CmdArgs.file_gTxt If this file is not given or faulty, then gTxtKeyOutputDefault is used.

Parameters:

log -

cmdArgs -

Throws:

java.io.FileNotFoundException

Method Detail

initKeyTranslate

private void initKeyTranslate()

Fills the idxKeyTranslateKeyNames. Key names in XML to human readable key names. Its content is:

  private void initKeyTranslate () {
    this.idxKeyTranslate.put("KEY_BACKSPACE", "Bspc");
    this.idxKeyTranslate.put("KEY_DOWN", "Down");
    this.idxKeyTranslate.put("KEY_ESCAPE", "Esc");
    this.idxKeyTranslate.put("KEY_HOME", "Home");
    this.idxKeyTranslate.put("KEY_END", "End");
    this.idxKeyTranslate.put("KEY_INSERT", "Ins ");
    this.idxKeyTranslate.put("KEY_DELETE", "Del ");
    this.idxKeyTranslate.put("KEY_LEFT", "Left");
    this.idxKeyTranslate.put("KEY_PAGEDOWN", "PgDn");
    this.idxKeyTranslate.put("KEY_PAGEUP", "PgUp");
    this.idxKeyTranslate.put("KEY_RETURN", "ENTER");
    this.idxKeyTranslate.put("KEY_RIGHT", "Right");
    this.idxKeyTranslate.put("KEY_BRACKETLEFT", " [");
    this.idxKeyTranslate.put("KEY_BRACKETRIGHT", " ]");
    this.idxKeyTranslate.put("KEY_DIVIDE", " /");
    this.idxKeyTranslate.put("KEY_ADD", " +");
    this.idxKeyTranslate.put("KEY_SUBTRACT", " -");
    this.idxKeyTranslate.put("KEY_MULTIPLY", " *");
    this.idxKeyTranslate.put("KEY_NUMBERSIGN", " #");
    this.idxKeyTranslate.put("KEY_SPACE", "Space");
  }
 

init

public void init(org.vishia.msgDispatch.LogMessage log)

exec

public int exec(XmlDataLOffcKeyAccl data,
                java.io.File fIn,
                org.vishia.msgDispatch.LogMessage log)

execution operation in the instantiated class, also called pure as is in #exec(XmlDataLOffcKeyAccl, org.vishia.libOffc.cfgui.WriteKeyAccl.CmdArgs, LogMessage).

• reads the

Parameters:

data - Data from XML read.

Returns:

error number, 0.

outKeys

void outKeys(java.io.File fIn,
             org.vishia.msgDispatch.LogMessage log)
      throws java.io.IOException

Outputs the accelerator key setting in textual human readable form from the stored idxKeyAccl or idxKeyAcclShift. It uses the prepared gTxt script in gTxtKeyOutput which's content depends on the file given with cmdArgs WriteKeyAccl.CmdArgs.file_gTxt If this file is not given or faulty, then gTxtKeyOutputDefault is used.

Parameters:

fIn - The input file may be used with its path/name without extension. The name of the output file is determined by WriteKeyAccl.CmdArgs.fpOutText

log -

Throws:

java.io.IOException