XJDocument (ANTLRWorks 1.5.1 API)

java.lang.Object
- org.antlr.xjlib.foundation.XJObject
- - org.antlr.xjlib.appkit.document.XJDocument

Direct Known Subclasses:

GrammarDocument, STDocument
```
public class XJDocument
extends XJObject
```
A document always has data and a window to display the data.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`absoluteCounter`
`protected boolean`	`dirty`
`protected XJData`	`documentData`
`protected String`	`documentFileExtDescription`
`protected List`	`documentFileExts`
`protected String`	`documentPath`
`protected String`	`documentTitle`
`protected XJWindow`	`documentWindow`
`protected XJFileMonitor`	`fileMonitor`
`protected boolean`	`firstDocument`
`protected Component`	`javaContainer`
`protected boolean`	`writing`

Constructor Summary

Constructors
Constructor and Description

XJDocument()

Constructors
Constructor and Description
`XJDocument()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`autoSave()`
`void`	`awake()`
`void`	`changeDone()`
`void`	`changeReset()`
`boolean`	`close(boolean force)`
`void`	`documentDidReadData()`
`void`	`documentWillReadData()`
`void`	`documentWillWriteData()`
`long`	`getDateOfModificationOnDisk()`
`XJData`	`getDocumentData()`
`String`	`getDocumentFolder()`
`String`	`getDocumentName()`
`String`	`getDocumentNameWithoutExtension()`
`String`	`getDocumentPath()`
`Component`	`getSwingComponent()` Returns the original Swing container
`XJWindow`	`getWindow()`
`boolean`	`isDirty()`
`boolean`	`isFirstDocument()`
`boolean`	`isInternalOnly()` Returns true if the document is internal: if this is the case, it will not be added and handled by XJApplication.
`boolean`	`isModifiedOnDisk()`
`boolean`	`load(String file)`
`void`	`observeValueForKey(Object sender, String key, Object object)`
`boolean`	`reload()`
`boolean`	`save(boolean saveAs)`
`void`	`setDirty(boolean dirty)`
`void`	`setDocumentData(XJData data)`
`void`	`setDocumentFileType(List ext, String description)`
`void`	`setJavaContainer(Component container)`
`void`	`setTitle(String title)`
`void`	`setWindow(XJWindow window)`
`void`	`showWindow()`
`void`	`synchronizeLastModifiedDate()`

Methods inherited from class org.antlr.xjlib.foundation.XJObject
addObserver, addObserverForKey, bindObserverForKey, keyValueChanged, removeObserver, removeObserverForKey

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

documentData
```
protected XJData documentData
```

documentWindow
```
protected XJWindow documentWindow
```

documentTitle
```
protected String documentTitle
```

documentPath
```
protected String documentPath
```

documentFileExts
```
protected List documentFileExts
```

documentFileExtDescription

protected String documentFileExtDescription

dirty
```
protected boolean dirty
```

firstDocument
```
protected boolean firstDocument
```

writing
```
protected boolean writing
```

javaContainer
```
protected Component javaContainer
```

absoluteCounter
```
protected static int absoluteCounter
```

fileMonitor

protected final XJFileMonitor fileMonitor

Constructor Detail
- XJDocument
```
public XJDocument()
```

Method Detail

awake
```
public void awake()
```
Overrides:

awake in class XJObject

isInternalOnly
```
public boolean isInternalOnly()
```
Returns true if the document is internal: if this is the case, it will not be added and handled by XJApplication.

isFirstDocument
```
public boolean isFirstDocument()
```

setDirty
```
public void setDirty(boolean dirty)
```

isDirty
```
public boolean isDirty()
```

changeDone
```
public void changeDone()
```

changeReset
```
public void changeReset()
```

setTitle
```
public void setTitle(String title)
```

setWindow

public void setWindow(XJWindow window)

getWindow
```
public XJWindow getWindow()
```

setJavaContainer

public void setJavaContainer(Component container)

getSwingComponent
```
public Component getSwingComponent()
```
Returns the original Swing container

showWindow
```
public void showWindow()
```

setDocumentData

public void setDocumentData(XJData data)

getDocumentData
```
public XJData getDocumentData()
```

getDocumentPath
```
public String getDocumentPath()
```

getDocumentFolder
```
public String getDocumentFolder()
```

getDocumentName
```
public String getDocumentName()
```

getDocumentNameWithoutExtension

public String getDocumentNameWithoutExtension()

setDocumentFileType

public void setDocumentFileType(List ext,
                       String description)

observeValueForKey

public void observeValueForKey(Object sender,
                      String key,
                      Object object)

Overrides:: observeValueForKey in class XJObject

load

public boolean load(String file)
             throws Exception

Throws:: Exception

reload

public boolean reload()
               throws Exception

Throws:: Exception

autoSave
```
public boolean autoSave()
```

save
```
public boolean save(boolean saveAs)
```

close
```
public boolean close(boolean force)
```

isModifiedOnDisk
```
public boolean isModifiedOnDisk()
```

synchronizeLastModifiedDate

public void synchronizeLastModifiedDate()

getDateOfModificationOnDisk

public long getDateOfModificationOnDisk()

documentWillWriteData
```
public void documentWillWriteData()
```

documentWillReadData
```
public void documentWillReadData()
```

documentDidReadData
```
public void documentDidReadData()
```

Class XJDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.antlr.xjlib.foundation.XJObject

Methods inherited from class java.lang.Object

Field Detail

documentData

documentWindow

documentTitle

documentPath

documentFileExts

documentFileExtDescription

dirty

firstDocument

writing

javaContainer

absoluteCounter

fileMonitor

Constructor Detail

XJDocument

Method Detail

awake

isInternalOnly

isFirstDocument

setDirty

isDirty

changeDone

changeReset

setTitle

setWindow

getWindow

setJavaContainer

getSwingComponent

showWindow

setDocumentData

getDocumentData

getDocumentPath

getDocumentFolder

getDocumentName

getDocumentNameWithoutExtension

setDocumentFileType

observeValueForKey

load

reload

autoSave

save

close

isModifiedOnDisk

synchronizeLastModifiedDate

getDateOfModificationOnDisk

documentWillWriteData

documentWillReadData

documentDidReadData