JSampler
v0.8a

org.jsampler
Interface LSConsoleModel

All Known Implementing Classes:
DefaultLSConsoleModel

public interface LSConsoleModel

A data model representing LS Console.


Method Summary
 void addLSConsoleListener(LSConsoleListener l)
          Registers the specified listener for receiving event messages.
 void addToCommandHistory(java.lang.String command)
          Adds the specified command to command history.
 void browseCommandHistoryDown()
          Browses the command history one line down.
 void browseCommandHistoryFirst()
          Browses to the first line of the command history.
 void browseCommandHistoryLast()
          Browses to the last line of the command history.
 void browseCommandHistoryUp()
          Browses the command history one line up.
 void clearCommandHistory()
          Clears the complete/multisession command history.
 void clearSessionHistory()
          Clears the session history.
 void execCommand()
          Executes the command specified in the command line.
 java.lang.String[] getCommandHistory()
          Gets the complete command history, excluding blank lines and comments.
 int getCommandHistorySize()
          Determines the maximum number of lines to be kept in the command history.
 java.lang.String getCommandLineText()
          Gets the text in the command line.
 java.lang.String[] getCommandList()
          Gets a list of all LSCP commands.
 java.lang.String getLastExecutedCommand()
          Gets the last executed command.
 java.lang.String[] getSessionHistory()
          Gets the command history of the current session, including blank lines and comments.
 void removeLSConsoleListener(LSConsoleListener l)
          Removes the specified listener.
 java.lang.String[] searchCommandHistory()
          Searches the command history for commands containing the string returned by getCommandLineText().
 java.lang.String[] searchCommandHistory(java.lang.String substring)
          Searches the command history for commands containing substring.
 java.lang.String[] searchCommandList()
          Searches the LSCP command list for commands containing the string returned by getCommandLineText().
 java.lang.String[] searchCommandList(java.lang.String substring)
          Searches the LSCP command list for commands containing substring.
 void setCommandHistorySize(int size)
          Sets the maximum number of lines to be kept in the command history.
 void setCommandLineText(java.lang.String cmdLine)
          Sets the text in the command line.
 

Method Detail

addLSConsoleListener

void addLSConsoleListener(LSConsoleListener l)
Registers the specified listener for receiving event messages.

Parameters:
l - The LSConsoleListener to register.

removeLSConsoleListener

void removeLSConsoleListener(LSConsoleListener l)
Removes the specified listener.

Parameters:
l - The LSConsoleListener to remove.

execCommand

void execCommand()
Executes the command specified in the command line.


getLastExecutedCommand

java.lang.String getLastExecutedCommand()
Gets the last executed command.

Returns:
The last command executed in the LS Console.

setCommandLineText

void setCommandLineText(java.lang.String cmdLine)
Sets the text in the command line.

Parameters:
cmdLine - The new command line text.

getCommandLineText

java.lang.String getCommandLineText()
Gets the text in the command line.

Returns:
The command line's text.

getSessionHistory

java.lang.String[] getSessionHistory()
Gets the command history of the current session, including blank lines and comments.

Returns:
The command history of the current session, including blank lines and comments.

clearSessionHistory

void clearSessionHistory()
Clears the session history.

See Also:
getSessionHistory()

addToCommandHistory

void addToCommandHistory(java.lang.String command)
Adds the specified command to command history.

Parameters:
command - The command to be added to command history.

getCommandHistory

java.lang.String[] getCommandHistory()
Gets the complete command history, excluding blank lines and comments.

Returns:
The complete command history, excluding blank lines and comments.

getCommandHistorySize

int getCommandHistorySize()
Determines the maximum number of lines to be kept in the command history.

Returns:
The maximum number of lines to be kept in the command history.

setCommandHistorySize

void setCommandHistorySize(int size)
Sets the maximum number of lines to be kept in the command history.

Parameters:
size - Determines the maximum number of lines to be kept in the command history.

clearCommandHistory

void clearCommandHistory()
Clears the complete/multisession command history.

See Also:
getCommandHistory()

getCommandList

java.lang.String[] getCommandList()
Gets a list of all LSCP commands.

Returns:
A list of all LSCP commands.

searchCommandList

java.lang.String[] searchCommandList()
Searches the LSCP command list for commands containing the string returned by getCommandLineText().

Returns:
All commands that contains the string returned by getCommandLineText().
See Also:
getCommandList()

searchCommandList

java.lang.String[] searchCommandList(java.lang.String substring)
Searches the LSCP command list for commands containing substring.

Parameters:
substring - The substring to be used to perform the search.
Returns:
All commands that contains substring.
See Also:
getCommandList()

searchCommandHistory

java.lang.String[] searchCommandHistory()
Searches the command history for commands containing the string returned by getCommandLineText().

Returns:
All commands that contains the string returned by getCommandLineText().
See Also:
getCommandHistory()

searchCommandHistory

java.lang.String[] searchCommandHistory(java.lang.String substring)
Searches the command history for commands containing substring.

Parameters:
substring - The substring to be used to perform the search.
Returns:
All commands that contains substring.
See Also:
getCommandList()

browseCommandHistoryUp

void browseCommandHistoryUp()
Browses the command history one line up.


browseCommandHistoryDown

void browseCommandHistoryDown()
Browses the command history one line down.


browseCommandHistoryFirst

void browseCommandHistoryFirst()
Browses to the first line of the command history.


browseCommandHistoryLast

void browseCommandHistoryLast()
Browses to the last line of the command history.


JSampler
v0.8a

Copyright © 2007 Grigor Iliev. All rights reserved.