Class Document

java.lang.Object
   |
   +----Document

class Document
extends Object

Variable Index

 o bookmarks
 o cons
Dialog: Constraints-Liste
 o constraints
 o decision_help
optionales Fenster zur Anzeige des Help-Attributs von Knoten und Kanten
 o host_dialog
Antwort-Fenster fuer
 o injured_cons
Dialog: verletzte Constraints
 o injured_constraints
 o match_fail
internes Hilfsflag
 o modified
ein Editiervorgang setzt diese Variable auf true
 o props
Node+Edge=Objekt-Eigenschaften-Dialog (modeless, siehe class PropertiesDialog)
 o root
 o selection
optionales Fenster zur Anzeige des Aktivierungszustandes in Textform
 o selection_modified
Im Access-Mode 0 (Endanwender) wurde ein Blatt-Text veraendert oder die Auswahl bei einem Oder-Knoten geaendert.
 o source
Baum in Textform (wird allerdings nicht automatisch aktualisiert)
 o undo_root
Sicherheitskopie vom Baum vor diversen destruktiven Operationen
 o view

Constructor Index

 o Document(String)

Method Index

 o activate_bookmark(String)
 o activate_selection(String, boolean, boolean)
 o add_bookmark()
Speichert die aktivierte Selektion (oder, falls offen) den Inhalt vom Selection text view als Bookmark (Aufbewahrung: .cat-Datei)
 o add_bookmarks(ApplicationFrame)
 o clear()
Entfernt alle Kinder der Wurzel.
 o closeable()
Muss das Dokument gesichert werden?
 o collapse()
 o collapse_all()
 o commentary()
erlaubt dem Endanwender, das help-Attribut eines Knotens zu editieren ("Kommentar")
 o complete_selection()
schickt ein Selektionsmuster zum Hostrechner zwecks Vervollstaendigung
 o constraints()
Dialog zur Constraints-Verwaltung oeffnen
 o current_URL(String)
 o delete()
Loeschen eines Knotens
 o delete_selection()
Loescht eine Selektion auf dem Host bzw.
 o display()
root zeichnen, ohne Hintergrund zu loeschen oder Neuralgics neu zu berechnen
 o display_decision_help(String)
Kontext-Hilfe zum Knoten unter dem Mauszeiger anzeigen (wie Statuszeile im View, nur mehrzeilig)
 o display_decision_help(String, String)
Kontext-Hilfe zum markierten Knoten
 o display_different()
 o display_different(boolean)
volles Update (root zeichnen und Neuralgics berechnen)
 o display_selection(boolean)
 o display_selection(String, int)
selection text view oeffnen
 o display_source()
 o display_source(boolean)
Baum-Quelltext in Fenster anzeigen (categories text view)
 o edit_leaf_text()
Blatt-Inhalt zur Bearbeitung oeffnen (Plain oder HTML)
 o expand()
 o expand_all()
 o find()
markiert den Knoten, der anhand von Kantenidentifikator, oder -label gefunden wurde
 o get_incomplete_selection(boolean)
 o has_been_modified()
 o injured_constraints()
Dialog mit Liste aller z.Zt.
 o load_selection(String, boolean, boolean)
Laden und Aktivieren einer in einer .sel-Datei gespeicherten Selektion reset: vor der Aktivierung der neuen Selektion minimalen Aktivierungszustand herstellen
 o marked_node()
markierter Knoten bzw.
 o move(Document, boolean)
Vertauschen eines Knotens mit seinem Nachbarn
 o name()
 o new_alternative()
fuegt zu einem Knoten mit Id.
 o new_as_first()
fuegt zum markierten Knoten einen neuen Knoten als erstes "Kind" hinzu
 o new_before()
fuegt zum markierten Knoten einen neuen Knoten als Geschwister hinzu
 o new_behind()
fuegt zum markierten Knoten als Geschwister zum markierten Knoten hinzu
 o new_branch(boolean, Node)
Parameter vgl.
 o new_branch(boolean, Node, boolean)
Parameter vgl.
 o open(String, boolean)
Oeffnen und Parsen eines Dokumentes (als .cat-Datei mit der textuellen Repraesentation des AND/OR-Trees root).
 o open_empty(String)
Erzeugt ein neues Dokument name, das nur den Wurzelknoten enthaelt
 o parse(String)
Quelle eines Baums in Node-Datenstruktur uebersetzen Dateiname filename hier nur kommentierend, vgl.
 o paste(Document)
 o paste(Document, boolean, Node)
fuegt eine Kopie vom markierten Knoten in source hinzu.
 o paste_as_first(Document)
fuegt eine Kopie vom markierten Knoten in source als Kind zum markierten Knoten hinzu
 o paste_before(Document)
fuegt eine Kopie vom markierten Knoten in source als Geschwister zum markierten Knoten hinzu
 o paste_behind(Document)
fuegt eine Kopie vom markierten Knoten in source als Geschwister zum markierten Knoten hinzu
 o pop_includes(Stack, int)
Speichert die in derselben Verschachtelungstiefe liegenden Include-Dateien
 o prepare_undo()
Sicherheitskopie vom Baum anlegen
 o print()
 o properties()
Eigenschaften einer Kante bzw.
 o read_tree(String)
Baum-Quelltext aus Datei lesen
 o refresh_properties()
Eigenschaften-Dialog aktualisieren
 o refresh_selection_text()
zur automatischen Aktualisierung des selection text view
 o replace(Document)
 o replace(Document, Node, Node, boolean)
Knoten target durch node (in Dokument source) ersetzen.
 o reset_activation()
Minimalen Aktivierungszustand herstellen
 o reset_attributes()
setzt Dokumenten-Attribute zurueck
 o save()
Speichern einer .cat-Datei mit der textuellen Repraesentation des AND/OR-Trees root
 o save(String)
 o save_flat()
aehnlich save(), aber unter Aufloesung aller Include-"Knoten" (wird z.T.
 o save_selection(String)
 o selection_has_been_modified()
 o send_selection()
schickt eine vollstaendige Selektion + Kommentare zum Hostrechner
 o set_application_name()
Namen des Wurzelknotens als Frame-name festlegen
 o set_modified(boolean)
 o set_name(String)
 o set_selection_modified(boolean)
 o sort()
Kinder des markierten Knotens alphabetisch aufsteigend sortieren
 o toggle_activated_only()
Versteckt/zeigt inaktivierte Baumteile
 o toggle_activation()
 o undo()
 o warn_about_empty_or_node(boolean)
button=true: Ok-Button anzeigen, andernfalls nicht.

Variables

 o root
 Node root
 o view
 View view
 o source
 AOTreeString source
Baum in Textform (wird allerdings nicht automatisch aktualisiert)

 o constraints
 Constraint constraints[]
 o injured_constraints
 Constraint injured_constraints[]
 o bookmarks
 Bookmark bookmarks[]
 o selection
 SelectionTextDialog selection
optionales Fenster zur Anzeige des Aktivierungszustandes in Textform

 o props
 PropertiesDialog props
Node+Edge=Objekt-Eigenschaften-Dialog (modeless, siehe class PropertiesDialog)

 o cons
 ConstraintsDialog cons
Dialog: Constraints-Liste

 o injured_cons
 InjuredConstraintsDialog injured_cons
Dialog: verletzte Constraints

 o decision_help
 DecisionHelpDialog decision_help
optionales Fenster zur Anzeige des Help-Attributs von Knoten und Kanten

 o host_dialog
 HostDialog host_dialog
Antwort-Fenster fuer

 o modified
 private boolean modified
ein Editiervorgang setzt diese Variable auf true

 o selection_modified
 private boolean selection_modified
Im Access-Mode 0 (Endanwender) wurde ein Blatt-Text veraendert oder die Auswahl bei einem Oder-Knoten geaendert.

 o undo_root
 private Node undo_root
Sicherheitskopie vom Baum vor diversen destruktiven Operationen

 o match_fail
 boolean match_fail
internes Hilfsflag

Constructors

 o Document
 Document(String filename)

Methods

 o closeable
 boolean closeable()
Muss das Dokument gesichert werden?

 o name
 String name()
 o set_application_name
 void set_application_name()
Namen des Wurzelknotens als Frame-name festlegen

 o set_name
 void set_name(String name)
 o display
 synchronized void display()
root zeichnen, ohne Hintergrund zu loeschen oder Neuralgics neu zu berechnen

 o display_different
 synchronized void display_different()
 o display_different
 synchronized void display_different(boolean keep_selection)
volles Update (root zeichnen und Neuralgics berechnen)

 o marked_node
 Node marked_node()
markierter Knoten bzw. dessen zulaufende Kante

 o paste
 void paste(Document source)
 o paste_as_first
 void paste_as_first(Document source)
fuegt eine Kopie vom markierten Knoten in source als Kind zum markierten Knoten hinzu

 o paste_before
 void paste_before(Document source)
fuegt eine Kopie vom markierten Knoten in source als Geschwister zum markierten Knoten hinzu

 o paste_behind
 void paste_behind(Document source)
fuegt eine Kopie vom markierten Knoten in source als Geschwister zum markierten Knoten hinzu

 o new_as_first
 void new_as_first()
fuegt zum markierten Knoten einen neuen Knoten als erstes "Kind" hinzu

 o new_alternative
 void new_alternative()
fuegt zu einem Knoten mit Id. "other" ein "Kind" hinzu (im Endanwender-Modus!). Hoechst problematischer Befehl, sollte man ueberdenken!!!

 o commentary
 void commentary()
erlaubt dem Endanwender, das help-Attribut eines Knotens zu editieren ("Kommentar")

 o new_before
 void new_before()
fuegt zum markierten Knoten einen neuen Knoten als Geschwister hinzu

 o new_behind
 void new_behind()
fuegt zum markierten Knoten als Geschwister zum markierten Knoten hinzu

 o move
 void move(Document source,
           boolean direction)
Vertauschen eines Knotens mit seinem Nachbarn

 o delete
 void delete()
Loeschen eines Knotens

 o clear
 void clear()
Entfernt alle Kinder der Wurzel. Es handelt sich aber um eine Modifikation ,nicht um die Erzeugung eines neuen Dokuments!

 o replace
 Node replace(Document source)
 o replace
 Node replace(Document source,
              Node node,
              Node target,
              boolean copy)
Knoten target durch node (in Dokument source) ersetzen. (fkt. auch auf Wurzel) copy=false: Quellknoten muss nicht kopiert werden node=null:markierten Knoten in source verwenden target=null:markierten Knoten in this verwenden Resultat: der Ersatz-Knoten

 o paste
 void paste(Document source,
            boolean as_first,
            Node pivot)
fuegt eine Kopie vom markierten Knoten in source hinzu. pivot==null: as_first==true: als ersten Sohn des markierten Knotens einfuegen sonst: als letzten Sohn des markierten Knotens einfuegen sonst: as_first==true: als Schwester vor dem Knoten pivot einfuegen sonst: als Schwester nach dem Knoten pivot einfuegen

 o new_branch
 void new_branch(boolean as_first,
                 Node pivot)
Parameter vgl. paste()

 o new_branch
 void new_branch(boolean as_first,
                 Node pivot,
                 boolean quiet)
Parameter vgl. paste()

 o properties
 void properties()
Eigenschaften einer Kante bzw. des nachfolgenden Knotens node aendern

 o refresh_properties
 void refresh_properties()
Eigenschaften-Dialog aktualisieren

 o prepare_undo
 void prepare_undo()
Sicherheitskopie vom Baum anlegen

 o undo
 void undo()
 o print
 void print()
 o collapse
 void collapse()
 o expand
 void expand()
 o collapse_all
 void collapse_all()
 o expand_all
 void expand_all()
 o toggle_activated_only
 boolean toggle_activated_only()
Versteckt/zeigt inaktivierte Baumteile

 o parse
 void parse(String filename)
Quelle eines Baums in Node-Datenstruktur uebersetzen Dateiname filename hier nur kommentierend, vgl. open()

 o open
 void open(String filename,
           boolean add_to_history)
Oeffnen und Parsen eines Dokumentes (als .cat-Datei mit der textuellen Repraesentation des AND/OR-Trees root). Die tatsaechliche visuelle Darstellung des zugehoerigen Views findet hier aber nicht statt, sondern bei der Integration in die HTML-Seite bzw. ApplicationFrame. open() darf nur vom Konstruktor aufgerufen werden. open() sollte nur indirekt ueber AOT.open() aufgerufen werden.

 o current_URL
 boolean current_URL(String filename)
 o open_empty
 void open_empty(String name)
Erzeugt ein neues Dokument name, das nur den Wurzelknoten enthaelt

 o reset_attributes
 void reset_attributes()
setzt Dokumenten-Attribute zurueck

 o read_tree
 static String read_tree(String filename)
Baum-Quelltext aus Datei lesen

 o save_flat
 void save_flat()
aehnlich save(), aber unter Aufloesung aller Include-"Knoten" (wird z.T. nur zum Sichern des Clipboards (clipboard.cat) verwendet)

 o save
 void save(String filename)
 o save
 void save()
Speichern einer .cat-Datei mit der textuellen Repraesentation des AND/OR-Trees root

 o set_modified
 void set_modified(boolean state)
 o set_selection_modified
 void set_selection_modified(boolean state)
 o has_been_modified
 boolean has_been_modified()
 o selection_has_been_modified
 boolean selection_has_been_modified()
 o pop_includes
 void pop_includes(Stack includes,
                   int n)
Speichert die in derselben Verschachtelungstiefe liegenden Include-Dateien

 o warn_about_empty_or_node
 void warn_about_empty_or_node(boolean button)
button=true: Ok-Button anzeigen, andernfalls nicht. Dies ist sinnvoll in AOT.on_quit(), da das Button-Event dort nicht abgefangen werden kann

 o display_source
 void display_source()
 o display_source
 void display_source(boolean expand_includes)
Baum-Quelltext in Fenster anzeigen (categories text view)

 o activate_selection
 boolean activate_selection(String selection,
                            boolean reset,
                            boolean draw)
 o load_selection
 public void load_selection(String filename,
                            boolean reset,
                            boolean draw)
Laden und Aktivieren einer in einer .sel-Datei gespeicherten Selektion reset: vor der Aktivierung der neuen Selektion minimalen Aktivierungszustand herstellen

 o save_selection
 void save_selection(String filename)
 o send_selection
 void send_selection()
schickt eine vollstaendige Selektion + Kommentare zum Hostrechner

 o delete_selection
 void delete_selection()
Loescht eine Selektion auf dem Host bzw. in dessen Datenbank

 o complete_selection
 void complete_selection()
schickt ein Selektionsmuster zum Hostrechner zwecks Vervollstaendigung

 o display_selection
 void display_selection(boolean labels)
 o display_selection
 void display_selection(String sel,
                        int cursor_pos)
selection text view oeffnen

 o refresh_selection_text
 void refresh_selection_text()
zur automatischen Aktualisierung des selection text view

 o get_incomplete_selection
 String get_incomplete_selection(boolean add_point)
 o reset_activation
 void reset_activation()
Minimalen Aktivierungszustand herstellen

 o constraints
 void constraints()
Dialog zur Constraints-Verwaltung oeffnen

 o injured_constraints
 void injured_constraints()
Dialog mit Liste aller z.Zt. verletzten Constraints oeffnen

 o add_bookmark
 void add_bookmark()
Speichert die aktivierte Selektion (oder, falls offen) den Inhalt vom Selection text view als Bookmark (Aufbewahrung: .cat-Datei)

 o add_bookmarks
 void add_bookmarks(ApplicationFrame application)
 o activate_bookmark
 void activate_bookmark(String name)
 o edit_leaf_text
 void edit_leaf_text()
Blatt-Inhalt zur Bearbeitung oeffnen (Plain oder HTML)

 o toggle_activation
 void toggle_activation()
 o display_decision_help
 void display_decision_help(String help)
Kontext-Hilfe zum Knoten unter dem Mauszeiger anzeigen (wie Statuszeile im View, nur mehrzeilig)

 o display_decision_help
 void display_decision_help(String edge_help,
                            String node_help)
Kontext-Hilfe zum markierten Knoten

 o find
 void find()
markiert den Knoten, der anhand von Kantenidentifikator, oder -label gefunden wurde

 o sort
 void sort()
Kinder des markierten Knotens alphabetisch aufsteigend sortieren