RapidSpell Web


com.keyoti.rapidSpell.web
Class RapidSpellWebMultipleBean

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

public class RapidSpellWebMultipleBean
extends java.lang.Object

RapidSpell Web Multiple Bean, returns html that shows a button which launches multiple spell checkers, useful for Servlets


Constructor Summary
RapidSpellWebMultipleBean()
          Creates a RapidSpellWebMultiple
 
Method Summary
 RSButton getButton()
          The HtmlInputButton shown to the user, when clicked the spell checker starts.
 java.lang.String getButtonImageMouseDown()
          The button image URL.
 java.lang.String getButtonImageMouseOut()
          The button image URL.
 java.lang.String getButtonImageMouseOver()
          The button image URL.
 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 getFinishedListener()
          The name of a JavaScript function (without brackets) that should be called when pop up spell checking is finished (optional).
 java.lang.String getFinishedOnTextBoxListener()
          The name of a JavaScript function (without brackets) that should be called when spell checking is finished, per text box.
 java.lang.String getFinishedText()
          The alert text shown when the spell check finishes.
 int getGuiLanguage()
          The UI 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 getIgnoreEmptyTextBoxes()
          Whether to ignore text boxes that are empty.
 boolean getLeaveWindowOpenForUndo()
          Whether to leave the popup window open after the last error has been found, enabling the user to undo the final error.
 RapidSpellWebLauncherCollection getRapidSpellWebLaunchers()
          The ID's of the RapidSpellWebLauncher controls to start when the button is clicked.
 boolean getShowButton()
          Whether to show the launcher button (set to false to hide button/images).
 boolean getShowFinishedMessage()
          Whether to show the popup dialog at the end of the spell check.
 boolean getSSLFriendly()
          Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.
 java.lang.String getStartedOnTextBoxListener()
          The name of a JavaScript function (without brackets) that should be called when spell checking is started, per text box.
 int getTabIndex()
           
 boolean getUseSmoothTransitions()
          Whether to use smooth transitions between text boxes.
 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.
 int getWindowY()
          Sets the window Y position (in pixels), when used in Mode=popup.
 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 setFinishedListener(java.lang.String value)
           
 void setFinishedOnTextBoxListener(java.lang.String value)
           
 void setFinishedText(java.lang.String value)
          The alert text shown when the spell check finishes.
 void setGuiLanguage(int value)
           
 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 setIgnoreEmptyTextBoxes(boolean value)
           
 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 setRapidSpellWebLaunchers(RapidSpellWebLauncherCollection value)
           
 void setShowButton(boolean value)
           
 void setShowFinishedMessage(boolean value)
           
 void setSSLFriendly(boolean value)
           
 void setStartedOnTextBoxListener(java.lang.String value)
           
 void setTabIndex(int value)
           
 void setUseSmoothTransitions(boolean value)
          Whether to use smooth transitions between text boxes.
 void setWindowHeight(int value)
           
 void setWindowWidth(int value)
           
 void setWindowX(int value)
           
 void setWindowY(int value)
           
 void writeHtml(java.io.Writer output)
          Renders this control.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RapidSpellWebMultipleBean

public RapidSpellWebMultipleBean()
Creates a RapidSpellWebMultiple

Method Detail

getId

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


setId

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


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.


getButtonText

public java.lang.String getButtonText()
The text on the button.


setButtonText

public void setButtonText(java.lang.String value)
The text on the button.


getLeaveWindowOpenForUndo

public boolean getLeaveWindowOpenForUndo()
Whether to leave the popup window open after the last error has been found, enabling the user to undo the final error. It is advisable to set showFinishedMessage=false if this is set true.


setLeaveWindowOpenForUndo

public 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. It is advisable to set showFinishedMessage=false if this is set true.


getButtonStyle

public java.lang.String getButtonStyle()
The style of the button.


setButtonStyle

public void setButtonStyle(java.lang.String value)
The style of the button.


getButtonStyleClass

public java.lang.String getButtonStyleClass()
The style class of the button.


setButtonStyleClass

public void setButtonStyleClass(java.lang.String value)
The style class of the button.


getButtonOnMouseOver

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


setButtonOnMouseOver

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


getButtonOnMouseOut

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


setButtonOnMouseOut

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


getFinishedListener

public java.lang.String getFinishedListener()
The name of a JavaScript function (without brackets) that should be called when pop up spell checking is finished (optional). 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.


setFinishedListener

public void setFinishedListener(java.lang.String value)

getStartedOnTextBoxListener

public java.lang.String getStartedOnTextBoxListener()
The name of a JavaScript function (without brackets) that should be called when spell checking is started, per text box. This is optional, and of use if you require client side notification that the spell check has started on each text box. The function named here must have one argument which will receive the text box object that is being checked.


setStartedOnTextBoxListener

public void setStartedOnTextBoxListener(java.lang.String value)

getFinishedOnTextBoxListener

public java.lang.String getFinishedOnTextBoxListener()
The name of a JavaScript function (without brackets) that should be called when spell checking is finished, per text box. This is optional, and of use if you require client side notification that the spell check has finished on each text box. The function named here must have one argument which will receive the text box object that was being checked.


setFinishedOnTextBoxListener

public void setFinishedOnTextBoxListener(java.lang.String value)

getShowFinishedMessage

public boolean getShowFinishedMessage()
Whether to show the popup dialog at the end of the spell check.


setShowFinishedMessage

public void setShowFinishedMessage(boolean value)

getIgnoreEmptyTextBoxes

public boolean getIgnoreEmptyTextBoxes()
Whether to ignore text boxes that are empty.


setIgnoreEmptyTextBoxes

public void setIgnoreEmptyTextBoxes(boolean value)

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)

getUseSmoothTransitions

public boolean getUseSmoothTransitions()
Whether to use smooth transitions between text boxes.


setUseSmoothTransitions

public void setUseSmoothTransitions(boolean value)
Whether to use smooth transitions between text boxes.


getWindowWidth

public int getWindowWidth()
Sets the window width (in pixels), when used in Mode=popup.


setWindowWidth

public void setWindowWidth(int value)

getWindowHeight

public int getWindowHeight()
Sets the window height (in pixels), when used in Mode=popup.


setWindowHeight

public void setWindowHeight(int value)

getWindowX

public int getWindowX()
Sets the window X position (in pixels), when used in Mode=popup.


setWindowX

public void setWindowX(int value)

getWindowY

public int getWindowY()
Sets the window Y position (in pixels), when used in Mode=popup.


setWindowY

public void setWindowY(int value)

getRapidSpellWebLaunchers

public RapidSpellWebLauncherCollection getRapidSpellWebLaunchers()
The ID's of the RapidSpellWebLauncher controls to start when the button is clicked.


setRapidSpellWebLaunchers

public void setRapidSpellWebLaunchers(RapidSpellWebLauncherCollection value)

getShowButton

public boolean getShowButton()
Whether to show the launcher button (set to false to hide button/images). The client-side code will be written regardless.


setShowButton

public void setShowButton(boolean value)

getButtonImageMouseOut

public java.lang.String getButtonImageMouseOut()
The button image URL. This is for mouse out (ie. not mouse over) and is optional.


setButtonImageMouseOut

public void setButtonImageMouseOut(java.lang.String value)

getButtonImageMouseOver

public java.lang.String getButtonImageMouseOver()
The button image URL. This is for mouse over and is optional.


setButtonImageMouseOver

public void setButtonImageMouseOver(java.lang.String value)

getButtonImageMouseDown

public java.lang.String getButtonImageMouseDown()
The button image URL. This is for mouse down and is optional.


setButtonImageMouseDown

public void setButtonImageMouseDown(java.lang.String value)

getTabIndex

public int getTabIndex()

setTabIndex

public void setTabIndex(int value)

getButton

public RSButton getButton()
The HtmlInputButton shown to the user, when clicked the spell checker starts.


getGuiLanguage

public int getGuiLanguage()
The UI language. This is the language that all text on the UI should be in.


setGuiLanguage

public void setGuiLanguage(int value)

writeHtml

public void writeHtml(java.io.Writer output)
               throws java.io.IOException
Renders this control.

Throws:
java.io.IOException

RapidSpell Web


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