public class RapidSpellWebBean
extends java.lang.Object
Typical usage in a servlet would be;
try{
PrintWriter pW = response.getWriter();
pW.println("<html><body><center>");
//Add RapidSpellWeb to page
RapidSpellWebBean checker = new RapidSpellWebBean();
checker.writeHtml(pW, request);
pW.println("</center></body></html>");
} catch (IOException e){
.....
}
Constructor and Description |
---|
RapidSpellWebBean() |
Modifier and Type | Method and Description |
---|---|
void |
addLicenseKey(java.lang.String value)
Adds alternative license keys.
|
static void |
addWord(javax.servlet.ServletContext pageContext,
java.lang.String word,
boolean userDictSetFromRequest,
java.lang.String userDictionaryFile,
java.lang.Boolean legacyUserDictionaryEnabled,
ICheckerEngine rapidSpellChecker) |
void |
freeResources()
Sets the core spell checker engine to null, this should only be called after checking is writeHtml.
|
java.lang.String |
getAddButtonOnMouseOut()
The onMouseOut of the add button.
|
java.lang.String |
getAddButtonOnMouseOver()
The onMouseOver of the add button.
|
java.lang.String |
getAddButtonStyle()
The add button style.
|
java.lang.String |
getAddButtonStyleClass()
The add button style.
|
java.lang.String |
getAddButtonText()
The add button text.
|
java.lang.String |
getAssumedApplicationEncoding()
The encoding that RapidSpell will assume the application is configured to use.
|
java.lang.String |
getBadWordHighlightStyle()
The 'bad word' highlight style.
|
java.lang.String |
getChangeAllButtonOnMouseOut()
The onMouseOut of the change all button.
|
java.lang.String |
getChangeAllButtonOnMouseOver()
The onMouseOver of the change all button.
|
java.lang.String |
getChangeAllButtonStyle()
The change all button style.
|
java.lang.String |
getChangeAllButtonStyleClass()
The change All button style.
|
java.lang.String |
getChangeAllButtonText()
The change all button text.
|
java.lang.String |
getChangeButtonOnMouseOut()
The onMouseOut of the change button.
|
java.lang.String |
getChangeButtonOnMouseOver()
The onMouseOver of the change button.
|
java.lang.String |
getChangeButtonStyle()
The change button style.
|
java.lang.String |
getChangeButtonStyleClass()
The change button style.
|
java.lang.String |
getChangeButtonText()
The change button text.
|
java.lang.String |
getChangeToBoxStyle()
The text box style where the 'change to' word is displayed.
|
java.lang.String |
getChangeToBoxStyleClass()
The text box style class where the 'change to' word is displayed.
|
java.lang.String |
getChangeToLabel()
The 'change to' text box label
|
java.lang.String |
getChangeToLabelStyle()
The 'change to' text box label style
|
java.lang.String |
getChangeToLabelStyleClass()
The 'change to' text box label style
|
ICheckerEngine |
getCheckerEngine()
The ICheckerEngine object to be used to check the text.
|
java.lang.String |
getFinishButtonOnMouseOut()
The onMouseOut of the finish button.
|
java.lang.String |
getFinishButtonOnMouseOver()
The onMouseOver of the finish button.
|
java.lang.String |
getFinishButtonStyle()
The finish button style.
|
java.lang.String |
getFinishButtonStyleClass()
The Finish button style.
|
java.lang.String |
getFinishButtonText()
The finish button text.
|
java.lang.String |
getFinishedText()
The alert text shown when the spell check finishes.
|
boolean |
getFireFinishedEventBeforeClose()
Whether to fire the finished event before the window closes
|
boolean |
getGlobalChangeAll()
Whether change all operations should be global.
|
boolean |
getGlobalIgnoreAll()
Whether ignore all operations should be global.
|
java.lang.String |
getIgnoreAllButtonOnMouseOut()
The onMouseOut of the ignoreAll button.
|
java.lang.String |
getIgnoreAllButtonOnMouseOver()
The onMouseOver of the ignoreAll button.
|
java.lang.String |
getIgnoreAllButtonStyle()
The ignore all button style.
|
java.lang.String |
getIgnoreAllButtonStyleClass()
The Ignore all button style.
|
java.lang.String |
getIgnoreAllButtonText()
The ignore all button text.
|
java.lang.String |
getIgnoreButtonOnMouseOut()
The onMouseOut of the ignore button.
|
java.lang.String |
getIgnoreButtonOnMouseOver()
The onMouseOver of the ignore button.
|
java.lang.String |
getIgnoreButtonStyle()
The ignore button style.
|
java.lang.String |
getIgnoreButtonStyleClass()
The Ignore button style.
|
java.lang.String |
getIgnoreButtonText()
The ignore button text.
|
java.lang.String |
getLayout()
The Html layout template, use this to customise layout, using the following layout identifiers;
<PreviewPane/>
<IgnoreButton/>
<IgnoreAllButton/>
<ChangeButton/>
<ChangeAllButton/>
<UndoButton/>
<FinishButton/>
<ChangeToLabel/>
<ChangeToBox/>
<SuggestionsLabel/>
<SuggestionsBox/>
<AddButton/>
These MUST be on lines by themselves, with no other characters.
|
boolean |
getLegacyUserDictionaryModeEnabled()
Whether to run in legacy user dictionary mode, note this is not advised due to a scripting injection vulnerability
|
java.lang.String |
getLicenseKey()
The license key.
|
java.lang.String |
getNoErrorsText()
The alert text shown when the spell check finishes with no spelling errors found.
|
java.lang.String |
getOptionsButtonOnMouseOut()
The onMouseOut of the options button.
|
java.lang.String |
getOptionsButtonOnMouseOver()
The onMouseOver of the options button.
|
java.lang.String |
getOptionsButtonStyle()
The options button style.
|
java.lang.String |
getOptionsButtonStyleClass()
The options button style.
|
java.lang.String |
getOptionsButtonText()
The options button text.
|
java.lang.String |
getPageAttribute(java.lang.String name)
Better simulates .NET Page.Request.Form.Get behaviour
|
java.lang.String |
getPreviewPaneCSSLinkURL()
The URL of the stylesheet to use in the preview pane.
|
int |
getPreviewPaneHeight()
The 'preview pane' height, this defines the height of the inner frame that shows the document preview during spell checking.
|
java.lang.String |
getPreviewPaneStyle()
The 'preview pane' style, this defines the style of the inner frame that shows the document preview during spell checking.
|
int |
getPreviewPaneWidth()
The 'preview pane' width, this defines the width of the inner frame that shows the document preview during spell checking.
|
static java.lang.String |
getRequestParameter(java.lang.String name,
javax.servlet.ServletRequest r,
java.lang.String assumedAppEncoding)
Reads a request param.
|
int |
getScriptFilterLevel()
Level of filtration.
|
boolean |
getSSLFriendly()
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.
|
java.lang.String |
getSuggestionsBoxStyle()
The selection box style where the suggestions are displayed.
|
java.lang.String |
getSuggestionsBoxStyleClass()
The selection box style where the suggestions are displayed.
|
java.lang.String |
getSuggestionsLabel()
The 'suggestions' box label
|
java.lang.String |
getSuggestionsLabelStyle()
The 'suggestions' box label style
|
java.lang.String |
getSuggestionsLabelStyleClass()
The 'change to' text box label style
|
java.lang.String |
getUndoButtonOnMouseOut()
The onMouseOut of the undo button.
|
java.lang.String |
getUndoButtonOnMouseOver()
The onMouseOver of the undo button.
|
java.lang.String |
getUndoButtonStyle()
The undo button style.
|
java.lang.String |
getUndoButtonStyleClass()
The undo button style.
|
java.lang.String |
getUndoButtonText()
The undo button text.
|
UserDictionary |
getUserDictionary()
A UserDictionary object to be used as a user dictionary.
|
java.lang.String |
getUserDictionaryFile()
A path to the file to be used as a user dictionary.
|
static boolean |
isUserDictionaryFileAllowed(java.io.File uFile,
java.util.ArrayList userDictionaryLockDownDirs,
javax.servlet.ServletContext servletContext) |
static java.lang.String |
makeRealPath(javax.servlet.ServletContext context,
java.lang.String path) |
static java.util.ArrayList |
readUserDictionaryLockDownDirs(javax.servlet.ServletContext context) |
void |
setAddButtonOnMouseOut(java.lang.String value)
The onMouseOut of the add button.
|
void |
setAddButtonOnMouseOver(java.lang.String value)
The onMouseOver of the add button.
|
void |
setAddButtonStyle(java.lang.String value)
The add button style.
|
void |
setAddButtonStyleClass(java.lang.String value)
The add button style.
|
void |
setAddButtonText(java.lang.String value)
The add button text.
|
void |
setAssumedApplicationEncoding(java.lang.String value)
The encoding that RapidSpell will assume the application is configured to use.
|
void |
setBadWordHighlightStyle(java.lang.String value)
The 'bad word' highlight style.
|
void |
setChangeAllButtonOnMouseOut(java.lang.String value)
The onMouseOut of the change all button.
|
void |
setChangeAllButtonOnMouseOver(java.lang.String value)
The onMouseOver of the change all button.
|
void |
setChangeAllButtonStyle(java.lang.String value)
The change all button style.
|
void |
setChangeAllButtonStyleClass(java.lang.String value)
The change All button style.
|
void |
setChangeAllButtonText(java.lang.String value)
The change all button text.
|
void |
setChangeButtonOnMouseOut(java.lang.String value)
The onMouseOut of the change button.
|
void |
setChangeButtonOnMouseOver(java.lang.String value)
The onMouseOver of the change button.
|
void |
setChangeButtonStyle(java.lang.String value)
The change button style.
|
void |
setChangeButtonStyleClass(java.lang.String value)
The change button style.
|
void |
setChangeButtonText(java.lang.String value)
The change button text.
|
void |
setChangeToBoxStyle(java.lang.String value)
The text box style where the 'change to' word is displayed.
|
void |
setChangeToBoxStyleClass(java.lang.String value)
The text box style class where the 'change to' word is displayed.
|
void |
setChangeToLabel(java.lang.String value)
The 'change to' text box label
|
void |
setChangeToLabelStyle(java.lang.String value)
The 'change to' text box label style
|
void |
setChangeToLabelStyleClass(java.lang.String value)
The 'change to' text box label style
|
void |
setCheckerEngine(ICheckerEngine value)
The ICheckerEngine object to be used to check the text.
|
void |
setFinishButtonOnMouseOut(java.lang.String value)
The onMouseOut of the finish button.
|
void |
setFinishButtonOnMouseOver(java.lang.String value)
The onMouseOver of the finish button.
|
void |
setFinishButtonStyle(java.lang.String value)
The finish button style.
|
void |
setFinishButtonStyleClass(java.lang.String value)
The Finish button style.
|
void |
setFinishButtonText(java.lang.String value)
The finish button text.
|
void |
setFinishedText(java.lang.String value)
The alert text shown when the spell check finishes.
|
void |
setFireFinishedEventBeforeClose(boolean value)
Whether to fire the finished event before the window closes
|
void |
setGlobalChangeAll(boolean value)
Whether change all operations should be global.
|
void |
setGlobalIgnoreAll(boolean value)
Whether ignore all operations should be global.
|
void |
setIgnoreAllButtonOnMouseOut(java.lang.String value)
The onMouseOut of the ignoreAll button.
|
void |
setIgnoreAllButtonOnMouseOver(java.lang.String value)
The onMouseOver of the ignoreAll button.
|
void |
setIgnoreAllButtonStyle(java.lang.String value)
The ignore all button style.
|
void |
setIgnoreAllButtonStyleClass(java.lang.String value)
The Ignore all button style.
|
void |
setIgnoreAllButtonText(java.lang.String value)
The ignore all button text.
|
void |
setIgnoreButtonOnMouseOut(java.lang.String value)
The onMouseOut of the ignore button.
|
void |
setIgnoreButtonOnMouseOver(java.lang.String value)
The onMouseOver of the ignore button.
|
void |
setIgnoreButtonStyle(java.lang.String value)
The ignore button style.
|
void |
setIgnoreButtonStyleClass(java.lang.String value)
The Ignore button style.
|
void |
setIgnoreButtonText(java.lang.String value)
The ignore button text.
|
void |
setLayout(java.lang.String value)
The Html layout template, use this to customise layout, using the following layout identifiers;
<PreviewPane/>
<IgnoreButton/>
<IgnoreAllButton/>
<ChangeButton/>
<ChangeAllButton/>
<UndoButton/>
<FinishButton/>
<ChangeToLabel/>
<ChangeToBox/>
<SuggestionsLabel/>
<SuggestionsBox/>
<AddButton/>
These MUST be on lines by themselves, with no other characters.
|
void |
setLegacyUserDictionaryModeEnabled(boolean v)
Whether to run in legacy user dictionary mode, note this is not advised due to a scripting injection vulnerability
|
void |
setLicenseKey(java.lang.String value)
The license key.
|
void |
setNoErrorsText(java.lang.String value)
The alert text shown when the spell check finishes with no spelling errors found.
|
void |
setOptionsButtonOnMouseOut(java.lang.String value)
The onMouseOut of the options button.
|
void |
setOptionsButtonOnMouseOver(java.lang.String value)
The onMouseOver of the options button.
|
void |
setOptionsButtonStyle(java.lang.String value)
The options button style.
|
void |
setOptionsButtonStyleClass(java.lang.String value)
The options button style.
|
void |
setOptionsButtonText(java.lang.String value)
The options button text.
|
void |
setPreviewPaneCSSLinkURL(java.lang.String value)
The URL of the stylesheet to use in the preview pane.
|
void |
setPreviewPaneHeight(int value)
The 'preview pane' height, this defines the height of the inner frame that shows the document preview during spell checking.
|
void |
setPreviewPaneStyle(java.lang.String value)
The 'preview pane' style, this defines the style of the inner frame that shows the document preview during spell checking.
|
void |
setPreviewPaneWidth(int value)
The 'preview pane' width, this defines the width of the inner frame that shows the document preview during spell checking.
|
void |
setScriptFilterLevel(int value)
Level of filtration.
|
void |
setSSLFriendly(boolean value)
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.
|
void |
setSuggestionsBoxStyle(java.lang.String value)
The selection box style where the suggestions are displayed.
|
void |
setSuggestionsBoxStyleClass(java.lang.String value)
The selection box style class where the suggestions are displayed.
|
void |
setSuggestionsLabel(java.lang.String value)
The 'suggestions' box label
|
void |
setSuggestionsLabelStyle(java.lang.String value)
The 'suggestions' box label style
|
void |
setSuggestionsLabelStyleClass(java.lang.String value)
The 'change to' text box label style
|
void |
setUndoButtonOnMouseOut(java.lang.String value)
The onMouseOut of the undo button.
|
void |
setUndoButtonOnMouseOver(java.lang.String value)
The onMouseOver of the undo button.
|
void |
setUndoButtonStyle(java.lang.String value)
The undo button style.
|
void |
setUndoButtonStyleClass(java.lang.String value)
The undo button style.
|
void |
setUndoButtonText(java.lang.String value)
The undo button text.
|
void |
setUserDictionary(UserDictionary value)
A UserDictionary object to be used as a user dictionary.
|
void |
setUserDictionaryFile(java.lang.String value)
A path to the file to be used as a user dictionary.
|
void |
writeHtml(java.io.Writer output,
javax.servlet.jsp.PageContext pageContext,
javax.servlet.ServletRequest r)
Renders this to the Writer as Html.
|
void |
writeHtml(java.io.Writer output,
javax.servlet.ServletContext servletContext,
javax.servlet.ServletRequest r)
Renders this to the Writer as Html.
|
public boolean getFireFinishedEventBeforeClose()
public void setFireFinishedEventBeforeClose(boolean value)
public boolean getGlobalIgnoreAll()
public void setGlobalIgnoreAll(boolean value)
public boolean getGlobalChangeAll()
public void setGlobalChangeAll(boolean value)
public java.lang.String getLicenseKey()
public void setLicenseKey(java.lang.String value)
public void addLicenseKey(java.lang.String value)
public ICheckerEngine getCheckerEngine()
You should implement ICheckerEngine in your own class if you wish to customize parsing.
public void setCheckerEngine(ICheckerEngine value)
You should implement ICheckerEngine in your own class if you wish to customize parsing.
public boolean getLegacyUserDictionaryModeEnabled()
public void setLegacyUserDictionaryModeEnabled(boolean v)
public java.lang.String getUserDictionaryFile()
public void setUserDictionaryFile(java.lang.String value)
public UserDictionary getUserDictionary()
public void setUserDictionary(UserDictionary value)
public int getScriptFilterLevel()
public void setScriptFilterLevel(int value)
public java.lang.String getFinishedText()
public void setFinishedText(java.lang.String value)
public java.lang.String getPreviewPaneCSSLinkURL()
public void setPreviewPaneCSSLinkURL(java.lang.String value)
public java.lang.String getNoErrorsText()
public void setNoErrorsText(java.lang.String value)
public java.lang.String getChangeToBoxStyle()
public void setChangeToBoxStyle(java.lang.String value)
public java.lang.String getChangeToBoxStyleClass()
public void setChangeToBoxStyleClass(java.lang.String value)
public java.lang.String getSuggestionsBoxStyle()
public void setSuggestionsBoxStyle(java.lang.String value)
public java.lang.String getSuggestionsBoxStyleClass()
public void setSuggestionsBoxStyleClass(java.lang.String value)
public java.lang.String getUndoButtonStyle()
public void setUndoButtonStyle(java.lang.String value)
public java.lang.String getUndoButtonStyleClass()
public void setUndoButtonStyleClass(java.lang.String value)
public java.lang.String getUndoButtonText()
public void setUndoButtonText(java.lang.String value)
public java.lang.String getUndoButtonOnMouseOver()
public void setUndoButtonOnMouseOver(java.lang.String value)
public java.lang.String getUndoButtonOnMouseOut()
public void setUndoButtonOnMouseOut(java.lang.String value)
public java.lang.String getOptionsButtonStyle()
public void setOptionsButtonStyle(java.lang.String value)
public java.lang.String getOptionsButtonStyleClass()
public void setOptionsButtonStyleClass(java.lang.String value)
public java.lang.String getOptionsButtonText()
public void setOptionsButtonText(java.lang.String value)
public java.lang.String getOptionsButtonOnMouseOver()
public void setOptionsButtonOnMouseOver(java.lang.String value)
public java.lang.String getOptionsButtonOnMouseOut()
public void setOptionsButtonOnMouseOut(java.lang.String value)
public java.lang.String getAddButtonStyle()
public void setAddButtonStyle(java.lang.String value)
public java.lang.String getAddButtonStyleClass()
public void setAddButtonStyleClass(java.lang.String value)
public java.lang.String getAddButtonText()
public void setAddButtonText(java.lang.String value)
public java.lang.String getAddButtonOnMouseOver()
public void setAddButtonOnMouseOver(java.lang.String value)
public java.lang.String getAddButtonOnMouseOut()
public void setAddButtonOnMouseOut(java.lang.String value)
public java.lang.String getIgnoreButtonStyle()
public void setIgnoreButtonStyle(java.lang.String value)
public java.lang.String getIgnoreButtonStyleClass()
public void setIgnoreButtonStyleClass(java.lang.String value)
public java.lang.String getIgnoreButtonText()
public void setIgnoreButtonText(java.lang.String value)
public java.lang.String getIgnoreButtonOnMouseOver()
public void setIgnoreButtonOnMouseOver(java.lang.String value)
public java.lang.String getIgnoreButtonOnMouseOut()
public void setIgnoreButtonOnMouseOut(java.lang.String value)
public java.lang.String getIgnoreAllButtonStyle()
public void setIgnoreAllButtonStyle(java.lang.String value)
public java.lang.String getIgnoreAllButtonStyleClass()
public void setIgnoreAllButtonStyleClass(java.lang.String value)
public java.lang.String getIgnoreAllButtonText()
public void setIgnoreAllButtonText(java.lang.String value)
public java.lang.String getIgnoreAllButtonOnMouseOver()
public void setIgnoreAllButtonOnMouseOver(java.lang.String value)
public java.lang.String getIgnoreAllButtonOnMouseOut()
public void setIgnoreAllButtonOnMouseOut(java.lang.String value)
public java.lang.String getChangeButtonStyle()
public void setChangeButtonStyle(java.lang.String value)
public java.lang.String getChangeButtonStyleClass()
public void setChangeButtonStyleClass(java.lang.String value)
public java.lang.String getChangeButtonText()
public void setChangeButtonText(java.lang.String value)
public java.lang.String getChangeButtonOnMouseOver()
public void setChangeButtonOnMouseOver(java.lang.String value)
public java.lang.String getChangeButtonOnMouseOut()
public void setChangeButtonOnMouseOut(java.lang.String value)
public java.lang.String getChangeAllButtonStyle()
public void setChangeAllButtonStyle(java.lang.String value)
public java.lang.String getChangeAllButtonStyleClass()
public void setChangeAllButtonStyleClass(java.lang.String value)
public java.lang.String getChangeAllButtonText()
public void setChangeAllButtonText(java.lang.String value)
public java.lang.String getChangeAllButtonOnMouseOver()
public void setChangeAllButtonOnMouseOver(java.lang.String value)
public java.lang.String getChangeAllButtonOnMouseOut()
public void setChangeAllButtonOnMouseOut(java.lang.String value)
public java.lang.String getFinishButtonStyle()
public void setFinishButtonStyle(java.lang.String value)
public java.lang.String getFinishButtonStyleClass()
public void setFinishButtonStyleClass(java.lang.String value)
public java.lang.String getFinishButtonText()
public void setFinishButtonText(java.lang.String value)
public java.lang.String getFinishButtonOnMouseOver()
public void setFinishButtonOnMouseOver(java.lang.String value)
public java.lang.String getFinishButtonOnMouseOut()
public void setFinishButtonOnMouseOut(java.lang.String value)
public java.lang.String getChangeToLabel()
public void setChangeToLabel(java.lang.String value)
public java.lang.String getSuggestionsLabel()
public void setSuggestionsLabel(java.lang.String value)
public java.lang.String getChangeToLabelStyle()
public void setChangeToLabelStyle(java.lang.String value)
public java.lang.String getChangeToLabelStyleClass()
public void setChangeToLabelStyleClass(java.lang.String value)
public java.lang.String getSuggestionsLabelStyle()
public void setSuggestionsLabelStyle(java.lang.String value)
public java.lang.String getSuggestionsLabelStyleClass()
public void setSuggestionsLabelStyleClass(java.lang.String value)
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 java.lang.String getPreviewPaneStyle()
public void setPreviewPaneStyle(java.lang.String value)
public int getPreviewPaneWidth()
public void setPreviewPaneWidth(int value)
public int getPreviewPaneHeight()
public void setPreviewPaneHeight(int value)
public java.lang.String getBadWordHighlightStyle()
public void setBadWordHighlightStyle(java.lang.String value)
public java.lang.String getLayout()
public void setLayout(java.lang.String value)
public java.lang.String getAssumedApplicationEncoding()
public void setAssumedApplicationEncoding(java.lang.String value)
public java.lang.String getPageAttribute(java.lang.String name)
public static java.lang.String getRequestParameter(java.lang.String name, javax.servlet.ServletRequest r, java.lang.String assumedAppEncoding)
public void writeHtml(java.io.Writer output, javax.servlet.jsp.PageContext pageContext, javax.servlet.ServletRequest r) throws java.io.IOException
java.io.IOException
public void writeHtml(java.io.Writer output, javax.servlet.ServletContext servletContext, javax.servlet.ServletRequest r) throws java.io.IOException
java.io.IOException
public static java.lang.String makeRealPath(javax.servlet.ServletContext context, java.lang.String path)
public static java.util.ArrayList readUserDictionaryLockDownDirs(javax.servlet.ServletContext context)
public static boolean isUserDictionaryFileAllowed(java.io.File uFile, java.util.ArrayList userDictionaryLockDownDirs, javax.servlet.ServletContext servletContext)
public static void addWord(javax.servlet.ServletContext pageContext, java.lang.String word, boolean userDictSetFromRequest, java.lang.String userDictionaryFile, java.lang.Boolean legacyUserDictionaryEnabled, ICheckerEngine rapidSpellChecker)
public void freeResources()
Copyright © 2002-2016 Keyoti Inc. All Rights Reserved.