acp.beans

Class Preference

java.lang.Object

java.util.Observable

acp.beans.Preference

public class Preference
extends java.util.Observable

The Preference class represent user preference. This class maintain the data structure needed to store user preference for ACP. The equals() method is override to allow comparison of preference objects based on the attribute of the preference object.

Author:

Loke Yan Hao, Ng Chin Hui

Constructor Summary

Constructors

Constructor and Description
Preference() Initializes a newly created Preference object so that it represents an empty Preference object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Return true if, and only if the object argument has the same attribute values with this preference object.
int	getDelayTrigger() Get the delay(in ms) to trigger the suggestion popup.
java.lang.String	getEnableACP() Get the hotkey enable and disable acp.
int	getEntriesInView() Return the number of entries to display on the auto-completion box (without scrolling).
java.lang.String	getExtendParagraph() Get the hotkey of extend suggestion by paragraph.
java.lang.String	getExtendSentence() Get the hotkey of extend suggestion by sentence.
java.lang.String	getExtendWord() Get the hotkey of extend suggestion by word.
java.lang.String	getReduceParagraph() Get the hotkey of reduce suggestion by paragraph.
java.lang.String	getReduceSentence() Get the hotkey of reduce suggestion by sentence.
java.lang.String	getReduceWord() Get the hotkey of reduce suggestion by word.
int	getThreshold() Return the threshold for the number of suggestion to auto-trigger auto-completion.
java.lang.String	getTriggerSuggestionPopUp() Get the hotkey of Trigger Suggestion PopUp.
boolean	isAutoTrigger() Return the trigger mode for auto-completion in text-editor add-in.
boolean	isDoNotPromptExit() Return true if, and only if user do not wish to see a prompt during exit.
boolean	isEnableDisable() Return the status of ACP during application launch.
boolean	isOnStartUp() Return true if, and only if ACP is set to launch during computer startup.
void	setAutoTrigger(boolean autoTrigger) Change the trigger mode for auto-completion of this preference.
void	setDelayTrigger(int triggerDelay) Set the delay(in ms) to trigger the suggestion popup.
void	setDoNotPromptExit(boolean doNotPromptExit) Change the exit prompt status of this preference.
void	setEnableACP(java.lang.String enableACP) Set the hotkey of enable and disable acp.
void	setEnableDisable(boolean enableDisable) Change the status of ACP during application launch of this preference.
void	setEntriesInView(int entriesInView) Change the number of entries of this preference.
void	setExtendParagraph(java.lang.String extendParagraph) Set the hotkey of extend suggestion by paragraph.
void	setExtendSentence(java.lang.String extendSentence) Set the hotkey of extend suggestion by sentence.
void	setExtendWord(java.lang.String extendWord) Set the hotkey of extend suggestion by word.
void	setOnStartUp(boolean onStartUp) Change the ACP startup option of this preference.
void	setReduceParagraph(java.lang.String reduceParagraph) Set the hotkey of reduce suggestion by paragraph.
void	setReduceSentence(java.lang.String reduceSentence) Set the hotkey of reduce suggestion by sentence.
void	setReduceWord(java.lang.String reduceWord) Set the hotkey of reduce suggestion by word.
void	setThreshold(int threshold) Change the threshold for the number of suggestion of this preference
void	setTriggerSuggestionPopUp(java.lang.String triggerSuggestionPopUp) Set the hotkey Trigger Suggestion PopUp.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Preference

public Preference()

Initializes a newly created Preference object so that it represents an empty Preference object.

Method Detail

getEntriesInView

public int getEntriesInView()

Return the number of entries to display on the auto-completion box (without scrolling).

Returns:

the number of entries to display on the auto-completion box.

setEntriesInView

public void setEntriesInView(int entriesInView)

Change the number of entries of this preference.

Parameters:

entriesInView - the number of entries to display on the auto-completion box.

isEnableDisable

public boolean isEnableDisable()

Return the status of ACP during application launch.

Return true if, and only if ACP is enable during application launch.

Returns:

the status of ACP during application launch.

setEnableDisable

public void setEnableDisable(boolean enableDisable)

Change the status of ACP during application launch of this preference.

Parameters:

enableDisable - the status of ACP during application launch. Set to true to enable ACP during application launch.

isAutoTrigger

public boolean isAutoTrigger()

Return the trigger mode for auto-completion in text-editor add-in.

If the trigger mode is in manual mode, this method returns false. User need to press a hotkey to trigger auto-completion in the respective text-editor.

If the trigger mode is in auto mode, this method returns true. User does not need to press a hotkey to trigger auto-completion. It is triggered when user is typing new characters.

Returns:

the trigger mode for auto-completion.

setAutoTrigger

public void setAutoTrigger(boolean autoTrigger)

Change the trigger mode for auto-completion of this preference.

Parameters:

autoTrigger - the trigger mode for auto-completion. Set to true for automatic mode, set to false for manual mode.

isOnStartUp

public boolean isOnStartUp()

Return true if, and only if ACP is set to launch during computer startup.

Returns:

return true if ACP is set to launch during computer startup.

setOnStartUp

public void setOnStartUp(boolean onStartUp)

Change the ACP startup option of this preference.

Parameters:

onStartUp - the ACP startup option. Set to true to launch ACP during computer startup; set to false to prevent it from been launch during startup.

isDoNotPromptExit

public boolean isDoNotPromptExit()

Return true if, and only if user do not wish to see a prompt during exit.

Returns:

return true if user do not wish to see a prompt during exit.

setDoNotPromptExit

public void setDoNotPromptExit(boolean doNotPromptExit)

Change the exit prompt status of this preference.

Parameters:

doNotPromptExit - the exit prompt status. Set to true if user wish to see the prompt during exit; set to false if user do no wish to see the prompt during exit.

getThreshold

public int getThreshold()

Return the threshold for the number of suggestion to auto-trigger auto-completion.

When user request for suggestion, a list of suggestions will be returned. If, and only if the number of suggestion in the list is higher than the threshold defined, an empty list of suggestion will be returned to prevent auto-completion from triggering.

Returns:

the sorting order type when displaying the list of suggestion.

See Also:

ACPLogic.requestSuggestion(String, boolean)

setThreshold

public void setThreshold(int threshold)

Change the threshold for the number of suggestion of this preference

Parameters:

threshold - the threshold for the number of suggestion.

getTriggerSuggestionPopUp

public java.lang.String getTriggerSuggestionPopUp()

Get the hotkey of Trigger Suggestion PopUp.

Returns:

the hotkey for trigger suggestion popup

setTriggerSuggestionPopUp

public void setTriggerSuggestionPopUp(java.lang.String triggerSuggestionPopUp)

Set the hotkey Trigger Suggestion PopUp.

Parameters:

triggerSuggestionPopUp - the hotkey for Trigger Suggestion PopUp

getEnableACP

public java.lang.String getEnableACP()

Get the hotkey enable and disable acp.

Returns:

the hotkey for enable and disable acp

setEnableACP

public void setEnableACP(java.lang.String enableACP)

Set the hotkey of enable and disable acp.

Parameters:

enableACP - the hotkey for enable and disable acp

getExtendWord

public java.lang.String getExtendWord()

Get the hotkey of extend suggestion by word.

Returns:

the hotkey of extend suggestion by word

setExtendWord

public void setExtendWord(java.lang.String extendWord)

Set the hotkey of extend suggestion by word.

Parameters:

extendWord - the hotkey of extend suggestion by word

getReduceWord

public java.lang.String getReduceWord()

Get the hotkey of reduce suggestion by word.

Returns:

the hotkey of reduce suggestion by word

setReduceWord

public void setReduceWord(java.lang.String reduceWord)

Set the hotkey of reduce suggestion by word.

Parameters:

reduceWord - the hotkey of reduce suggestion by word

getExtendSentence

public java.lang.String getExtendSentence()

Get the hotkey of extend suggestion by sentence.

Returns:

the hotkey of extend suggestion by sentence

setExtendSentence

public void setExtendSentence(java.lang.String extendSentence)

Set the hotkey of extend suggestion by sentence.

Parameters:

extendSentence - the hotkey of extend suggestion by sentence

getReduceSentence

public java.lang.String getReduceSentence()

Get the hotkey of reduce suggestion by sentence.

Returns:

the hotkey of reduce suggestion by sentence

setReduceSentence

public void setReduceSentence(java.lang.String reduceSentence)

Set the hotkey of reduce suggestion by sentence.

Parameters:

reduceSentence - the hotkey of reduce suggestion by sentence

getExtendParagraph

public java.lang.String getExtendParagraph()

Get the hotkey of extend suggestion by paragraph.

Returns:

the hotkey of extend suggestion by paragraph

setExtendParagraph

public void setExtendParagraph(java.lang.String extendParagraph)

Set the hotkey of extend suggestion by paragraph.

Parameters:

extendParagraph - the hotkey of extend suggestion by paragraph

getReduceParagraph

public java.lang.String getReduceParagraph()

Get the hotkey of reduce suggestion by paragraph.

Returns:

the hotkey of reduce suggestion by paragraph

setReduceParagraph

public void setReduceParagraph(java.lang.String reduceParagraph)

Set the hotkey of reduce suggestion by paragraph.

Parameters:

reduceParagraph - the hotkey of reduce suggestion by paragraph

getDelayTrigger

public int getDelayTrigger()

Get the delay(in ms) to trigger the suggestion popup.

Returns:

the delay to trigger suggestion popup

setDelayTrigger

public void setDelayTrigger(int triggerDelay)

Set the delay(in ms) to trigger the suggestion popup.

Parameters:

triggerDelay - the delay to trigger suggestion popup

equals

public boolean equals(java.lang.Object obj)

Return true if, and only if the object argument has the same attribute values with this preference object.

Overrides:

equals in class java.lang.Object

Returns:

the result of this operation.