de.bsvrz.sys.startstopp.buv
Class CmdMenu

java.lang.Object
  extended by de.bsvrz.sys.startstopp.buv.CmdMenu

public class CmdMenu
extends java.lang.Object

Menü für den CmdInterpreter

Version:
$Revision: 1.7 $ / $Date: 2011/11/04 09:02:21 $ / ($Author: Drapp $)
Author:
beck et al. projects GmbH, Thomas Müller

Constructor Summary
CmdMenu(java.lang.String desc, java.lang.String help)
          Menü mit Beschreibung und Hilfetext
CmdMenu(java.lang.String desc, java.lang.String help, java.lang.String inkarnationsName)
          Menü mit Beschreibung, Hilfetext und Ausgabetext
 
Method Summary
 void addCmd(Command cmd)
          Ein Kommando hinzufügen.
 void addNode(CmdMenu childMenu)
          Unter-Menü hinzufügen
 void clearNode()
           
 CmdMenu getChildNode(int i)
          Ein bestimmtes Untermenü auslesen
 java.util.Vector<Command> getCommands()
          Alle Kommandos auslesen
 java.lang.String getDesc()
          Die Beschreibung auslesen
 java.lang.String getHelp()
          Hilfe für das Menü ermitteln
 int getIndex()
          Index des Menüs auslesen
 java.lang.String getInkarnationsName()
          Den Inkarnationsnamen auslesen
 Command getLeaf(int i)
          Ein bestimmtes Kommando
 int getNumHiddenCommands()
          Liefert die Anzahl der zusätzlichen Kommandos.
 CmdMenu getParent()
          Eltern-Menü dieses Menüs lesen
 java.util.Vector<CmdMenu> getSubMenues()
          Alle Untermenüs auslesen
 void removeNode(CmdMenu childMenu)
          Unter-Menü löschen
 void setDesc(java.lang.String desc)
          Eine Beschreibung setzen
 void setHelp(java.lang.String help)
          Einen Hilfetext für das Menü setzen
 void setIndex()
          Index des Menüs setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen), ist eindeutig
 void setParent(CmdMenu parent)
          Eltern-Menü dieses Menüs setzen
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmdMenu

public CmdMenu(java.lang.String desc,
               java.lang.String help)
Menü mit Beschreibung und Hilfetext

Parameters:
desc - Beschreibung
help - Hilfetext

CmdMenu

public CmdMenu(java.lang.String desc,
               java.lang.String help,
               java.lang.String inkarnationsName)
Menü mit Beschreibung, Hilfetext und Ausgabetext

Parameters:
desc - Beschreibung
help - Hilfetext
inkarnationsName - Name der Inkarnation
Method Detail

setParent

public void setParent(CmdMenu parent)
Eltern-Menü dieses Menüs setzen

Parameters:
parent - das Eltern-Menü

getParent

public CmdMenu getParent()
Eltern-Menü dieses Menüs lesen

Returns:
Eltern-Menü

setIndex

public void setIndex()
Index des Menüs setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen), ist eindeutig


getIndex

public int getIndex()
Index des Menüs auslesen

Returns:
Index (immer eindeutig auf einer Menühierarchie-Ebene)

addNode

public void addNode(CmdMenu childMenu)
Unter-Menü hinzufügen

Parameters:
childMenu - menü

removeNode

public void removeNode(CmdMenu childMenu)
Unter-Menü löschen

Parameters:
childMenu - menü

clearNode

public void clearNode()

getSubMenues

public java.util.Vector<CmdMenu> getSubMenues()
Alle Untermenüs auslesen

Returns:
Vektor mit Untermenüs

getChildNode

public CmdMenu getChildNode(int i)
Ein bestimmtes Untermenü auslesen

Parameters:
i - Index des Untermenüs
Returns:
das Untermenü

addCmd

public void addCmd(Command cmd)
Ein Kommando hinzufügen. Fügt das Kommando vor etwaigen versteckten Kommandos ein.

Parameters:
cmd - das Kommando
See Also:
HiddenCommand

getCommands

public java.util.Vector<Command> getCommands()
Alle Kommandos auslesen

Returns:
die Kommandos als Vektor

getLeaf

public Command getLeaf(int i)
Ein bestimmtes Kommando

Parameters:
i - der Index des Kommandos
Returns:
das Kommando

setHelp

public void setHelp(java.lang.String help)
Einen Hilfetext für das Menü setzen

Parameters:
help - der Hilfetext

getHelp

public java.lang.String getHelp()
Hilfe für das Menü ermitteln

Returns:
der Hilfetext

setDesc

public void setDesc(java.lang.String desc)
Eine Beschreibung setzen

Parameters:
desc - die Beschreibung

getDesc

public java.lang.String getDesc()
Die Beschreibung auslesen

Returns:
Beschreibung

getInkarnationsName

public java.lang.String getInkarnationsName()
Den Inkarnationsnamen auslesen

Returns:
Inkarnationsname

getNumHiddenCommands

public int getNumHiddenCommands()
Liefert die Anzahl der zusätzlichen Kommandos.

Returns:
Liefert die Anzahl der zusätzlichen Kommandos.