Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

nui::TFixedSizeDocumentFilter Class Reference

Filter for fixed size documents. More...

Inheritance diagram for nui::TFixedSizeDocumentFilter:

List of all members.

Public Methods

 TFixedSizeDocumentFilter (int iMAX_SIZE)
void insertString (DocumentFilter.FilterBypass tFILTER_BYPASS, int iOFFSET, String yTEXT, AttributeSet tATTRIBUTE_SET) throws BadLocationException
void replace (DocumentFilter.FilterBypass tFILTER_BYPASS, int iOFFSET, int iLENGTH, String yTEXT, AttributeSet tATTRIBUTE_SET) throws BadLocationException

Detailed Description

Filter for fixed size documents.

Definition at line 35 of file TFixedSizeDocumentFilter.java.

Constructor & Destructor Documentation

nui::TFixedSizeDocumentFilter::TFixedSizeDocumentFilter (  int    iMAX_SIZE )  [inline]
 

Builds a new instance.

Parameters:
iMAX_SIZE  Maximum number of characters allowed.

Definition at line 50 of file TFixedSizeDocumentFilter.java.

Member Function Documentation

void nui::TFixedSizeDocumentFilter::insertString (  DocumentFilter.FilterBypass    tFILTER_BYPASS,
int    iOFFSET,
String    yTEXT,
AttributeSet    tATTRIBUTE_SET
)  throws BadLocationException [inline]
 

Invoked prior to insertion of text into the specified Document. Subclasses that want to conditionally allow insertion should override this and only call supers implementation as necessary, or call directly into the FilterBypass.

Parameters:
tFILTER_BYPASS  The FilterBypass object that can be used to mutate the Document object.
iOFFSET  The offset into the document to insert the content. All positions that track change at or after the given location will move.
yTEXT  The text to insert.
tATTRIBUTE_SET  The attributes to associate with the inserted content. This may be null if there are no such attributes.
Precondition:
( iOFFSET >= 0 )
Exceptions:
BadLocationException  The given insert position is not a valid position within the document.

Definition at line 73 of file TFixedSizeDocumentFilter.java.

References nui::TFixedSizeDocumentFilter::replace().

void nui::TFixedSizeDocumentFilter::replace (  DocumentFilter.FilterBypass    tFILTER_BYPASS,
int    iOFFSET,
int    iLENGTH,
String    yTEXT,
AttributeSet    tATTRIBUTE_SET
)  throws BadLocationException [inline]
 

Invoked prior to replacing a region of text in the specified Document object. Subclasses that want to conditionally allow replace should override this and only call supers implementation as necessary, or call directly into tFILTER_BYPASS object.

Parameters:
tFILTER_BYPASS  The FilterBypass object that can be used to mutate the Document object.
iOFFSET  The offset into the document to insert the content. All positions that track change at or after the given location will move.
iLENGTH  Length of the text to delete.
yTEXT  The text to insert, null indicates not text to insert.
tATTRIBUTE_SET  The attributes to associate with the inserted content. This may be null if there are no such attributes.
Precondition:
( iOFFSET >= 0 )
Exceptions:
BadLocationException  The given insert position is not a valid position within the document.

Definition at line 102 of file TFixedSizeDocumentFilter.java.

Referenced by nui::TFixedSizeDocumentFilter::insertString().

The documentation for this class was generated from the following file:
Generated on Mon Oct 13 02:35:27 2003 for MPCL by doxygen1.2.18