InputManager::SwitchReplacement Class Reference

Inheritance diagram for InputManager::SwitchReplacement:

List of all members.

Public Member Functions
	SwitchReplacement (String s, int target, int st)
String	getReplacement (String input)
	Gives the temporary replacement for the prefix of input.
String	getFinalReplacement (String input)
	Gives the final replacement for the prefix of input.
String	getReplacementInfo ()
	Returns a typical replacement for documentation purposes.
Static Public Attributes
final int	ON = 1
final int	OFF = 2
Package Attributes
int	state
int	targetGroup

---

Constructor & Destructor Documentation

SwitchReplacement (  String  s, int  target, int  st )  [inline]

Definition at line 53 of file InputManager.java. References state, and targetGroup.

---

Member Function Documentation

String getFinalReplacement (  String  input  )  [inline]

Gives the final replacement for the prefix of input. This method yields a replacement for the prefix returned by replacesPrefixOf(input). This replacement is used in the final output. This method must not be called if replacesPrefixOf(input)==null. The default implementation of this method is to yield the same result as does getReplacement(input) Parameters: input  the input in which to replace. Returns: the replacement for the prefix. See also: replacesPrefixOf(String) getReplacement(String) Reimplemented from InputManager::StringReplacement. Definition at line 58 of file InputManager.java. References InputManager::Group::activate(), InputManager::Group::deactivate(), getFinalReplacement(), InputManager::Group::getFullName(), OFF, ON, state, and targetGroup. Referenced by getFinalReplacement().

String getReplacement (  String  input  )  [inline, virtual]

Gives the temporary replacement for the prefix of input. This method yields a replacement for the prefix returned by replacesPrefixOf(input). This replacement is shown in the temporary output. This method must not be called if replacesPrefixOf(input)==null. Parameters: input  the input in which to replace. Returns: the replacement for the prefix See also: replacesPrefixOf(String) Reimplemented from InputManager::StringReplacement. Definition at line 57 of file InputManager.java. References getReplacement(). Referenced by getReplacement().

String getReplacementInfo (   )  [inline]

Returns a typical replacement for documentation purposes. This method returns the replacement counterpart of getInputInfo() (like getReplacementInfo(getInputInfo())). The default behaviour of this method is to return getReplacement(getInputInfo()). If getReplacement(getInputInfo())==null, then you must override this method in subclasses. Returns: a replacement of getInputInfo() or any other string. See also: getInputInfo() getReplacement(String) Reimplemented from InputReplacement. Definition at line 75 of file InputManager.java. References OFF, ON, state, and targetGroup.

---

Member Data Documentation

final int OFF = 2 [static]

Definition at line 50 of file InputManager.java. Referenced by getFinalReplacement(), and getReplacementInfo().

final int ON = 1 [static]

Definition at line 49 of file InputManager.java. Referenced by getFinalReplacement(), and getReplacementInfo().

int state [package]

Definition at line 51 of file InputManager.java. Referenced by getFinalReplacement(), getReplacementInfo(), and SwitchReplacement().

int targetGroup [package]

Definition at line 52 of file InputManager.java. Referenced by getFinalReplacement(), getReplacementInfo(), and SwitchReplacement().

---

The documentation for this class was generated from the following file:

• InputManager.java

---