Skip navigation links


com.essbase.eas.ui.editor.editpane
Class ReadOnlyDocument

java.lang.Object
  extended by com.essbase.eas.ui.editor.editpane.ReadOnlyDocument

All Implemented Interfaces:
javax.swing.text.Document

public class ReadOnlyDocument
extends java.lang.Object
implements javax.swing.text.Document

Nested Class Summary
static class ReadOnlyDocument.LineOffset
           
 class ReadOnlyDocument.ReaderThread
           
 class ReadOnlyDocument.ReadOnlyElement
           
 class ReadOnlyDocument.ReadOnlyEvent
           
static class ReadOnlyDocument.ReadOnlyPosition
           
 class ReadOnlyDocument.ReadOnlyRootElement
           

 

Field Summary
protected  boolean cancelled
           
protected  boolean deleteFile
           
protected  int docLength
           
protected  javax.swing.event.EventListenerList listenerList
           
protected  ObjectBucketList offList
           
protected  java.util.Hashtable properties
           
protected  CRandomAccessFile rafContent
           
protected  TextFileReader reader
           
protected  ReadOnlyDocument.ReadOnlyRootElement root
           

 

Fields inherited from interface javax.swing.text.Document
StreamDescriptionProperty, TitleProperty

 

Constructor Summary
ReadOnlyDocument(java.util.List list, javax.swing.JProgressBar bar)
           
ReadOnlyDocument(java.lang.String text, javax.swing.JProgressBar bar)
           
ReadOnlyDocument(TextFileReader reader)
           
ReadOnlyDocument(TextFileReader reader, javax.swing.JProgressBar bar)
           

 

Method Summary
 void addDocumentListener(javax.swing.event.DocumentListener listener)
           
 void addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
          Registers the given observer to begin receiving notifications when undoable edits are made to the document.
 int binarySearch(java.util.ArrayList list, long offset)
           
 int binarySearch(long offset)
           
 void cancelLoading()
           
 javax.swing.text.Position createPosition(int offs)
          This method allows an application to mark a place in a sequence of character content.
 void dispose()
           
 void fireInsert(int offset, int len)
           
protected  void fireInsertUpdate(javax.swing.event.DocumentEvent e)
           
 javax.swing.text.Element getDefaultRootElement()
          Returns the root element that views should be based upon, unless some other mechanism for assigning views to element structures is provided.
 javax.swing.text.Position getEndPosition()
          Returns a position that represents the end of the document.
 int getLength()
          Returns number of characters of content currently in the document.
 java.lang.Object getProperty(java.lang.Object key)
          Gets the properties associated with the document.
 javax.swing.text.Element[] getRootElements()
          Returns all of the root elements that are defined.
 javax.swing.text.Position getStartPosition()
          Returns a position that represents the start of the document.
 java.lang.String getText(int offset, int len)
          Fetches the text contained within the given portion of the document.
 void getText(int offset, int length, javax.swing.text.Segment txt)
          Fetches the text contained within the given portion of the document.
 void insertString(int offset, java.lang.String str, javax.swing.text.AttributeSet a)
          Inserts a string of content.
 void putProperty(java.lang.Object key, java.lang.Object value)
          Associates a property with the document.
 void remove(int offs, int len)
          Removes a portion of the content of the document.
 void removeDocumentListener(javax.swing.event.DocumentListener listener)
          Unregisters the given observer from the notification list so it will no longer receive change updates.
 void removeUndoableEditListener(javax.swing.event.UndoableEditListener listener)
          Unregisters the given observer from the notification list so it will no longer receive updates.
 void render(java.lang.Runnable r)
          This allows the model to be safely rendered in the presence of currency, if the model supports being updated asynchronously.
 void setDeleteFileOnClose(boolean delete)
           

 

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

 

Field Detail

listenerList

protected javax.swing.event.EventListenerList listenerList

root

protected ReadOnlyDocument.ReadOnlyRootElement root

rafContent

protected CRandomAccessFile rafContent

offList

protected ObjectBucketList offList

properties

protected java.util.Hashtable properties

docLength

protected int docLength

cancelled

protected boolean cancelled

deleteFile

protected boolean deleteFile

reader

protected TextFileReader reader

Constructor Detail

ReadOnlyDocument

public ReadOnlyDocument(TextFileReader reader)

ReadOnlyDocument

public ReadOnlyDocument(TextFileReader reader,
                        javax.swing.JProgressBar bar)

ReadOnlyDocument

public ReadOnlyDocument(java.util.List list,
                        javax.swing.JProgressBar bar)

ReadOnlyDocument

public ReadOnlyDocument(java.lang.String text,
                        javax.swing.JProgressBar bar)

Method Detail

fireInsert

public void fireInsert(int offset,
                       int len)

fireInsertUpdate

protected void fireInsertUpdate(javax.swing.event.DocumentEvent e)

getLength

public int getLength()
Returns number of characters of content currently in the document.
Specified by:
getLength in interface javax.swing.text.Document
Returns:
number of characters >= 0

addDocumentListener

public void addDocumentListener(javax.swing.event.DocumentListener listener)
Specified by:
addDocumentListener in interface javax.swing.text.Document

removeDocumentListener

public void removeDocumentListener(javax.swing.event.DocumentListener listener)
Unregisters the given observer from the notification list so it will no longer receive change updates.
Specified by:
removeDocumentListener in interface javax.swing.text.Document
Parameters:
listener - the observer to register
See Also:
Document.addDocumentListener(javax.swing.event.DocumentListener)

addUndoableEditListener

public void addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
Registers the given observer to begin receiving notifications when undoable edits are made to the document.
Specified by:
addUndoableEditListener in interface javax.swing.text.Document
Parameters:
listener - the observer to register
See Also:
UndoableEditEvent

removeUndoableEditListener

public void removeUndoableEditListener(javax.swing.event.UndoableEditListener listener)
Unregisters the given observer from the notification list so it will no longer receive updates.
Specified by:
removeUndoableEditListener in interface javax.swing.text.Document
Parameters:
listener - the observer to register
See Also:
UndoableEditEvent

getProperty

public java.lang.Object getProperty(java.lang.Object key)
Gets the properties associated with the document.
Specified by:
getProperty in interface javax.swing.text.Document
Parameters:
key - a non-null property key
Returns:
the properties
See Also:
putProperty(Object, Object)

putProperty

public void putProperty(java.lang.Object key,
                        java.lang.Object value)
Associates a property with the document. Two standard property keys provided are: StreamDescriptionProperty and TitleProperty. Other properties, such as author, may also be defined.
Specified by:
putProperty in interface javax.swing.text.Document
Parameters:
key - the non-null property key
value - the property value
See Also:
getProperty(Object)

remove

public void remove(int offs,
                   int len)
            throws javax.swing.text.BadLocationException
Removes a portion of the content of the document. This will cause a DocumentEvent of type DocumentEvent.EventType.REMOVE to be sent to the registered DocumentListeners, unless an exception is thrown. The notification will be sent to the listeners by calling the removeUpdate method on the DocumentListeners.

To ensure reasonable behavior in the face of concurrency, the event is dispatched after the mutation has occurred. This means that by the time a notification of removal is dispatched, the document has already been updated and any marks created by createPosition have already changed. For a removal, the end of the removal range is collapsed down to the start of the range, and any marks in the removal range are collapsed down to the start of the range.

If the Document structure changed as result of the removal, the details of what Elements were inserted and removed in response to the change will also be contained in the generated DocumentEvent. It is up to the implementation of a Document to decide how the structure should change in response to a remove.

If the Document supports undo/redo, an UndoableEditEvent will also be generated.

Specified by:
remove in interface javax.swing.text.Document
Parameters:
offs - the offset from the beginning >= 0
len - the number of characters to remove >= 0
Throws:
javax.swing.text.BadLocationException - some portion of the removal range was not a valid part of the document. The location in the exception is the first bad position encountered.
See Also:
DocumentEvent, DocumentListener, UndoableEditEvent, UndoableEditListener

insertString

public void insertString(int offset,
                         java.lang.String str,
                         javax.swing.text.AttributeSet a)
                  throws javax.swing.text.BadLocationException
Inserts a string of content. This will cause a DocumentEvent of type DocumentEvent.EventType.INSERT to be sent to the registered DocumentListers, unless an exception is thrown. The DocumentEvent will be delivered by calling the insertUpdate method on the DocumentListener. The offset and length of the generated DocumentEvent will indicate what change was actually made to the Document.

If the Document structure changed as result of the insertion, the details of what Elements were inserted and removed in response to the change will also be contained in the generated DocumentEvent. It is up to the implementation of a Document to decide how the structure should change in response to an insertion.

If the Document supports undo/redo, an UndoableEditEvent will also be generated.

Specified by:
insertString in interface javax.swing.text.Document
Parameters:
offset - the offset into the document to insert the content >= 0. All positions that track change at or after the given location will move.
str - the string to insert
a - the attributes to associate with the inserted content. This may be null if there are no attributes.
Throws:
javax.swing.text.BadLocationException - the given insert position is not a valid position within the document
See Also:
DocumentEvent, DocumentListener, UndoableEditEvent, UndoableEditListener

getText

public java.lang.String getText(int offset,
                                int len)
                         throws javax.swing.text.BadLocationException
Fetches the text contained within the given portion of the document.
Specified by:
getText in interface javax.swing.text.Document
Parameters:
offset - the offset into the document representing the desired start of the text >= 0
length - the length of the desired string >= 0
Returns:
the text, in a String of length >= 0
Throws:
javax.swing.text.BadLocationException - some portion of the given range was not a valid part of the document. The location in the exception is the first bad position encountered.

getText

public void getText(int offset,
                    int length,
                    javax.swing.text.Segment txt)
             throws javax.swing.text.BadLocationException
Fetches the text contained within the given portion of the document.

If the partialReturn property on the txt parameter is false, the data returned in the Segment will be the entire length requested and may or may not be a copy depending upon how the data was stored. If the partialReturn property is true, only the amount of text that can be returned without creating a copy is returned. Using partial returns will give better performance for situations where large parts of the document are being scanned. The following is an example of using the partial return to access the entire document:



   int nleft = doc.getDocumentLength();
   Segment text = new Segment();
   int offs = 0;
   text.setPartialReturn(true);
   while (nleft > 0) {
       doc.getText(offs, nleft, text);
       // do someting with text
       nleft -= text.count;
       offs += text.count;
   }

 
Specified by:
getText in interface javax.swing.text.Document
Parameters:
offset - the offset into the document representing the desired start of the text >= 0
length - the length of the desired string >= 0
txt - the Segment object to return the text in
Throws:
javax.swing.text.BadLocationException - Some portion of the given range was not a valid part of the document. The location in the exception is the first bad position encountered.

getStartPosition

public javax.swing.text.Position getStartPosition()
Returns a position that represents the start of the document. The position returned can be counted on to track change and stay located at the beginning of the document.
Specified by:
getStartPosition in interface javax.swing.text.Document
Returns:
the position

getEndPosition

public javax.swing.text.Position getEndPosition()
Returns a position that represents the end of the document. The position returned can be counted on to track change and stay located at the end of the document.
Specified by:
getEndPosition in interface javax.swing.text.Document
Returns:
the position

createPosition

public javax.swing.text.Position createPosition(int offs)
                                         throws javax.swing.text.BadLocationException
This method allows an application to mark a place in a sequence of character content. This mark can then be used to tracks change as insertions and removals are made in the content. The policy is that insertions always occur prior to the current position (the most common case) unless the insertion location is zero, in which case the insertion is forced to a position that follows the original position.
Specified by:
createPosition in interface javax.swing.text.Document
Parameters:
offs - the offset from the start of the document >= 0
Returns:
the position
Throws:
javax.swing.text.BadLocationException - if the given position does not represent a valid location in the associated document

getRootElements

public javax.swing.text.Element[] getRootElements()
Returns all of the root elements that are defined.

Typically there will be only one document structure, but the interface supports building an arbitrary number of structural projections over the text data. The document can have multiple root elements to support multiple document structures. Some examples might be:

Specified by:
getRootElements in interface javax.swing.text.Document
Returns:
the root element

getDefaultRootElement

public javax.swing.text.Element getDefaultRootElement()
Returns the root element that views should be based upon, unless some other mechanism for assigning views to element structures is provided.
Specified by:
getDefaultRootElement in interface javax.swing.text.Document
Returns:
the root element

binarySearch

public int binarySearch(long offset)

binarySearch

public int binarySearch(java.util.ArrayList list,
                        long offset)

render

public void render(java.lang.Runnable r)
This allows the model to be safely rendered in the presence of currency, if the model supports being updated asynchronously. The given runnable will be executed in a way that allows it to safely read the model with no changes while the runnable is being executed. The runnable itself may not make any mutations.
Specified by:
render in interface javax.swing.text.Document
Parameters:
r - a Runnable used to render the model

cancelLoading

public void cancelLoading()

setDeleteFileOnClose

public void setDeleteFileOnClose(boolean delete)

dispose

public void dispose()

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.