Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

YadaPlainDocument Class Reference
[YadaDocuments - embedded objects]

Inheritance diagram for YadaPlainDocument:

Inheritance graph
[legend]
Collaboration diagram for YadaPlainDocument:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaPlainDocument - abstract yada document.

Author:
Michael Daum
Id
YadaPlainDocument.tcl,v 1.11 2004/05/11 14:30:47 ddreyer Exp

Definition at line 19 of file YadaPlainDocument.tcl.

Public Member Functions

virtual activationHandle ()
virtual deActivationHandle ()
 displayTitle ()
 fromDOM (domNode node)
 getPersistanceFileName ()
 hasSavedState ()
virtual init ()
 isModified ()
 lastChanged ()
 load ()
 resetModified ()
 save ()
 setModified ()
 setToggle (TclString name, TclRef value="")
 toDOM ()

Public Attributes

TclString hasView = "true"
TclString name = ""

Protected Member Functions

 updateModificationTime ()
 YadaPlainDocument ()

Protected Attributes

TclNumber _isInitialized = 0
TclNumber _lastModificationTime = 0
TclNumber _modified = 0


Constructor & Destructor Documentation

YadaPlainDocument::YadaPlainDocument  )  [protected]
 

constructor

Definition at line 76 of file YadaPlainDocument.tcl.

References activationHandle().


Member Function Documentation

YadaPlainDocument::activationHandle  )  [virtual]
 

activationHandle

Reimplemented in YadaMethods, YadaOneOnOne, YadaConfig, YadaConfigDocument, YadaDifference, YadaDocument, YadaExperiments, YadaGenerals, YadaGlsStats, YadaRanking, and YadaRunner.

Definition at line 83 of file YadaPlainDocument.tcl.

References deActivationHandle().

Referenced by YadaPlainDocument().

YadaPlainDocument::deActivationHandle  )  [virtual]
 

deActivationHandle

Reimplemented in YadaConfig.

Definition at line 91 of file YadaPlainDocument.tcl.

References init().

Referenced by activationHandle().

YadaPlainDocument::displayTitle  ) 
 

Displays title in main window (reflecting modification state of document).

Reimplemented in YadaConfigDocument, YadaGenerals, YadaRanking, and YadaRunner.

Definition at line 207 of file YadaPlainDocument.tcl.

YadaPlainDocument::hasSavedState  ) 
 

Predicate returning 1, if file containing persistant state of YadaGrammar exists, otherwise 0 Definition at line 192 of file YadaPlainDocument.tcl.

Referenced by resetModified().

YadaPlainDocument::init  )  [virtual]
 

init

Reimplemented in YadaMethods, YadaConfig, YadaConfigDocument, YadaExperiments, YadaGenerals, YadaGrammars, YadaMachines, YadaRanking, and YadaRunnableDocument.

Definition at line 97 of file YadaPlainDocument.tcl.

Referenced by deActivationHandle().

YadaPlainDocument::isModified  ) 
 

Predicate returning 1, if configuration data has changed, 0 otherwise.

Definition at line 168 of file YadaPlainDocument.tcl.

References setModified().

YadaPlainDocument::lastChanged  ) 
 

Returns time of last update to document XML file or an empty string, if there is no such file Definition at line 219 of file YadaPlainDocument.tcl.

YadaPlainDocument::load  ) 
 

Loads current document from file (file name depends on document name).

reset in case there is some value left from last load operation;

Modified state may be changed by overridden fromDOM methods

Reimplemented in YadaConfig, YadaExperiments, YadaGrammars, YadaMachines, and YadaRunner.

Definition at line 113 of file YadaPlainDocument.tcl.

Referenced by setToggle().

YadaPlainDocument::resetModified  ) 
 

Removes modification mark.

Definition at line 183 of file YadaPlainDocument.tcl.

References hasSavedState().

Referenced by setModified().

YadaPlainDocument::save  ) 
 

Saves current document to file (file name depends on document name).

Reimplemented in YadaConfig, YadaExperiments, YadaGrammars, YadaMachines, and YadaRunnableDocument.

Definition at line 140 of file YadaPlainDocument.tcl.

YadaPlainDocument::setModified  ) 
 

Marks item as modified.

Definition at line 175 of file YadaPlainDocument.tcl.

References resetModified().

Referenced by isModified().

YadaPlainDocument::setToggle TclString  name,
TclRef  value = ""
 

setToggle

Reimplemented in YadaDocument, and YadaRunnableDocument.

Definition at line 106 of file YadaPlainDocument.tcl.

References load().

YadaPlainDocument::updateModificationTime  )  [protected]
 

Synchronizes internal modification attribute with modification time of document's XML file Definition at line 234 of file YadaPlainDocument.tcl.


Member Data Documentation

TclNumber YadaPlainDocument::_isInitialized = 0 [protected]
 

flag indicating initialization. Possible falues are 0 and 1. init() sets this to 1 when it is called in the init chain calls of inheriting classes, i.e. YadaConfigDocument::init() or YadaRunnableDocument::init(). Definition at line 36 of file YadaPlainDocument.tcl.

TclNumber YadaPlainDocument::_lastModificationTime = 0 [protected]
 

Denotes time of most recent modification of document's XML file CAUSED by this object. This allows recognizing cases where a second object modifies the same file concurrently, in which case the need may arise to synchronize the object with the new file contents. Definition at line 44 of file YadaPlainDocument.tcl.

TclString YadaPlainDocument::hasView = "true"
 

flag indicating whether this object functions as combined model-view object (value "true"), or as a pure model object (value "false": has to be set explicitly when instantiating object) Definition at line 29 of file YadaPlainDocument.tcl.

TclString YadaPlainDocument::name = ""
 

name of the document

Definition at line 25 of file YadaPlainDocument.tcl.


The documentation for this class was generated from the following file:
YADA 2.0-alpha (20 Oct 2004)