fr.cnes.genius.lowLevel

Class GBufferedTextArea

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genius.lowLevel.GBufferedTextArea

All Implemented Interfaces:

GTextAreaInterface, GDisplay, GListener, ActionListener, MouseWheelListener, EventListener

public class GBufferedTextArea
extends GContainer
implements ActionListener, GDisplay, GListener, GTextAreaInterface

Class defining a GTextArea with an offline buffer in order to improve the performance when treating for example outputs from programs.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	GEntryInt	currentPageEntry	0, 0, 0 => "newline , split 7 , alignx Right" 0, 0, 1 => (null) 0, 1 => "gapleft 4 , gapright 4 , gaptop 4 , gapbottom 4 , wmin 50 , wmax 50"
1	GLabel	totalPageNumberLabel	"gapleft 4 , gapright 4 , gaptop 4 , gapbottom 4 , wmin 50"
2	GButton	prevPageButton	(null)
3	GButton	nextPageButton	(null)
4	GToggleButton	realtimeButtton	(null)
5	GTextArea	textArea	"newline , pushx , pushy , growx , growy"

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GBufferedTextArea() Constructor.
GBufferedTextArea(int refreshPeriodMs, int linesPerPage) Constructor.
GBufferedTextArea(int refreshPeriodMs, int linesPerPage, File outputFile) Constructor.
GBufferedTextArea(String widgetId) Constructor.
GBufferedTextArea(String widgetId, int refreshPeriodMs, int linesPerPage) Constructor.
GBufferedTextArea(String widgetId, int refreshPeriodMs, int linesPerPage, File outputFile) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	after(GEvent e) Called after the event is processed.
void	appendLine(String line) Adds the text to the text area with adding a carriage return at the end.
void	before(GEvent e) Called before the event is processed.
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	generic() The prototype of the generic function that shall exist in all the descendants.
long	getCurrentDiskPageLine() getter mCurrentDiskPageLine
long	getCurrentPageBeginOffset() getter mCurrentPageBeginOffset
JTextArea	getJTextArea() Get the JTextArea associated with the component.
List<String>	getLineBuffer() getter m_lineBuffer
int	getLinesPerPage() getter m_linesPerPage
long	getLinesPerPageWithOverlap() getter m_linesPerPageWithOverlap
RandomAccessFile	getOutputBufferedWriter() getter mOutputBufferedWriter
File	getOutputFile() getter mOutputFile
long	getPageOverlapLines() getter m_pageOverlapLines
int	getPrevCurrentPage() getter mPrevCurrentPage
long	getPrevPageBeginOffset() setter mPrevPageBeginOffset
Timer	getRefreshTimer() getter mRefreshTimer
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
boolean	isRefreshTextArea() getter mRefreshTextArea
void	reset() Called when the element is to be reset, so it can perform the actions required to return to inital state.
void	setCurrentDiskPageLine(long currentDiskPageLine) setter mCurrentDiskPageLine
void	setCurrentPageBeginOffset(long currentPageBeginOffset) setter mCurrentPageBeginOffset
void	setCursorPositionAtBottom(boolean flag) Set if the cursor shall be always at the bottom.
protected void	setDefaultConstraints() Set default constraints.
void	setEditable(boolean b) Sets the specified boolean to indicate whether or not this TextComponent should be editable.
void	setLines(int linesPerPage, int overlap) setter to changes the lines & the overlap
void	setLineWrap(boolean flag) Sets the specified boolean to indicate whether the lines are wrapped in the widget or not.
void	setPrevCurrentPage(int prevCurrentPage) setter mPrevCurrentPage
void	setPrevPageBeginOffset(long prevPageBeginOffset) setter mPrevPageBeginOffset
void	setRefreshTextArea(boolean refreshTextArea) setter mRefreshTextArea
void	setToolTipText(String text) Set the tooltip of the GBufferedTextArea.

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GBufferedTextArea

public GBufferedTextArea()

Constructor. The widget identifier is assigned automatically. If the outputFile can not be created the object creation will fail with an execption.

GBufferedTextArea

public GBufferedTextArea(int refreshPeriodMs,
                         int linesPerPage)

Constructor. The widget identifier is assigned automatically. If the outputFile can not be created th object creation will fail with an execption.

Parameters:

refreshPeriodMs - delay of refreshing of the text area in milliseconds.

linesPerPage - numbero of lines per text area page.

GBufferedTextArea

public GBufferedTextArea(int refreshPeriodMs,
                         int linesPerPage,
                         File outputFile)

Constructor. The widget identifier is assigned automatically. If the outputFile can not be created th object creation will fail with an execption.

Parameters:

refreshPeriodMs - delay of refreshing of the text area in milliseconds.

linesPerPage - numbero of lines per text area page.

outputFile - output file where the text area will also be written.

GBufferedTextArea

public GBufferedTextArea(String widgetId)

Constructor. The widget identifier is assigned automatically. If the outputFile can not be created th object creation will fail with an execption.

Parameters:

widgetId - widget identifier.

GBufferedTextArea

public GBufferedTextArea(String widgetId,
                         int refreshPeriodMs,
                         int linesPerPage)

Constructor. The widget identifier is assigned automatically. If the outputFile can not be created th object creation will fail with an execption.

Parameters:

widgetId - widget identifier.

refreshPeriodMs - delay of refreshing of the text area in milliseconds.

linesPerPage - numbero of lines per text area page.

GBufferedTextArea

public GBufferedTextArea(String widgetId,
                         int refreshPeriodMs,
                         int linesPerPage,
                         File outputFile)

Constructor. The widget identifier is assigned automatically. If the outputFile can not be created th object creation will fail with an execption.

Parameters:

widgetId - widget identifier.

refreshPeriodMs - delay of refreshing of the text area in milliseconds.

linesPerPage - numbero of lines per text area page.

outputFile - output file where the text area will also be written.

Method Detail

getLinesPerPageWithOverlap

public long getLinesPerPageWithOverlap()

getter m_linesPerPageWithOverlap

Returns:

the lines per page

getCurrentDiskPageLine

public long getCurrentDiskPageLine()

getter mCurrentDiskPageLine

Returns:

mCurrentDiskPageLine long value

setCurrentDiskPageLine

public void setCurrentDiskPageLine(long currentDiskPageLine)

setter mCurrentDiskPageLine

Parameters:

currentDiskPageLine - value to set

getPrevPageBeginOffset

public long getPrevPageBeginOffset()

setter mPrevPageBeginOffset

Returns:

mPrevPageBeginOffset value

setPrevPageBeginOffset

public void setPrevPageBeginOffset(long prevPageBeginOffset)

setter mPrevPageBeginOffset

Parameters:

prevPageBeginOffset - value to set

getCurrentPageBeginOffset

public long getCurrentPageBeginOffset()

getter mCurrentPageBeginOffset

Returns:

mCurrentPageBeginOffset value

setCurrentPageBeginOffset

public void setCurrentPageBeginOffset(long currentPageBeginOffset)

setter mCurrentPageBeginOffset

Parameters:

currentPageBeginOffset - value to set

isRefreshTextArea

public boolean isRefreshTextArea()

getter mRefreshTextArea

Returns:

true if the textArea is refreshed

setRefreshTextArea

public void setRefreshTextArea(boolean refreshTextArea)

setter mRefreshTextArea

Parameters:

refreshTextArea - boolean value

getPrevCurrentPage

public int getPrevCurrentPage()

getter mPrevCurrentPage

Returns:

mPrevCurrentPage value

setPrevCurrentPage

public void setPrevCurrentPage(int prevCurrentPage)

setter mPrevCurrentPage

Parameters:

prevCurrentPage - value to set

getLineBuffer

public List<String> getLineBuffer()

getter m_lineBuffer

Returns:

m_lineBuffer list of string

getLinesPerPage

public int getLinesPerPage()

getter m_linesPerPage

Returns:

m_linesPerPage value

setLines

public void setLines(int linesPerPage,
                     int overlap)
              throws GBufferedTextAreaFileException

setter to changes the lines & the overlap

Parameters:

linesPerPage - lines to set

overlap - is the overlap to display lines

Throws:

GBufferedTextAreaFileException - exception with outputBufferedWriter

getPageOverlapLines

public long getPageOverlapLines()

getter m_pageOverlapLines

Returns:

m_pageOverlapLines value

getRefreshTimer

public Timer getRefreshTimer()

getter mRefreshTimer

Returns:

mRefreshTimer value

getOutputBufferedWriter

public RandomAccessFile getOutputBufferedWriter()

getter mOutputBufferedWriter

Returns:

mOutputBufferedWriter file

getOutputFile

public File getOutputFile()

getter mOutputFile

Returns:

mOutputFile file

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GComponent

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

setLineWrap

public void setLineWrap(boolean flag)

Sets the specified boolean to indicate whether the lines are wrapped in the widget or not.

Specified by:

setLineWrap in interface GTextAreaInterface

Parameters:

flag - true if the lines shall be wrapped, false otherwise.

setToolTipText

public void setToolTipText(String text)

Set the tooltip of the GBufferedTextArea.

Overrides:

setToolTipText in class GComponent

Parameters:

text - Text to be used in the tooltip.

appendLine

public void appendLine(String line)
                throws GBufferedTextAreaFileException

Adds the text to the text area with adding a carriage return at the end.

Specified by:

appendLine in interface GTextAreaInterface

Parameters:

line - to be appended to the text area.

Throws:

GBufferedTextAreaFileException - if the line can not be written to the file.

reset

public final void reset()
                 throws GBufferedTextAreaFileException

Called when the element is to be reset, so it can perform the actions required to return to inital state.

Specified by:

reset in interface GTextAreaInterface

Throws:

GBufferedTextAreaFileException - in case of failing to clear the file buffer.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

display

public void display()
             throws GException

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

Throws:

GException - in case of problem while reading the value from file.

generic

public void generic()
             throws GException

The prototype of the generic function that shall exist in all the descendants.

Specified by:

generic in class GContainer

Throws:

GException - In case of problem.

before

public void before(GEvent e)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

GException - in case there is a problem managing the event.

after

public void after(GEvent e)
           throws GException

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GException - in case there is a problem managing the event.

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.

getJTextArea

public JTextArea getJTextArea()

Get the JTextArea associated with the component. If no JTextArea can be associated with the component a runtime exception is raised.

Specified by:

getJTextArea in interface GTextAreaInterface

Returns:

the JTextArea associated with the component.

setEditable

public void setEditable(boolean b)

Sets the specified boolean to indicate whether or not this TextComponent should be editable.

Specified by:

setEditable in interface GTextAreaInterface

Parameters:

b - the boolean to be set

setCursorPositionAtBottom

public void setCursorPositionAtBottom(boolean flag)

Set if the cursor shall be always at the bottom.

Specified by:

setCursorPositionAtBottom in interface GTextAreaInterface

Parameters:

flag - true it the cursor shall always be at the bottom of the text view, false otherwise.