org.codehaus.mojo.pomtools.console.toolkit
Class ConsoleEvent

java.lang.Object
  extended by org.codehaus.mojo.pomtools.console.toolkit.ConsoleEvent

public class ConsoleEvent
extends Object

Version:
$Id: ConsoleEvent.java 2166 2006-07-18 21:32:16Z carlos $
Author:
David Hawkins

Constructor Summary
ConsoleEvent(Terminal terminal, String input)
           
 
Method Summary
 void addConsoleMessage(String consoleMessage)
          Adds a message to be displayed to the user on the next screen redraw.
 void consume()
          Consumes this event.
 String getConsoleInput()
           
 List getConsoleMessages()
           
 ConsoleScreen getNextScreen()
           
 Terminal getTerminal()
           
 boolean isConsumed()
          Returns whether this event has been consumed.
 boolean isExitApplication()
           
 boolean isReturnToFirstScreen()
           
 boolean isReturnToPreviousScreen()
           
 void setExitApplication(boolean exitApplication)
           
 void setNextScreen(ConsoleScreen nextScreen)
           
 void setReturnToFirstScreen()
           
 void setReturnToFirstScreen(boolean returnToFirstScreen)
           
 void setReturnToPreviousScreen()
           
 void setReturnToPreviousScreen(boolean returnToPreviousScreen)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConsoleEvent

public ConsoleEvent(Terminal terminal,
                    String input)
Method Detail

consume

public void consume()
Consumes this event.


isConsumed

public boolean isConsumed()
Returns whether this event has been consumed.


getConsoleInput

public String getConsoleInput()

isExitApplication

public boolean isExitApplication()

setExitApplication

public void setExitApplication(boolean exitApplication)

getNextScreen

public ConsoleScreen getNextScreen()

setNextScreen

public void setNextScreen(ConsoleScreen nextScreen)

isReturnToPreviousScreen

public boolean isReturnToPreviousScreen()

setReturnToPreviousScreen

public void setReturnToPreviousScreen(boolean returnToPreviousScreen)

setReturnToPreviousScreen

public void setReturnToPreviousScreen()

isReturnToFirstScreen

public boolean isReturnToFirstScreen()

setReturnToFirstScreen

public void setReturnToFirstScreen(boolean returnToFirstScreen)

setReturnToFirstScreen

public void setReturnToFirstScreen()

getConsoleMessages

public List getConsoleMessages()

addConsoleMessage

public void addConsoleMessage(String consoleMessage)
Adds a message to be displayed to the user on the next screen redraw.

Parameters:
consoleMessage - the message to display

getTerminal

public Terminal getTerminal()


Copyright © 2011 The Codehaus. All Rights Reserved.