SpreadSheetFormulaText (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.base.BaseObject
- - adams.core.base.AbstractBaseString
  - - adams.gui.core.AbstractSimpleScript
    - - adams.parser.SpreadSheetFormulaText

All Implemented Interfaces:

CloneHandler<BaseObject>, Serializable, Comparable
```
public class SpreadSheetFormulaText
extends AbstractSimpleScript
```
Wrapper for a String object to be editable in the GOE. Basically the same as BaseString, but used for longer, multi-line strings. Uses a different GOE editor.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.core.base.BaseObject
  m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors
Constructor Description

SpreadSheetFormulaText()
Initializes the string with length 0.

SpreadSheetFormulaText(String s)
Initializes the object with the string to parse.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`allowsInlineEditing()`	Returns whether inline editing in the GOE is allowed.
`protected String`	`getScriptTipText()`	Returns the tip text for the script.
`AbstractTextEditorPanelWithSimpleSyntaxHighlighting`	`getTextEditorPanel()`	Returns the configured text editor panel to use in the GOE.
`String`	`stringValue()`	Returns the backquoted String value.

Methods inherited from class adams.gui.core.AbstractSimpleScript
getTipText

Methods inherited from class adams.core.base.AbstractBaseString
convert, getValue, initialize, isEmpty, isValid, length, setValue

Methods inherited from class adams.core.base.BaseObject
compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SpreadSheetFormulaText
```
public SpreadSheetFormulaText()
```
    Initializes the string with length 0.
  - SpreadSheetFormulaText
```
public SpreadSheetFormulaText(String s)
```
    Initializes the object with the string to parse.
    
    Parameters:
    
    s - the string to parse
- Method Detail
  - stringValue
```
public String stringValue()
```
    Returns the backquoted String value.
    
    Overrides:
    
    stringValue in class AbstractSimpleScript
    
    Returns:
    
    the backquoted String value
  - getScriptTipText
```
protected String getScriptTipText()
```
    Returns the tip text for the script.
    
    Specified by:
    
    getScriptTipText in class AbstractSimpleScript
    
    Returns:
    
    the tool tip
  - getTextEditorPanel
```
public AbstractTextEditorPanelWithSimpleSyntaxHighlighting getTextEditorPanel()
```
    Returns the configured text editor panel to use in the GOE.
    
    Specified by:
    
    getTextEditorPanel in class AbstractSimpleScript
    
    Returns:
    
    the text editor panel
  - allowsInlineEditing
```
public boolean allowsInlineEditing()
```
    Returns whether inline editing in the GOE is allowed.
    
    Specified by:
    
    allowsInlineEditing in class AbstractSimpleScript
    
    Returns:
    
    true if inline editing is allowed