Class DefaultInsertionHook

java.lang.Object

ca.phon.app.session.editor.view.transcript.DefaultInsertionHook

All Implemented Interfaces:

InsertionHook

Direct Known Subclasses:

HeaderTierExtension

public abstract class DefaultInsertionHook
extends Object
implements InsertionHook

Hook for controlling document insertions before they are preformed. Attribute sets may be modified and string contents may be altered by modifying the StringBuffer. The batchInsertString method may return a list of additional element specs which should be added after the provided data.

Constructor Summary

Constructors

Constructor	Description
DefaultInsertionHook()

Method Summary

Modifier and Type	Method	Description
List<DefaultStyledDocument.ElementSpec>	batchInsertString(StringBuilder buffer, MutableAttributeSet attrs)	Hook into batch string insertions before they are performed.
List<DefaultStyledDocument.ElementSpec>	endComment()
List<DefaultStyledDocument.ElementSpec>	endGem()
List<DefaultStyledDocument.ElementSpec>	endHeader()
List<DefaultStyledDocument.ElementSpec>	endHeaderLine()
List<DefaultStyledDocument.ElementSpec>	endRecord()
List<DefaultStyledDocument.ElementSpec>	endRecordHeader()
List<DefaultStyledDocument.ElementSpec>	endSession()
List<DefaultStyledDocument.ElementSpec>	endTier(MutableAttributeSet attrs)
List<DefaultStyledDocument.ElementSpec>	endTranscript()
List<DefaultStyledDocument.ElementSpec>	startComment()
List<DefaultStyledDocument.ElementSpec>	startGem()
List<DefaultStyledDocument.ElementSpec>	startHeader()
List<DefaultStyledDocument.ElementSpec>	startHeaderLine()
List<DefaultStyledDocument.ElementSpec>	startRecord()
List<DefaultStyledDocument.ElementSpec>	startRecordHeader()
List<DefaultStyledDocument.ElementSpec>	startSession()
List<DefaultStyledDocument.ElementSpec>	startTier()
List<DefaultStyledDocument.ElementSpec>	startTranscript()
void	tierRemoved(TranscriptDocument doc, String tierName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultInsertionHook

public DefaultInsertionHook()

Method Details

batchInsertString

public List<DefaultStyledDocument.ElementSpec> batchInsertString(StringBuilder buffer,
 MutableAttributeSet attrs)

Hook into batch string insertions before they are performed.

Specified by:

batchInsertString in interface InsertionHook

Parameters:

buffer -

attrs -

Returns:

list of additional element specs to add (if any)

startSession

public List<DefaultStyledDocument.ElementSpec> startSession()

Specified by:

startSession in interface InsertionHook

endSession

public List<DefaultStyledDocument.ElementSpec> endSession()

Specified by:

endSession in interface InsertionHook

startHeader

public List<DefaultStyledDocument.ElementSpec> startHeader()

Specified by:

startHeader in interface InsertionHook

endHeader

public List<DefaultStyledDocument.ElementSpec> endHeader()

Specified by:

endHeader in interface InsertionHook

startHeaderLine

public List<DefaultStyledDocument.ElementSpec> startHeaderLine()

Specified by:

startHeaderLine in interface InsertionHook

endHeaderLine

public List<DefaultStyledDocument.ElementSpec> endHeaderLine()

Specified by:

endHeaderLine in interface InsertionHook

startTranscript

public List<DefaultStyledDocument.ElementSpec> startTranscript()

Specified by:

startTranscript in interface InsertionHook

endTranscript

public List<DefaultStyledDocument.ElementSpec> endTranscript()

Specified by:

endTranscript in interface InsertionHook

startComment

public List<DefaultStyledDocument.ElementSpec> startComment()

Specified by:

startComment in interface InsertionHook

endComment

public List<DefaultStyledDocument.ElementSpec> endComment()

Specified by:

endComment in interface InsertionHook

startGem

public List<DefaultStyledDocument.ElementSpec> startGem()

Specified by:

startGem in interface InsertionHook

endGem

public List<DefaultStyledDocument.ElementSpec> endGem()

Specified by:

endGem in interface InsertionHook

startRecord

public List<DefaultStyledDocument.ElementSpec> startRecord()

Specified by:

startRecord in interface InsertionHook

endRecord

public List<DefaultStyledDocument.ElementSpec> endRecord()

Specified by:

endRecord in interface InsertionHook

startRecordHeader

public List<DefaultStyledDocument.ElementSpec> startRecordHeader()

Specified by:

startRecordHeader in interface InsertionHook

endRecordHeader

public List<DefaultStyledDocument.ElementSpec> endRecordHeader()

Specified by:

endRecordHeader in interface InsertionHook

startTier

public List<DefaultStyledDocument.ElementSpec> startTier()

Specified by:

startTier in interface InsertionHook

endTier

public List<DefaultStyledDocument.ElementSpec> endTier(MutableAttributeSet attrs)

Specified by:

endTier in interface InsertionHook

tierRemoved

public void tierRemoved(TranscriptDocument doc,
 String tierName)

Specified by:

tierRemoved in interface InsertionHook