Package org.primefaces.extensions.component.base

Class AbstractEditorInputTextArea

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
javax.faces.component.html.HtmlInputTextarea
org.primefaces.component.api.AbstractPrimeHtmlInputTextArea
org.primefaces.extensions.component.base.AbstractEditorInputTextArea
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.RTLAware, org.primefaces.component.api.Widget
Direct Known Subclasses:
MarkdownEditor, SunEditor
public class AbstractEditorInputTextArea extends org.primefaces.component.api.AbstractPrimeHtmlInputTextArea implements org.primefaces.component.api.Widget, org.primefaces.component.api.RTLAware
Abstract Editor for SunEditor and Markdown Editor.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static enum 
    AbstractEditorInputTextArea.PropertyKeys
     

  • Field Summary

    Fields inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputTextArea

    EVENT_NAMES

    Fields inherited from class javax.faces.component.html.HtmlInputTextarea

    COMPONENT_TYPE

    Fields inherited from class javax.faces.component.UIInput

    ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    Fields inherited from class javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

    Fields inherited from interface org.primefaces.component.api.Widget

    ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractEditorInputTextArea()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkSecurity(javax.faces.context.FacesContext context)
    Enforce security by default requiring the OWASP sanitizer on the classpath.
    String
    getDir()
     
    String
    getExtender()
     
    String
    getToolbar()
     
    String
    getWidgetVar()
     
    boolean
    isAllowBlocks()
     
    boolean
    isAllowFormatting()
     
    boolean
    isAllowImages()
     
    boolean
    isAllowLinks()
     
    boolean
    isAllowMedia()
     
    boolean
    isAllowStyles()
     
    boolean
    isAllowTables()
     
    boolean
    isSecure()
     
    String
    sanitizeHtml(javax.faces.context.FacesContext context, String value)
    If security is enabled sanitize the Markdown string to prevent XSS.
    void
    setAllowBlocks(boolean allowBlocks)
     
    void
    setAllowFormatting(boolean allowFormatting)
     
    void
    setAllowImages(boolean allowImages)
     
    void
    setAllowLinks(boolean allowLinks)
     
    void
    setAllowMedia(boolean allowMedia)
     
    void
    setAllowStyles(boolean allowStyles)
     
    void
    setAllowTables(boolean allowTables)
     
    void
    setDir(String _dir)
     
    void
    setExtender(String extender)
     
    void
    setSecure(boolean secure)
     
    void
    setToolbar(String toolbar)
     
    void
    setWidgetVar(String widgetVar)
     

    Methods inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputTextArea

    getEventNames, getInputmode, getOncontextmenu, getOncopy, getOncut, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOninput, getOninvalid, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnwheel, setInputmode, setOncontextmenu, setOncopy, setOncut, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOninput, setOninvalid, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnwheel

    Methods inherited from class javax.faces.component.html.HtmlInputTextarea

    getAccesskey, getCols, getDefaultEventName, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getRows, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setCols, setDisabled, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setRows, setStyle, setStyleClass, setTabindex, setTitle

    Methods inherited from class javax.faces.component.UIInput

    addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

    Methods inherited from class javax.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

    Methods inherited from class javax.faces.component.UIComponent

    encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors

    Methods inherited from interface org.primefaces.component.api.RTLAware

    isRTL

    Methods inherited from interface javax.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

    Methods inherited from interface org.primefaces.component.api.Widget

    resolveWidgetVar, resolveWidgetVar

  • Constructor Details

    • AbstractEditorInputTextArea

      public AbstractEditorInputTextArea()

  • Method Details

    • setDir

      public void setDir(String _dir)
      Overrides:
      setDir in class javax.faces.component.html.HtmlInputTextarea

    • getDir

      public String getDir()
      Specified by:
      getDir in interface org.primefaces.component.api.RTLAware
      Overrides:
      getDir in class javax.faces.component.html.HtmlInputTextarea

    • getWidgetVar

      public String getWidgetVar()

    • setWidgetVar

      public void setWidgetVar(String widgetVar)

    • isSecure

      public boolean isSecure()

    • setSecure

      public void setSecure(boolean secure)

    • isAllowBlocks

      public boolean isAllowBlocks()

    • setAllowBlocks

      public void setAllowBlocks(boolean allowBlocks)

    • isAllowFormatting

      public boolean isAllowFormatting()

    • setAllowFormatting

      public void setAllowFormatting(boolean allowFormatting)

    • isAllowLinks

      public boolean isAllowLinks()

    • setAllowLinks

      public void setAllowLinks(boolean allowLinks)

    • isAllowStyles

      public boolean isAllowStyles()

    • setAllowStyles

      public void setAllowStyles(boolean allowStyles)

    • isAllowImages

      public boolean isAllowImages()

    • setAllowImages

      public void setAllowImages(boolean allowImages)

    • isAllowTables

      public boolean isAllowTables()

    • setAllowMedia

      public void setAllowMedia(boolean allowMedia)

    • isAllowMedia

      public boolean isAllowMedia()

    • setAllowTables

      public void setAllowTables(boolean allowTables)

    • getExtender

      public String getExtender()

    • setExtender

      public void setExtender(String extender)

    • getToolbar

      public String getToolbar()

    • setToolbar

      public void setToolbar(String toolbar)

    • checkSecurity

      public void checkSecurity(javax.faces.context.FacesContext context)
      Enforce security by default requiring the OWASP sanitizer on the classpath. Only if a user marks the editor with secure="false" will they opt-out of security.
      Parameters:
      context - the FacesContext

    • sanitizeHtml

      public String sanitizeHtml(javax.faces.context.FacesContext context, String value)
      If security is enabled sanitize the Markdown string to prevent XSS.
      Parameters:
      context - the FacesContext
      value - the value to sanitize
      Returns:
      the sanitized value