net.grinder.console.editor

Class EditorModel

java.lang.Object

net.grinder.console.editor.EditorModel

public final class EditorModel
extends Object

Editor model.

Author:

Philip Aston

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorModel.AbstractListener Base EditorModel.Listener implementation that does nothing.
static interface	EditorModel.Listener Interface for listeners.

Constructor Summary

Constructors

Constructor and Description
EditorModel(Resources resources, TextSource.Factory textSourceFactory, AgentCacheState agentCacheState, FileChangeWatcher fileChangeWatcher) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(EditorModel.Listener listener) Add a new listener.
void	closeBuffer(Buffer buffer) Close a buffer.
Buffer	getBufferForFile(File file) Get the buffer for the given file.
Buffer[]	getBuffers() Return a copy of the current buffer list.
Buffer	getSelectedBuffer() Get the currently active buffer.
File	getSelectedPropertiesFile() Get the currently selected properties.
boolean	isABufferDirty() Return whether one of our buffers is dirty.
boolean	isBoringFile(File f) Return whether the given file should be marked as boring.
boolean	isPropertiesFile(File f) Return whether the given file should be considered to be a grinder properties file.
boolean	isScriptFile(File f) Return whether the given file should be considered to be a script file.
boolean	isSelectedScript(File f) Return whether the given file is the script file specified in the currently selected properties file.
void	openWithExternalEditor(File file) Open the given file with the external file.
void	selectBuffer(Buffer buffer) Select a buffer.
Buffer	selectBufferForFile(File file) Select the buffer for the given file.
void	selectNewBuffer() Select a new buffer.
void	setExternalEditor(File command, String arguments) Set the external editor command line.
void	setSelectedPropertiesFile(File selectedProperties) Set the currently selected properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorModel

public EditorModel(Resources resources,
           TextSource.Factory textSourceFactory,
           AgentCacheState agentCacheState,
           FileChangeWatcher fileChangeWatcher)

Constructor.

Parameters:

resources - ResourcesImplementation.

textSourceFactory - Factory for TextSources.

agentCacheState - Notified when the model updates a file.

fileChangeWatcher - A FileDistribution.

Method Detail

getSelectedBuffer

public Buffer getSelectedBuffer()

Get the currently active buffer.

Returns:

The active buffer.

selectNewBuffer

public void selectNewBuffer()

Select a new buffer.

selectBufferForFile

public Buffer selectBufferForFile(File file)
                           throws ConsoleException

Select the buffer for the given file.

Parameters:

file - The file.

Returns:

The buffer.

Throws:

ConsoleException - If a buffer could not be selected for the file.

getBufferForFile

public Buffer getBufferForFile(File file)

Get the buffer for the given file.

Parameters:

file - The file.

Returns:

The buffer; null => there is no buffer for the file.

getBuffers

public Buffer[] getBuffers()

Return a copy of the current buffer list.

Returns:

The buffer list.

isABufferDirty

public boolean isABufferDirty()

Return whether one of our buffers is dirty.

Returns:

true => a buffer is dirty.

selectBuffer

public void selectBuffer(Buffer buffer)

Select a buffer.

Parameters:

buffer - The buffer.

closeBuffer

public void closeBuffer(Buffer buffer)

Close a buffer.

Parameters:

buffer - The buffer.

getSelectedPropertiesFile

public File getSelectedPropertiesFile()

Get the currently selected properties.

Returns:

The selected properties.

setSelectedPropertiesFile

public void setSelectedPropertiesFile(File selectedProperties)

Set the currently selected properties.

Parameters:

selectedProperties - The selected properties.

addListener

public void addListener(EditorModel.Listener listener)

Add a new listener.

Parameters:

listener - The listener.

isScriptFile

public boolean isScriptFile(File f)

Return whether the given file should be considered to be a script file. For now this is just based on name.

Parameters:

f - The file.

Returns:

true => its a Python file.

isPropertiesFile

public boolean isPropertiesFile(File f)

Return whether the given file should be considered to be a grinder properties file. For now this is just based on name.

Parameters:

f - The file.

Returns:

true => its a properties file.

isSelectedScript

public boolean isSelectedScript(File f)

Return whether the given file is the script file specified in the currently selected properties file.

Parameters:

f - The file.

Returns:

true => its the selected script.

isBoringFile

public boolean isBoringFile(File f)

Return whether the given file should be marked as boring.

Parameters:

f - The file.

Returns:

a true => its boring.

openWithExternalEditor

public void openWithExternalEditor(File file)
                            throws ConsoleException

Open the given file with the external file.

Parameters:

file - The file.

Throws:

ConsoleException - If the file could not be opened.

setExternalEditor

public void setExternalEditor(File command,
                     String arguments)

Set the external editor command line.

Parameters:

command - Path to the external editor executable. null => no editor set.

arguments - Arguments to pass to the external editor. Any %f will be replaced with the absolute path of the file to edit. If no %f is found, the file path will be appended to the end of the command line.