|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
com.fredck.FCKeditor.tags.FCKeditorTag
public class FCKeditorTag
Custom Tag class to access the container.
Simple usage:
<FCK:editor id="EditorAccessibility" width="80%" height="120" toolbarSet="Accessibility" ">This is another test. <BR><BR>The "Second" row.</BR></FCK:editor">
In this example we set all the attribute for the fckedit tag.
Advanced usage of the tag:
<FCK:editor id="EditorDefault" basePath="/FCKeditor/" styleNames=";Style 1;Style 2; Style 3" fontNames=";Arial;Courier New;Times New Roman;Verdana" > This is some <B>sample text</B>. </FCK:editor>
In this example we set the id and the basePath of the editor (since it is /FCKeditor/
we could have omitted it because it's already the default value).
Then we used the the optional attributes to set some advanced configuration settings.
Field Summary | |
---|---|
protected FCKeditor |
fcked
The underlying FCKeditor object |
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
bodyContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag |
---|
EVAL_BODY_BUFFERED, EVAL_BODY_TAG |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
FCKeditorTag()
|
Method Summary | |
---|---|
int |
doAfterBody()
Retrive initial value to be edited and writes the HTML code in the page |
int |
doStartTag()
Initialize the FCKeditor container and set attributes |
void |
setAutoDetectLanguage(java.lang.String value)
Tells the editor to automatically detect the user language preferences to adapt its interface language. With Internet Explorer, the language configured in the Windows Control Panel is used. With Firefox, the browser language is used. |
void |
setBaseHref(java.lang.String value)
Base URL used to resolve links (on images, links, styles, etc.). For example, if BaseHref is set to 'http://www.fredck.com', an image that points to "/images/Logo.gif" will be interpreted by the editor as "http://www.fredck.com/images/Logo.gif", without touching the "src" attribute of the image. |
void |
setBasePath(java.lang.String value)
Set the dir where the FCKeditor files reside on the server |
void |
setContentLangDirection(java.lang.String value)
Sets the direction of the editor area contents. The possible values are: ltr - Left to Right rtl - Right to Left |
void |
setCustomConfigurationsPath(java.lang.String value)
Set the path of a custom file that can override some configurations. It is recommended to use absolute paths (starting with /), like "/myfckconfig.js". |
void |
setDebug(java.lang.String value)
Enables the debug window to be shown when calling the FCKDebug.Output() function. |
void |
setDefaultLanguage(java.lang.String value)
Sets the default language used for the editor's interface localization. The default language is used when the AutoDetectLanguage options is disabled or when the user language is not available. |
void |
setEditorAreaCSS(java.lang.String value)
Set the CSS styles file to be used in the editing area. In this way you can point to a file that reflects your web site styles. |
void |
setEnableSourceXHTML(java.lang.String value)
Tells the editor to process the HTML source to XHTML when switching from WYSIWYG to Source view |
void |
setEnableXHTML(java.lang.String value)
Tells the editor to process the HTML source to XHTML on form post. |
void |
setFillEmptyBlocks(java.lang.String value)
Block elements (like P, DIV, H1, PRE, etc...) are forced to have content (a ). Empty blocks are "collapsed" by while browsing, so a empty <p></p> is not visible. While editing, the editor "expand" empty blocks so you can insert content inside then. Setting this option to "true" results useful to reflect the same output when browsing and editing. |
void |
setFlashBrowserURL(java.lang.String value)
Sets the URL of the page called when the user clicks the "Browse Server" button in the "Flash" dialog window. In this way, you can create your custom Flash Browser that is well integrated with your system. |
void |
setFlashUploadURL(java.lang.String value)
Sets the URL of the upload handler called when the user clicks the "Send it to server" button in the "Flash" dialog window. In this way, you can create your custom Flash Uploader that is well integrated with your system. |
void |
setFontColors(java.lang.String value)
Sets the colors that must be shown in the colors panels (in the toolbar). |
void |
setFontFormats(java.lang.String value)
Sets the list of formats to be shown in the "Format" toolbar command. |
void |
setFontNames(java.lang.String value)
Sets the list of fonts to be shown in the "Font" toolbar command. |
void |
setFontSizes(java.lang.String value)
Sets the list of font sizes to be shown in the "Size" toolbar command. |
void |
setForcePasteAsPlainText(java.lang.String value)
Converts the clipboard contents to pure text on pasting operations |
void |
setForceSimpleAmpersand(java.lang.String value)
Forces the ampersands (&) on tags attributes to not be converted to "&" This conversion is a W3C requirement for XHTML, so it is recommended to leave this option to "false". |
void |
setFormatIndentator(java.lang.String value)
Sets the characters to be used when indenting the HTML source when formatting it. Useful values are a sequence of spaces (' ') or a tab char ('\t'). |
void |
setFormatOutput(java.lang.String value)
The output HTML generated by the editor will be processed and formatted. |
void |
setFormatSource(java.lang.String value)
The HTML shown by the editor, while switching from WYSIWYG to Source views, will be processed and formatted |
void |
setFullPage(java.lang.String value)
Enables full page editing (from <HTML> to </HTML>). It also enables the "Page Properties" toolbar button. |
void |
setGeckoUseSPAN(java.lang.String value)
Tells Gecko browsers to use SPAN instead of <B>, <I> and <U> for bold, italic an underline |
void |
setHeight(java.lang.String value)
Set the height of the textarea |
void |
setId(java.lang.String value)
Set the unique id of the editor |
void |
setImageBrowserURL(java.lang.String value)
Sets the URL of the page called when the user clicks the "Browse Server" button in the "Image" dialog window. In this way, you can create your custom Image Browser that is well integrated with your system. |
void |
setImageUploadURL(java.lang.String value)
Sets the URL of the upload handler called when the user clicks the "Send it to server" button in the "Image" dialog window. In this way, you can create your custom Image Uploader that is well integrated with your system. |
void |
setLinkBrowserURL(java.lang.String value)
Sets the URL of the page called when the user clicks the "Browse Server" button in the "Link" dialog window. In this way, you can create your custom File Browser that is well integrated with your system. |
void |
setLinkUploadURL(java.lang.String value)
Sets the URL of the upload handler called when the user clicks the "Send it to server" button in the "Link" dialog window. In this way, you can create your custom Link Uploader that is well integrated with your system. |
void |
setPluginsPath(java.lang.String value)
Sets the base path used when looking for registered plugins. |
void |
setSkinPath(java.lang.String value)
Sets the path to the skin (graphical interface settings) to be used by the editor. |
void |
setStartupFocus(java.lang.String value)
Forces the editor to get the keyboard input focus on startup (page load) |
void |
setStylesXmlPath(java.lang.String value)
Sets the path to the XML file that has the definitions and rules of the styles used by the "Style" toolbar command |
void |
setTabSpaces(java.lang.String value)
Set the number of spaces ( ) to be inserted when the user hits the "tab" key. This is an Internet Explorer only feature. |
void |
setToolbarCanCollapse(java.lang.String value)
Tells the editor that the toolbar can be Collapsed/Expanded by the user when clicking the vertical bar placed on the left of it (on the right for "rtl" languages). |
void |
setToolbarSet(java.lang.String value)
Set the name of the toolbar to display |
void |
setToolbarStartExpanded(java.lang.String value)
The toolbar is Expanded on startup, otherwise it is Collapsed and the user must click on it to show it. |
void |
setUseBROnCarriageReturn(java.lang.String value)
Inserts a <BR> tag when the user hits the "enter" key, instead of starting a new paragraph (<P> or <DIV>). This is an Internet Explorer only feature. |
void |
setWidth(java.lang.String value)
Set the width of the textarea |
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
doEndTag, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
---|
getParent, setPageContext, setParent |
Field Detail |
---|
protected FCKeditor fcked
Constructor Detail |
---|
public FCKeditorTag()
Method Detail |
---|
public void setId(java.lang.String value)
setId
in class javax.servlet.jsp.tagext.TagSupport
value
- namepublic void setBasePath(java.lang.String value)
value
- pathpublic void setToolbarSet(java.lang.String value)
value
- toolbar namepublic void setWidth(java.lang.String value)
value
- widthpublic void setHeight(java.lang.String value)
value
- heightpublic void setCustomConfigurationsPath(java.lang.String value)
value
- pathpublic void setEditorAreaCSS(java.lang.String value)
value
- pathpublic void setBaseHref(java.lang.String value)
value
- URLpublic void setSkinPath(java.lang.String value)
value
- pathpublic void setPluginsPath(java.lang.String value)
value
- pathpublic void setFullPage(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setDebug(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setAutoDetectLanguage(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setDefaultLanguage(java.lang.String value)
value
- language codepublic void setContentLangDirection(java.lang.String value) throws javax.servlet.jsp.JspException
value
- ltr/rtl
javax.servlet.jsp.JspException
- if value is not ltr or rtlpublic void setEnableXHTML(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setEnableSourceXHTML(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setFillEmptyBlocks(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setFormatSource(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setFormatOutput(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setFormatIndentator(java.lang.String value)
value
- indentatorpublic void setGeckoUseSPAN(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setStartupFocus(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setForcePasteAsPlainText(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setForceSimpleAmpersand(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setTabSpaces(java.lang.String value)
value
- number of spacespublic void setUseBROnCarriageReturn(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setToolbarStartExpanded(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setToolbarCanCollapse(java.lang.String value) throws javax.servlet.jsp.JspException
value
- true/false
javax.servlet.jsp.JspException
- if value is not true or falsepublic void setFontColors(java.lang.String value)
value
- colorspublic void setFontNames(java.lang.String value)
value
- fontspublic void setFontSizes(java.lang.String value)
value
- sizespublic void setFontFormats(java.lang.String value)
value
- format listpublic void setStylesXmlPath(java.lang.String value)
value
- pathpublic void setLinkBrowserURL(java.lang.String value)
value
- pathpublic void setImageBrowserURL(java.lang.String value)
value
- pathpublic void setFlashBrowserURL(java.lang.String value)
value
- pathpublic void setLinkUploadURL(java.lang.String value)
value
- pathpublic void setImageUploadURL(java.lang.String value)
value
- pathpublic void setFlashUploadURL(java.lang.String value)
value
- pathpublic int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
public int doAfterBody() throws javax.servlet.jsp.JspException
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
- if an error occurs while writing to the out buffer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |