org.scripthelper.swing.editor

Class EditorComponentHelper

java.lang.Object

org.scripthelper.swing.editor.EditorComponentHelper

public class EditorComponentHelper
extends java.lang.Object

The editor component helper.

Since:

1.6.6

Constructor Summary

Constructors

Constructor and Description
EditorComponentHelper() Constructor.
EditorComponentHelper(java.io.File scriptFile) Constructor.
EditorComponentHelper(ScriptWrapper wrapper) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addScriptEditorListener(ScriptEditorListener listener) Add a ScriptEditorListener.
static void	addSyntaxPack(java.net.URL pack) Add a syntax pack for the code highlighting.
short	getEditorState() Return the current Editor state.
java.util.List<java.lang.String>	getLines() Return the editor lines.
javax.swing.JPanel	getPanel() Return the helper panel.
java.util.List<ScriptEditorListener>	getScriptEditorListeners() Return the list of ScriptEditorListeners.
java.io.File	getScriptFile() Return the script file.
ScriptWrapper	getScriptWrapper() Return the script wrapper.
java.lang.String	getText() Return the text in the editor.
javax.swing.JPanel	getToolbar() Return the helper toolbar.
boolean	save() Save the content of the editor.
void	setScriptFile(java.io.File scriptFile) Set the script file.
void	setScriptWrapper(ScriptWrapper wrapper) Set the script wrapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorComponentHelper

public EditorComponentHelper()

Constructor.

EditorComponentHelper

public EditorComponentHelper(java.io.File scriptFile)

Constructor.

Parameters:

scriptFile - the script file

EditorComponentHelper

public EditorComponentHelper(ScriptWrapper wrapper)

Constructor.

Parameters:

wrapper - the script wrapper

Method Detail

setScriptWrapper

public void setScriptWrapper(ScriptWrapper wrapper)

Set the script wrapper.

Parameters:

wrapper - the script wrapper

setScriptFile

public void setScriptFile(java.io.File scriptFile)

Set the script file.

Parameters:

scriptFile - the script file

getPanel

public javax.swing.JPanel getPanel()

Return the helper panel.

Returns:

the helper panel

getToolbar

public javax.swing.JPanel getToolbar()

Return the helper toolbar.

Returns:

the helper toolbar

addScriptEditorListener

public void addScriptEditorListener(ScriptEditorListener listener)

Add a ScriptEditorListener.

Parameters:

listener - the listener

getScriptEditorListeners

public java.util.List<ScriptEditorListener> getScriptEditorListeners()

Return the list of ScriptEditorListeners.

Returns:

the listeners

getText

public java.lang.String getText()

Return the text in the editor.

Returns:

the text

getScriptFile

public java.io.File getScriptFile()

Return the script file.

Returns:

the script file

getScriptWrapper

public ScriptWrapper getScriptWrapper()

Return the script wrapper.

Returns:

the script wrapper

getEditorState

public short getEditorState()

Return the current Editor state.

Returns:

the editor state

save

public boolean save()

Save the content of the editor.

Returns:

true if the content was saved

addSyntaxPack

public static void addSyntaxPack(java.net.URL pack)

Add a syntax pack for the code highlighting.

Parameters:

pack - the syntax pack (must be a jar file)

getLines

public java.util.List<java.lang.String> getLines()
                                          throws java.io.IOException

Return the editor lines.

Returns:

the lines

Throws:

java.io.IOException - if the source could not be read