Package adams.data.textrenderer

Class AbstractLineNumberedLimitedTextRenderer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.textrenderer.AbstractTextRenderer

adams.data.textrenderer.AbstractLimitedTextRenderer

adams.data.textrenderer.AbstractLineNumberedLimitedTextRenderer

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, LimitedTextRenderer, LineNumberTextRenderer, TextRenderer, Serializable

Direct Known Subclasses:

ArrayTextRenderer, CollectionTextRenderer, ListTextRenderer, SetTextRenderer

public abstract class AbstractLineNumberedLimitedTextRenderer
extends AbstractLimitedTextRenderer
implements LineNumberTextRenderer

Ancestor for text renderers that can output line numbers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_OutputLineNumbers	whether to output line numbers.

Fields inherited from class adams.data.textrenderer.AbstractLimitedTextRenderer

DOTS, m_ActualLimit, m_Limit

Fields inherited from class adams.data.textrenderer.AbstractTextRenderer

m_Default, m_Renderers

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractLineNumberedLimitedTextRenderer()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected boolean	getDefaultOutputLineNumbers()	Returns the default value for outputting line numbers.
boolean	getOutputLineNumbers()	Returns whether to output line numbers.
String	outputLineNumbersTipText()	Returns the tip text for this property.
void	setOutputLineNumbers(boolean value)	Sets whether to output line numbers.

Methods inherited from class adams.data.textrenderer.AbstractLimitedTextRenderer

getActualLimit, getDefaultLimit, getLimit, getMaxLimit, getMinLimit, limitTipText, render, renderUnlimited, setLimit

Methods inherited from class adams.data.textrenderer.AbstractTextRenderer

check, doRender, getDefaultRenderer, getRenderer, getRenderer, getRenderers, getRenderers, renderObject

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.data.textrenderer.TextRenderer

handles, handles, render

Field Detail

m_OutputLineNumbers

protected boolean m_OutputLineNumbers

whether to output line numbers.

Constructor Detail

AbstractLineNumberedLimitedTextRenderer

public AbstractLineNumberedLimitedTextRenderer()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractLimitedTextRenderer

getDefaultOutputLineNumbers

protected boolean getDefaultOutputLineNumbers()

Returns the default value for outputting line numbers.

Returns:

the default

setOutputLineNumbers

public void setOutputLineNumbers(boolean value)

Sets whether to output line numbers.

Specified by:

setOutputLineNumbers in interface LineNumberTextRenderer

Parameters:

value - true if to output

getOutputLineNumbers

public boolean getOutputLineNumbers()

Returns whether to output line numbers.

Specified by:

getOutputLineNumbers in interface LineNumberTextRenderer

Returns:

true if to output

outputLineNumbersTipText

public String outputLineNumbersTipText()

Returns the tip text for this property.

Specified by:

outputLineNumbersTipText in interface LineNumberTextRenderer

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui