Package adams.gui.core.spreadsheetpreview

Class SimpleText

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.core.spreadsheetpreview.AbstractSpreadSheetPreview

adams.gui.core.spreadsheetpreview.SimpleText

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class SimpleText
extends AbstractSpreadSheetPreview

Simply displays the specified columns as text.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleText.SimpleTextPanel	Displays the rows in a text area.

Nested classes/interfaces inherited from class adams.gui.core.spreadsheetpreview.AbstractSpreadSheetPreview

AbstractSpreadSheetPreview.AbstractSpreadSheetPreviewPanel

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnRange	m_Columns	the column range to display.
protected Font	m_Font	the font to use.
protected String	m_MissingValue	the string to use for missing values.

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
SimpleText()

Method Summary

Modifier and Type	Method	Description
String	columnsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	fontTipText()	Returns the tip text for this property.
AbstractSpreadSheetPreview.AbstractSpreadSheetPreviewPanel	generate()	Generates the preview panel.
SpreadSheetColumnRange	getColumns()	Returns the columns to display.
protected Font	getDefaultFont()	Returns the default font for the dialog.
Font	getFont()	Returns the font for the text area.
String	getMissingValue()	Returns the string to use for missing values.
String	globalInfo()	Returns a string describing the object.
String	missingValueTipText()	Returns the tip text for this property.
void	setColumns(SpreadSheetColumnRange value)	Sets the columns to display.
void	setFont(Font value)	Sets the font for the text area.
void	setMissingValue(String value)	Sets the string to use for missing values.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Field Detail

m_Columns

protected SpreadSheetColumnRange m_Columns

the column range to display.

m_Font

protected Font m_Font

the font to use.

m_MissingValue

protected String m_MissingValue

the string to use for missing values.

Constructor Detail

SimpleText

public SimpleText()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setColumns

public void setColumns(SpreadSheetColumnRange value)

Sets the columns to display.

Parameters:

value - the columns

getColumns

public SpreadSheetColumnRange getColumns()

Returns the columns to display.

Returns:

the columns

columnsTipText

public String columnsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getDefaultFont

protected Font getDefaultFont()

Returns the default font for the dialog.

Returns:

the default font

setFont

public void setFont(Font value)

Sets the font for the text area.

Parameters:

value - the font

getFont

public Font getFont()

Returns the font for the text area.

Returns:

the font

fontTipText

public String fontTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setMissingValue

public void setMissingValue(String value)

Sets the string to use for missing values.

Parameters:

value - the string

getMissingValue

public String getMissingValue()

Returns the string to use for missing values.

Returns:

the string

missingValueTipText

public String missingValueTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

generate

public AbstractSpreadSheetPreview.AbstractSpreadSheetPreviewPanel generate()

Generates the preview panel.

Specified by:

generate in class AbstractSpreadSheetPreview

Returns:

the preview panel, null if none generated