com.ckeditor
Class CKEditorTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by com.ckeditor.CKEditorTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
CKEditorInsertTag, CKEditorReplaceAllTag, CKEditorReplaceTag

public abstract class CKEditorTag
extends javax.servlet.jsp.tagext.TagSupport

Base class for CKEditor tags.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
CKEditorTag()
          Default constructor.
 
Method Summary
 int doEndTag()
           
protected abstract  String getCKEditorName()
          gets name of the CKEditor instance.
 CKEditorConfig getConfig()
           
 EventHandler getEvents()
           
 GlobalEventHandler getGlobalEvents()
           
protected abstract  String getTagOutput(CKEditorConfig config)
          Returns standard tag output.
 String getTimestamp()
           
protected  String init()
          Initialization method for tags.
 boolean isInitialized()
           
 void setBasePath(String basePath)
           
 void setConfig(CKEditorConfig config)
           
 void setEvents(EventHandler events)
           
 void setGlobalEvents(GlobalEventHandler globalEvents)
           
 void setInitialized(boolean initialized)
           
 void setTimestamp(String timestamp)
           
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CKEditorTag

public CKEditorTag()
Default constructor.

Method Detail

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

getTagOutput

protected abstract String getTagOutput(CKEditorConfig config)
Returns standard tag output.

Parameters:
config - configuration resolved to a string
Returns:
tag standard output

init

protected String init()
Initialization method for tags.

Returns:
include ckfinder.js code with attributes and additional code.

setBasePath

public final void setBasePath(String basePath)
Parameters:
basePath - the basePath to set

getTimestamp

public final String getTimestamp()
Returns:
the timestamp attribute

setTimestamp

public final void setTimestamp(String timestamp)
Parameters:
timestamp - the timestamp attribute to set

isInitialized

public final boolean isInitialized()
Returns:
the initialized attribute

setInitialized

public final void setInitialized(boolean initialized)
Parameters:
initialized - the initialized attribute to set

getGlobalEvents

public final GlobalEventHandler getGlobalEvents()
Returns:
the globalEvents attribute

setGlobalEvents

public final void setGlobalEvents(GlobalEventHandler globalEvents)
Parameters:
globalEvents - the globalEvents attribute to set

getConfig

public final CKEditorConfig getConfig()
Returns:
the config attribute

setConfig

public final void setConfig(CKEditorConfig config)
Parameters:
config - the config attribute to set

getEvents

public final EventHandler getEvents()
Returns:
the events attribute

setEvents

public final void setEvents(EventHandler events)
Parameters:
events - the events attribute to set

getCKEditorName

protected abstract String getCKEditorName()
gets name of the CKEditor instance.

Returns:
name if CKEditor instance.


Copyright © 2003-2011 CKSource - Frederico Knabben. All Rights Reserved.