AbstractAdvancedScript (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.base.BaseObject
- - adams.core.base.AbstractBaseString
  - - adams.gui.core.AbstractAdvancedScript

All Implemented Interfaces:

CloneHandler<BaseObject>, Serializable, Comparable

Direct Known Subclasses:

GroovyScript, XSLTStyleSheet
```
public abstract class AbstractAdvancedScript
extends AbstractBaseString
```
Ancestor for scripts with syntax highlighting in the GOE using the RSyntaxTextArea component.

Version:

$Revision: 5730 $

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

AbstractAdvancedScript()
Initializes the string with length 0.

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract boolean`	`allowsInlineEditing()`	Returns whether inline editing in the GOE is allowed.
`protected abstract String`	`getScriptTipText()`	Returns the tip text for the script.
`abstract AbstractTextAreaPanelWithAdvancedSyntaxHighlighting`	`getTextAreaPanel()`	Returns the configured text area panel to use in the GOE.
`String`	`getTipText()`	Returns a tool tip for the GUI editor (ignored if null is returned).
`String`	`stringValue()`	Returns the backquoted String value.

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
  - AbstractAdvancedScript
```
public AbstractAdvancedScript()
```
    Initializes the string with length 0.
  - AbstractAdvancedScript
```
public AbstractAdvancedScript(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 AbstractBaseString
    
    Returns:
    
    the backquoted String value
  - getScriptTipText
```
protected abstract String getScriptTipText()
```
    Returns the tip text for the script.
    
    Returns:
    
    the tool tip
  - getTipText
```
public String getTipText()
```
    Returns a tool tip for the GUI editor (ignored if null is returned).
    
    Specified by:
    
    getTipText in class AbstractBaseString
    
    Returns:
    
    the tool tip
  - getTextAreaPanel
```
public abstract AbstractTextAreaPanelWithAdvancedSyntaxHighlighting getTextAreaPanel()
```
    Returns the configured text area panel to use in the GOE.
    
    Returns:
    
    the text area panel
  - allowsInlineEditing
```
public abstract boolean allowsInlineEditing()
```
    Returns whether inline editing in the GOE is allowed.
    
    Returns:
    
    true if inline editing is allowed