public class RapidSpellWebLauncherBean
extends java.lang.Object
Typical usage in a servlet would be:
try{
PrintWriter pW = response.getWriter();
pW.println("<html><body><form name='f1'><textarea name='n1' cols=50 rows=5></textarea>");
//Add RapidSpellWebLauncher to page
RapidSpellWebLauncherBean launcher = new RapidSpellWebLauncherBean();
launcher.setTextComponentName("f1.n1");
launcher.setRapidSpellWebPage("/rsuser/RSWebPopUp");
launcher.writeHtml(pW, request);
pW.println("</form></body></html>");
} catch (IOException e){
}
Constructor and Description |
---|
RapidSpellWebLauncherBean() |
Modifier and Type | Method and Description |
---|---|
boolean |
getAllowAnyCase()
Whether to allow words spelt with incorrect case, eg.
|
boolean |
getAllowMixedCase()
Whether to allow words spelt with mixed case, eg.
|
java.lang.String |
getButtonImageMouseDown() |
java.lang.String |
getButtonImageMouseOut() |
java.lang.String |
getButtonImageMouseOver() |
java.lang.String |
getButtonOnMouseOut()
The onMouseOut of the button.
|
java.lang.String |
getButtonOnMouseOver()
The onMouseOver of the button.
|
java.lang.String |
getButtonStyle()
The style of the button.
|
java.lang.String |
getButtonStyleClass()
The style class of the button.
|
java.lang.String |
getButtonText()
The text on the button.
|
java.lang.String |
getCallBack()
The callBack URL or text box name.
|
boolean |
getCheckCompoundWords()
Whether to check if words are made of compound forms - to be used in languages which use compounds, such as German.
|
int |
getConsiderationRange()
The size factor for words to consider for suggestions,
lower values are faster but consider less words for suggestions.
|
boolean |
getCreatePopUpWindow()
Whether this component should create a pop-up window for the spell checker.
|
java.lang.String |
getDictFile()
(Optional) main dictionary (.dict) file on the server.
|
boolean |
getEnableUndo()
Whether to provide undo functionality.
|
java.lang.String |
getFinishedListener()
The name of a JavaScript function (without brackets) that should be called when pop up spell checking is finished (optional).
|
int |
getGuiLanguage()
The Gui Language.
|
java.lang.String |
getId()
The 'id' of this tag, this should be set to differentiate between tags when more than one is present on a page.
|
boolean |
getIgnoreCapitalizedWords()
Whether to ignore words with capital letters.
|
boolean |
getIgnoreWordsWithDigits()
Whether to ignore words with digits in them.
|
boolean |
getIgnoreXML()
Whether to ignore XML/HTML tags, false by default.
|
boolean |
getIncludeUserDictionaryInSuggestions()
Whether the user dictionary should be used in finding suggestions for misspelt words.
|
int |
getLanguageParser()
The type of language parsing to use.
|
boolean |
getLeaveWindowOpenForUndo()
Whether to leave the popup window open after the last error has been found, enabling the user to undo the final error.
|
boolean |
getLookIntoHyphenatedText()
Whether to 'look into' text with hyphens (-), if the word has hyphens in it and
LookIntoHyphenatedText is set true (default), the parts of the text around the hyphens will be checked individually.
|
boolean |
getModal()
Whether the popup will be modal.
|
java.lang.String |
getModalHelperPage()
The URL of the RapidSpellModalHelper.html page, used when modal=true
|
java.lang.String |
getMode()
The mode to use RapidSpell Web in, can be "popup" or "separate".
|
java.lang.String |
getPopUpWindowName()
If this component doesn't create a pop-up window for the spell checker (and is in popup mode) this specifies the name of an existing window to put the spell checker in.
|
java.lang.String |
getRapidSpellWebPage()
The URL of the page holding the RapidSpellWeb control.
|
java.lang.String |
getRSMultipleID()
The ID property of the RapidSpellWebMultiple (if used)
|
boolean |
getSeparateHyphenWords()
Whether to treat hyphenated (-) words as separate words, default is false.
|
boolean |
getShowButton()
Whether to show the button.
|
boolean |
getShowFinishedMessage()
Whether to show the popup dialog at the end of the spell check.
|
boolean |
getShowNoErrorsMessage()
Whether to show the popup dialog if there were no errors in the text.
|
boolean |
getShowXMLTags()
Whether to show XML/HTML tags in the preview window, false by default.
|
boolean |
getSSLFriendly()
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.
|
java.lang.String |
getSuggestionsMethod()
Suggestions method to use.
|
int |
getTabIndex()
The tab order of the control.
|
java.lang.String |
getTextComponentInterface()
The text box interface to be used.
|
java.lang.String |
getTextComponentName()
The form and name of the text component to be checked on the form.
|
java.lang.String |
getUserDictionaryFile()
The user dictionary file on the server for the user.
|
boolean |
getWarnDuplicates()
Whether to treat duplicate words as errors (eg.
|
int |
getWindowHeight()
Sets the window height (in pixels), when used in Mode=popup.
|
int |
getWindowWidth()
Sets the window width (in pixels), when used in Mode=popup.
|
int |
getWindowX()
Sets the window X position (in pixels), when used in Mode=popup (set to -1 to not specify).
|
int |
getWindowY()
Sets the window Y position (in pixels), when used in Mode=popup (set to -1 to not specify).
|
boolean |
isIgnoreURLsAndEmailAddresses() |
boolean |
isV2Parser() |
void |
setAllowAnyCase(boolean value)
Whether to allow words spelt with incorrect case, eg.
|
void |
setAllowMixedCase(boolean value)
Whether to allow words spelt with mixed case, eg.
|
void |
setButtonImageMouseDown(java.lang.String value) |
void |
setButtonImageMouseOut(java.lang.String value) |
void |
setButtonImageMouseOver(java.lang.String value) |
void |
setButtonOnMouseOut(java.lang.String value)
The onMouseOut of the button.
|
void |
setButtonOnMouseOver(java.lang.String value)
The onMouseOver of the button.
|
void |
setButtonStyle(java.lang.String value)
The style of the button.
|
void |
setButtonStyleClass(java.lang.String value)
The style class of the button.
|
void |
setButtonText(java.lang.String value)
The text on the button.
|
void |
setCallBack(java.lang.String value)
The callBack URL or text box name.
|
void |
setCheckCompoundWords(boolean value)
Whether to check if words are made of compound forms - to be used in languages which use compounds, such as German.
|
void |
setConsiderationRange(int value)
The size factor for words to consider for suggestions,
lower values are faster but consider less words for suggestions.
|
void |
setCreatePopUpWindow(boolean value)
Whether this component should create a pop-up window for the spell checker.
|
void |
setDictFile(java.lang.String value)
(Optional) main dictionary (.dict) file on the server.
|
void |
setEnableUndo(boolean value)
Whether to provide undo functionality.
|
void |
setFinishedListener(java.lang.String value)
The name of a JavaScript function (without brackets) that should be called when pop up spell checking is finished (optional).
|
void |
setGuiLanguage(int value)
The Gui Language, value should be one of LanguageType.ENGLISH, LanguageType.FRENCH etc.
|
void |
setId(java.lang.String value)
The 'id' of this tag, this should be set to differentiate between tags when more than one is present on a page.
|
void |
setIgnoreCapitalizedWords(boolean value)
Whether to ignore words with capital letters.
|
void |
setIgnoreURLsAndEmailAddresses(boolean ignoreURLsAndEmailAddresses) |
void |
setIgnoreWordsWithDigits(boolean value)
Whether to ignore words with digits in them.
|
void |
setIgnoreXML(boolean value)
Whether to ignore XML/HTML tags, false by default.
|
void |
setIncludeUserDictionaryInSuggestions(boolean value)
Whether the user dictionary should be used in finding suggestions for misspelt words.
|
void |
setLanguageParser(int value)
The type of language parsing to use.
|
void |
setLeaveWindowOpenForUndo(boolean value)
Whether to leave the popup window open after the last error has been found, enabling the user to undo the final error.
|
void |
setLookIntoHyphenatedText(boolean value)
Whether to 'look into' text with hyphens (-), if the word has hyphens in it and
LookIntoHyphenatedText is set true (default), the parts of the text around the hyphens will be checked individually.
|
void |
setModal(boolean value)
Whether the popup will be modal.
|
void |
setModalHelperPage(java.lang.String helperPage)
The URL of the RapidSpellModalHelper.html page, used when modal=true
|
void |
setMode(java.lang.String value)
The mode to use RapidSpell Web in, can be "popup" or "separate".
|
void |
setPopUpWindowName(java.lang.String value)
If this component doesn't create a pop-up window for the spell checker (and is in popup mode) this specifies the name of an existing window to put the spell checker in.
|
void |
setRapidSpellWebPage(java.lang.String value)
The URL of the page holding the RapidSpellWeb control.
|
void |
setRSMultipleID(java.lang.String value)
The ID property of the RapidSpellWebMultiple (if used)
|
void |
setSeparateHyphenWords(boolean value)
Whether to treat hyphenated (-) words as separate words, default is false.
|
void |
setShowButton(boolean value)
Whether to show the button.
|
void |
setShowFinishedMessage(boolean value)
Whether to show the popup dialog at the end of the spell check.
|
void |
setShowNoErrorsMessage(boolean value)
Whether to show the popup dialog if there were no errors in the text.
|
void |
setShowXMLTags(boolean value)
Whether to show XML/HTML tags in the preview window, false by default.
|
void |
setSSLFriendly(boolean value)
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.
|
void |
setSuggestionsMethod(java.lang.String value)
Suggestions method to use.
|
void |
setTabIndex(int value)
The tab order of the control.
|
void |
setTextComponentInterface(java.lang.String value)
The text box interface to be used.
|
void |
setTextComponentName(java.lang.String value)
The form and name of the text component to be checked on the form.
|
void |
setUserDictionaryFile(java.lang.String value)
The user dictionary file on the server for the user.
|
void |
setV2Parser(boolean v2Parser) |
void |
setWarnDuplicates(boolean value)
Whether to treat duplicate words as errors (eg.
|
void |
setWindowHeight(int value)
Sets the window height (in pixels), when used in Mode=popup.
|
void |
setWindowWidth(int value)
Sets the window width (in pixels), when used in Mode=popup.
|
void |
setWindowX(int value)
Sets the window X position (in pixels), when used in Mode=popup (set to -1 to not specify).
|
void |
setWindowY(int value)
Sets the window Y position (in pixels), when used in Mode=popup (set to -1 to not specify).
|
void |
writeHtml(java.io.Writer output,
javax.servlet.http.HttpServletRequest request)
Write the HTML/Javascript for the control to 'output'.
|
public boolean getCheckCompoundWords()
public void setCheckCompoundWords(boolean value)
public boolean isIgnoreURLsAndEmailAddresses()
public void setIgnoreURLsAndEmailAddresses(boolean ignoreURLsAndEmailAddresses)
public boolean isV2Parser()
public void setV2Parser(boolean v2Parser)
public java.lang.String getId()
public void setId(java.lang.String value)
public boolean getAllowMixedCase()
public void setAllowMixedCase(boolean value)
public boolean getWarnDuplicates()
public void setWarnDuplicates(boolean value)
public boolean getLeaveWindowOpenForUndo()
public void setLeaveWindowOpenForUndo(boolean value)
public java.lang.String getModalHelperPage()
public void setModalHelperPage(java.lang.String helperPage)
helperPage
- The _modalHelperPage to set.public boolean getEnableUndo()
public void setEnableUndo(boolean value)
public boolean getAllowAnyCase()
public void setAllowAnyCase(boolean value)
public java.lang.String getRSMultipleID()
public void setRSMultipleID(java.lang.String value)
public boolean getShowButton()
public void setShowButton(boolean value)
public java.lang.String getButtonImageMouseOut()
public void setButtonImageMouseOut(java.lang.String value)
public java.lang.String getButtonImageMouseOver()
public void setButtonImageMouseOver(java.lang.String value)
public java.lang.String getButtonImageMouseDown()
public void setButtonImageMouseDown(java.lang.String value)
public java.lang.String getTextComponentInterface()
Use 'Automatic' for most textboxes (rich or plain). Use 'Standard' for regular HTML text boxes (input type='text' and textarea). Use 'HTMLTextBox' for rich HTML text boxes. Use 'Custom' to define your own interface.
public void setTextComponentInterface(java.lang.String value)
Use 'Automatic' for most textboxes (rich or plain). Use 'Standard' for regular HTML text boxes (input type='text' and textarea). Use 'HTMLTextBox' for rich HTML text boxes. Use 'Custom' to define your own interface.
public boolean getLookIntoHyphenatedText()
public void setLookIntoHyphenatedText(boolean value)
public java.lang.String getSuggestionsMethod()
public void setSuggestionsMethod(java.lang.String value)
public boolean getSeparateHyphenWords()
For eg. if this is true text like "cheap-deals" will be treated as two words "cheap" and "deals", otherwise this will be treated as one word "cheap-deals".
public void setSeparateHyphenWords(boolean value)
For eg. if this is true text like "cheap-deals" will be treated as two words "cheap" and "deals", otherwise this will be treated as one word "cheap-deals".
public boolean getSSLFriendly()
Requires a file called 'blank.html' in the same folder as the RapidSpellWeLauncher page.
public void setSSLFriendly(boolean value)
Requires a file called 'blank.html' in the same folder as the RapidSpellWeLauncher page.
public boolean getModal()
RapidSpellModalHelper.html (from the distribution demo folder) must be copied to the folder containing the page that uses this control.
public void setModal(boolean value)
RapidSpellModalHelper.html (from the distribution demo folder) must be copied to the folder containing the page that uses this control.
public boolean getIncludeUserDictionaryInSuggestions()
public void setIncludeUserDictionaryInSuggestions(boolean value)
public boolean getIgnoreCapitalizedWords()
public void setIgnoreCapitalizedWords(boolean value)
public boolean getIgnoreXML()
This identifies XML tags as anything in between < and > characters, there for it will cause undesirable effects in text such as "the sign for less than is < and the sign for greater than is >". Of course in HTML that should have been written as "the sign for less than is < and the sign for greater than is >" anyway, which would be fine.
public void setIgnoreXML(boolean value)
This identifies XML tags as anything in between < and > characters, there for it will cause undesirable effects in text such as "the sign for less than is < and the sign for greater than is >". Of course in HTML that should have been written as "the sign for less than is < and the sign for greater than is >" anyway, which would be fine.
public int getConsiderationRange()
public void setConsiderationRange(int value)
public int getTabIndex()
public void setTabIndex(int value)
public boolean getIgnoreWordsWithDigits()
public void setIgnoreWordsWithDigits(boolean value)
public void setMode(java.lang.String value)
popup - opens a new window with the URL in RapidSpellWebPage property, and sets the spell checker to popup mode.
separate - opens a new page in the same window with the URL in RapidSpellWebPage property, and sets the spell checker to separate mode.
public java.lang.String getMode()
popup - opens a new window with the URL in RapidSpellWebPage property, and sets the spell checker to popup mode.
separate - opens a new page in the same window with the URL in RapidSpellWebPage property, and sets the spell checker to separate mode.
public java.lang.String getUserDictionaryFile()
This should be an absolute path.
public void setUserDictionaryFile(java.lang.String value)
This should be an absolute path.
public int getWindowWidth()
public void setWindowWidth(int value)
public int getWindowHeight()
public void setWindowHeight(int value)
public int getWindowX()
public void setWindowX(int value)
public int getWindowY()
public void setWindowY(int value)
public java.lang.String getRapidSpellWebPage()
public void setRapidSpellWebPage(java.lang.String value)
public java.lang.String getButtonText()
public void setButtonText(java.lang.String value)
public java.lang.String getButtonStyle()
public void setButtonStyle(java.lang.String value)
public java.lang.String getButtonStyleClass()
public void setButtonStyleClass(java.lang.String value)
public java.lang.String getButtonOnMouseOver()
public void setButtonOnMouseOver(java.lang.String value)
public java.lang.String getButtonOnMouseOut()
public void setButtonOnMouseOut(java.lang.String value)
public java.lang.String getCallBack()
This property has been deprecated for "popup" mode.
If Mode=="separate" then this should be set to the URL of the page to send the form parameter "CorrectedText" to, this can of course be the original page.
public void setCallBack(java.lang.String value)
This property has been deprecated for "popup" mode.
If Mode=="separate" then this should be set to the URL of the page to send the form parameter "CorrectedText" to, this can of course be the original page.
public java.lang.String getTextComponentName()
This should be set to the form element name in the main window, using Javascript notation, relative to the document, e.g; myFormName.textAreaName
public void setTextComponentName(java.lang.String value)
This should be set to the form element name in the main window, using Javascript notation, relative to the document, e.g; myFormName.textAreaName
public java.lang.String getFinishedListener()
This is optional, and of use if you require client side (or indirectly server side) notification that the spell check has finished. The function named here will be called when the pop up spell check is finished by the user (or the window was closed), it must not have any arguments.
public void setFinishedListener(java.lang.String value)
This is optional, and of use if you require client side (or indirectly server side) notification that the spell check has finished. The function named here will be called when the pop up spell check is finished by the user (or the window was closed), it must not have any arguments.
public java.lang.String getDictFile()
public void setDictFile(java.lang.String value)
public boolean getCreatePopUpWindow()
public void setCreatePopUpWindow(boolean value)
public java.lang.String getPopUpWindowName()
public void setPopUpWindowName(java.lang.String value)
public boolean getShowFinishedMessage()
public void setShowFinishedMessage(boolean value)
public boolean getShowNoErrorsMessage()
public void setShowNoErrorsMessage(boolean value)
public int getGuiLanguage()
LanguageType
public void setGuiLanguage(int value)
LanguageType
public int getLanguageParser()
Eg. If the dictionary is set to French, you should use the French parser.
LanguageType
public void setLanguageParser(int value)
Eg. If the dictionary is set to French, you should use the French parser.
LanguageType
public boolean getShowXMLTags()
If this is false then any tags present in text will modify preview, this can be important with Iframe editors, causing the preview to look like the original text, however this may cause problems if script tags are present.
public void setShowXMLTags(boolean value)
If this is false then any tags present in text will modify preview, this can be important with Iframe editors, causing the preview to look like the original text, however this may cause problems if script tags are present.
public void writeHtml(java.io.Writer output, javax.servlet.http.HttpServletRequest request) throws java.io.IOException
java.io.IOException
Copyright © 2002-2016 Keyoti Inc. All Rights Reserved.