RapidSpell Web


com.keyoti.rapidSpell.web
Class RapidSpellWebBean

java.lang.Object
  extended by com.keyoti.rapidSpell.web.RapidSpellWebBean

public class RapidSpellWebBean
extends java.lang.Object

RapidSpell Web Bean, returns html for the actual spell checker, this is useful for Servlets.

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 Summary
RapidSpellWebBean()
           
 
Method Summary
 void addLicenseKey(java.lang.String value)
          Adds alternative license keys.
 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 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 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 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 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RapidSpellWebBean

public RapidSpellWebBean()
Method Detail

getGlobalIgnoreAll

public boolean getGlobalIgnoreAll()
Whether ignore all operations should be global.


setGlobalIgnoreAll

public void setGlobalIgnoreAll(boolean value)
Whether ignore all operations should be global.


getGlobalChangeAll

public boolean getGlobalChangeAll()
Whether change all operations should be global.


setGlobalChangeAll

public void setGlobalChangeAll(boolean value)
Whether change all operations should be global.


getLicenseKey

public java.lang.String getLicenseKey()
The license key.


setLicenseKey

public void setLicenseKey(java.lang.String value)
The license key.


addLicenseKey

public void addLicenseKey(java.lang.String value)
Adds alternative license keys.


getCheckerEngine

public ICheckerEngine getCheckerEngine()
The ICheckerEngine object to be used to check the text.

You should implement ICheckerEngine in your own class if you wish to customize parsing.


setCheckerEngine

public void setCheckerEngine(ICheckerEngine value)
The ICheckerEngine object to be used to check the text.

You should implement ICheckerEngine in your own class if you wish to customize parsing.


getLegacyUserDictionaryModeEnabled

public boolean getLegacyUserDictionaryModeEnabled()
Whether to run in legacy user dictionary mode, note this is not advised due to a scripting injection vulnerability


setLegacyUserDictionaryModeEnabled

public void setLegacyUserDictionaryModeEnabled(boolean v)
Whether to run in legacy user dictionary mode, note this is not advised due to a scripting injection vulnerability


getUserDictionaryFile

public java.lang.String getUserDictionaryFile()
A path to the file to be used as a user dictionary.


setUserDictionaryFile

public void setUserDictionaryFile(java.lang.String value)
A path to the file to be used as a user dictionary.


getUserDictionary

public UserDictionary getUserDictionary()
A UserDictionary object to be used as a user dictionary.


setUserDictionary

public void setUserDictionary(UserDictionary value)
A UserDictionary object to be used as a user dictionary.


getScriptFilterLevel

public int getScriptFilterLevel()
Level of filtration. Levels; 0=remove nothing 15=remove all 1=remove script blocks 2=remove event handlers 4=remove javascript: urls 8=remove behaviours ">PUBLIC:XXX<" Combinations can be formed by adding options, eg; 3=1 & 2 (remove script blocks & remove event handlers) 5=1 & 4 (remove script blocks & remove javascript: urls) 7=1 & 2 & 4 (remove script blocks & remove event handlers & remove javascript: urls)


setScriptFilterLevel

public void setScriptFilterLevel(int value)
Level of filtration. Levels; 0=remove nothing 15=remove all 1=remove script blocks 2=remove event handlers 4=remove javascript: urls 8=remove behaviours ">PUBLIC:XXX<" Combinations can be formed by adding options, eg; 3=1 & 2 (remove script blocks & remove event handlers) 5=1 & 4 (remove script blocks & remove javascript: urls) 7=1 & 2 & 4 (remove script blocks & remove event handlers & remove javascript: urls)


getFinishedText

public java.lang.String getFinishedText()
The alert text shown when the spell check finishes.


setFinishedText

public void setFinishedText(java.lang.String value)
The alert text shown when the spell check finishes.


getPreviewPaneCSSLinkURL

public java.lang.String getPreviewPaneCSSLinkURL()
The URL of the stylesheet to use in the preview pane.


setPreviewPaneCSSLinkURL

public void setPreviewPaneCSSLinkURL(java.lang.String value)
The URL of the stylesheet to use in the preview pane.


getNoErrorsText

public java.lang.String getNoErrorsText()
The alert text shown when the spell check finishes with no spelling errors found.


setNoErrorsText

public void setNoErrorsText(java.lang.String value)
The alert text shown when the spell check finishes with no spelling errors found.


getChangeToBoxStyle

public java.lang.String getChangeToBoxStyle()
The text box style where the 'change to' word is displayed.


setChangeToBoxStyle

public void setChangeToBoxStyle(java.lang.String value)
The text box style where the 'change to' word is displayed.


getChangeToBoxStyleClass

public java.lang.String getChangeToBoxStyleClass()
The text box style class where the 'change to' word is displayed.


setChangeToBoxStyleClass

public void setChangeToBoxStyleClass(java.lang.String value)
The text box style class where the 'change to' word is displayed.


getSuggestionsBoxStyle

public java.lang.String getSuggestionsBoxStyle()
The selection box style where the suggestions are displayed.


setSuggestionsBoxStyle

public void setSuggestionsBoxStyle(java.lang.String value)
The selection box style where the suggestions are displayed.


getSuggestionsBoxStyleClass

public java.lang.String getSuggestionsBoxStyleClass()
The selection box style where the suggestions are displayed.


setSuggestionsBoxStyleClass

public void setSuggestionsBoxStyleClass(java.lang.String value)
The selection box style class where the suggestions are displayed.


getUndoButtonStyle

public java.lang.String getUndoButtonStyle()
The undo button style.


setUndoButtonStyle

public void setUndoButtonStyle(java.lang.String value)
The undo button style.


getUndoButtonStyleClass

public java.lang.String getUndoButtonStyleClass()
The undo button style.


setUndoButtonStyleClass

public void setUndoButtonStyleClass(java.lang.String value)
The undo button style.


getUndoButtonText

public java.lang.String getUndoButtonText()
The undo button text.


setUndoButtonText

public void setUndoButtonText(java.lang.String value)
The undo button text.


getUndoButtonOnMouseOver

public java.lang.String getUndoButtonOnMouseOver()
The onMouseOver of the undo button.


setUndoButtonOnMouseOver

public void setUndoButtonOnMouseOver(java.lang.String value)
The onMouseOver of the undo button.


getUndoButtonOnMouseOut

public java.lang.String getUndoButtonOnMouseOut()
The onMouseOut of the undo button.


setUndoButtonOnMouseOut

public void setUndoButtonOnMouseOut(java.lang.String value)
The onMouseOut of the undo button.


getAddButtonStyle

public java.lang.String getAddButtonStyle()
The add button style.


setAddButtonStyle

public void setAddButtonStyle(java.lang.String value)
The add button style.


getAddButtonStyleClass

public java.lang.String getAddButtonStyleClass()
The add button style.


setAddButtonStyleClass

public void setAddButtonStyleClass(java.lang.String value)
The add button style.


getAddButtonText

public java.lang.String getAddButtonText()
The add button text.


setAddButtonText

public void setAddButtonText(java.lang.String value)
The add button text.


getAddButtonOnMouseOver

public java.lang.String getAddButtonOnMouseOver()
The onMouseOver of the add button.


setAddButtonOnMouseOver

public void setAddButtonOnMouseOver(java.lang.String value)
The onMouseOver of the add button.


getAddButtonOnMouseOut

public java.lang.String getAddButtonOnMouseOut()
The onMouseOut of the add button.


setAddButtonOnMouseOut

public void setAddButtonOnMouseOut(java.lang.String value)
The onMouseOut of the add button.


getIgnoreButtonStyle

public java.lang.String getIgnoreButtonStyle()
The ignore button style.


setIgnoreButtonStyle

public void setIgnoreButtonStyle(java.lang.String value)
The ignore button style.


getIgnoreButtonStyleClass

public java.lang.String getIgnoreButtonStyleClass()
The Ignore button style.


setIgnoreButtonStyleClass

public void setIgnoreButtonStyleClass(java.lang.String value)
The Ignore button style.


getIgnoreButtonText

public java.lang.String getIgnoreButtonText()
The ignore button text.


setIgnoreButtonText

public void setIgnoreButtonText(java.lang.String value)
The ignore button text.


getIgnoreButtonOnMouseOver

public java.lang.String getIgnoreButtonOnMouseOver()
The onMouseOver of the ignore button.


setIgnoreButtonOnMouseOver

public void setIgnoreButtonOnMouseOver(java.lang.String value)
The onMouseOver of the ignore button.


getIgnoreButtonOnMouseOut

public java.lang.String getIgnoreButtonOnMouseOut()
The onMouseOut of the ignore button.


setIgnoreButtonOnMouseOut

public void setIgnoreButtonOnMouseOut(java.lang.String value)
The onMouseOut of the ignore button.


getIgnoreAllButtonStyle

public java.lang.String getIgnoreAllButtonStyle()
The ignore all button style.


setIgnoreAllButtonStyle

public void setIgnoreAllButtonStyle(java.lang.String value)
The ignore all button style.


getIgnoreAllButtonStyleClass

public java.lang.String getIgnoreAllButtonStyleClass()
The Ignore all button style.


setIgnoreAllButtonStyleClass

public void setIgnoreAllButtonStyleClass(java.lang.String value)
The Ignore all button style.


getIgnoreAllButtonText

public java.lang.String getIgnoreAllButtonText()
The ignore all button text.


setIgnoreAllButtonText

public void setIgnoreAllButtonText(java.lang.String value)
The ignore all button text.


getIgnoreAllButtonOnMouseOver

public java.lang.String getIgnoreAllButtonOnMouseOver()
The onMouseOver of the ignoreAll button.


setIgnoreAllButtonOnMouseOver

public void setIgnoreAllButtonOnMouseOver(java.lang.String value)
The onMouseOver of the ignoreAll button.


getIgnoreAllButtonOnMouseOut

public java.lang.String getIgnoreAllButtonOnMouseOut()
The onMouseOut of the ignoreAll button.


setIgnoreAllButtonOnMouseOut

public void setIgnoreAllButtonOnMouseOut(java.lang.String value)
The onMouseOut of the ignoreAll button.


getChangeButtonStyle

public java.lang.String getChangeButtonStyle()
The change button style.


setChangeButtonStyle

public void setChangeButtonStyle(java.lang.String value)
The change button style.


getChangeButtonStyleClass

public java.lang.String getChangeButtonStyleClass()
The change button style.


setChangeButtonStyleClass

public void setChangeButtonStyleClass(java.lang.String value)
The change button style.


getChangeButtonText

public java.lang.String getChangeButtonText()
The change button text.


setChangeButtonText

public void setChangeButtonText(java.lang.String value)
The change button text.


getChangeButtonOnMouseOver

public java.lang.String getChangeButtonOnMouseOver()
The onMouseOver of the change button.


setChangeButtonOnMouseOver

public void setChangeButtonOnMouseOver(java.lang.String value)
The onMouseOver of the change button.


getChangeButtonOnMouseOut

public java.lang.String getChangeButtonOnMouseOut()
The onMouseOut of the change button.


setChangeButtonOnMouseOut

public void setChangeButtonOnMouseOut(java.lang.String value)
The onMouseOut of the change button.


getChangeAllButtonStyle

public java.lang.String getChangeAllButtonStyle()
The change all button style.


setChangeAllButtonStyle

public void setChangeAllButtonStyle(java.lang.String value)
The change all button style.


getChangeAllButtonStyleClass

public java.lang.String getChangeAllButtonStyleClass()
The change All button style.


setChangeAllButtonStyleClass

public void setChangeAllButtonStyleClass(java.lang.String value)
The change All button style.


getChangeAllButtonText

public java.lang.String getChangeAllButtonText()
The change all button text.


setChangeAllButtonText

public void setChangeAllButtonText(java.lang.String value)
The change all button text.


getChangeAllButtonOnMouseOver

public java.lang.String getChangeAllButtonOnMouseOver()
The onMouseOver of the change all button.


setChangeAllButtonOnMouseOver

public void setChangeAllButtonOnMouseOver(java.lang.String value)
The onMouseOver of the change all button.


getChangeAllButtonOnMouseOut

public java.lang.String getChangeAllButtonOnMouseOut()
The onMouseOut of the change all button.


setChangeAllButtonOnMouseOut

public void setChangeAllButtonOnMouseOut(java.lang.String value)
The onMouseOut of the change all button.


getFinishButtonStyle

public java.lang.String getFinishButtonStyle()
The finish button style.


setFinishButtonStyle

public void setFinishButtonStyle(java.lang.String value)
The finish button style.


getFinishButtonStyleClass

public java.lang.String getFinishButtonStyleClass()
The Finish button style.


setFinishButtonStyleClass

public void setFinishButtonStyleClass(java.lang.String value)
The Finish button style.


getFinishButtonText

public java.lang.String getFinishButtonText()
The finish button text.


setFinishButtonText

public void setFinishButtonText(java.lang.String value)
The finish button text.


getFinishButtonOnMouseOver

public java.lang.String getFinishButtonOnMouseOver()
The onMouseOver of the finish button.


setFinishButtonOnMouseOver

public void setFinishButtonOnMouseOver(java.lang.String value)
The onMouseOver of the finish button.


getFinishButtonOnMouseOut

public java.lang.String getFinishButtonOnMouseOut()
The onMouseOut of the finish button.


setFinishButtonOnMouseOut

public void setFinishButtonOnMouseOut(java.lang.String value)
The onMouseOut of the finish button.


getChangeToLabel

public java.lang.String getChangeToLabel()
The 'change to' text box label


setChangeToLabel

public void setChangeToLabel(java.lang.String value)
The 'change to' text box label


getSuggestionsLabel

public java.lang.String getSuggestionsLabel()
The 'suggestions' box label


setSuggestionsLabel

public void setSuggestionsLabel(java.lang.String value)
The 'suggestions' box label


getChangeToLabelStyle

public java.lang.String getChangeToLabelStyle()
The 'change to' text box label style


setChangeToLabelStyle

public void setChangeToLabelStyle(java.lang.String value)
The 'change to' text box label style


getChangeToLabelStyleClass

public java.lang.String getChangeToLabelStyleClass()
The 'change to' text box label style


setChangeToLabelStyleClass

public void setChangeToLabelStyleClass(java.lang.String value)
The 'change to' text box label style


getSuggestionsLabelStyle

public java.lang.String getSuggestionsLabelStyle()
The 'suggestions' box label style


setSuggestionsLabelStyle

public void setSuggestionsLabelStyle(java.lang.String value)
The 'suggestions' box label style


getSuggestionsLabelStyleClass

public java.lang.String getSuggestionsLabelStyleClass()
The 'change to' text box label style


setSuggestionsLabelStyleClass

public void setSuggestionsLabelStyleClass(java.lang.String value)
The 'change to' text box label style


getSSLFriendly

public boolean getSSLFriendly()
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.

Requires a file called 'blank.html' in the same folder as the RapidSpellWeLauncher page.


setSSLFriendly

public void setSSLFriendly(boolean value)
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.

Requires a file called 'blank.html' in the same folder as the RapidSpellWeLauncher page.


getPreviewPaneStyle

public java.lang.String getPreviewPaneStyle()
The 'preview pane' style, this defines the style of the inner frame that shows the document preview during spell checking.


setPreviewPaneStyle

public 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.


getPreviewPaneWidth

public int getPreviewPaneWidth()
The 'preview pane' width, this defines the width of the inner frame that shows the document preview during spell checking.


setPreviewPaneWidth

public void setPreviewPaneWidth(int value)
The 'preview pane' width, this defines the width of the inner frame that shows the document preview during spell checking.


getPreviewPaneHeight

public int getPreviewPaneHeight()
The 'preview pane' height, this defines the height of the inner frame that shows the document preview during spell checking.


setPreviewPaneHeight

public void setPreviewPaneHeight(int value)
The 'preview pane' height, this defines the height of the inner frame that shows the document preview during spell checking.


getBadWordHighlightStyle

public java.lang.String getBadWordHighlightStyle()
The 'bad word' highlight style.


setBadWordHighlightStyle

public void setBadWordHighlightStyle(java.lang.String value)
The 'bad word' highlight style.


getLayout

public 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.


setLayout

public 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.


getAssumedApplicationEncoding

public java.lang.String getAssumedApplicationEncoding()
The encoding that RapidSpell will assume the application is configured to use. Eg. the default for some application servers is 8859-1 however we default to UTF-8.


setAssumedApplicationEncoding

public void setAssumedApplicationEncoding(java.lang.String value)
The encoding that RapidSpell will assume the application is configured to use. Eg. the default for some application servers is 8859-1, but our expectation is UTF-8.


getPageAttribute

public java.lang.String getPageAttribute(java.lang.String name)
Better simulates .NET Page.Request.Form.Get behaviour


getRequestParameter

public static java.lang.String getRequestParameter(java.lang.String name,
                                                   javax.servlet.ServletRequest r,
                                                   java.lang.String assumedAppEncoding)
Reads a request param.


writeHtml

public void writeHtml(java.io.Writer output,
                      javax.servlet.jsp.PageContext pageContext,
                      javax.servlet.ServletRequest r)
               throws java.io.IOException
Renders this to the Writer as Html.

Throws:
java.io.IOException

writeHtml

public void writeHtml(java.io.Writer output,
                      javax.servlet.ServletContext servletContext,
                      javax.servlet.ServletRequest r)
               throws java.io.IOException
Renders this to the Writer as Html.

Throws:
java.io.IOException

makeRealPath

public static java.lang.String makeRealPath(javax.servlet.ServletContext context,
                                            java.lang.String path)

readUserDictionaryLockDownDirs

public static java.util.ArrayList readUserDictionaryLockDownDirs(javax.servlet.ServletContext context)

isUserDictionaryFileAllowed

public static boolean isUserDictionaryFileAllowed(java.io.File uFile,
                                                  java.util.ArrayList userDictionaryLockDownDirs,
                                                  javax.servlet.ServletContext servletContext)

freeResources

public void freeResources()
Sets the core spell checker engine to null, this should only be called after checking is writeHtml. Doing this forces the memory used for the dictionary to be freed up. Does NOT call the Garbage Collector, use System.gc() to do this manually.


RapidSpell Web


Copyright © 2002-2013 Keyoti Inc. All Rights Reserved.