Class HtmlEditor

  • 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.Widget

    public class HtmlEditor
    extends org.primefaces.component.api.AbstractPrimeHtmlInputTextArea
    implements javax.faces.component.behavior.ClientBehaviorHolder, org.primefaces.component.api.Widget
    An HTML editor component which may be implemented by different libraries.
    Since:
    8.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      static String EVENT_DIRTY  
      static String EVENT_INITIALIZE  
      static String EVENT_SAVE  
      static String EVENT_SOURCE_MODE  
      static String EVENT_WYSIWYG_MODE  
      • Fields inherited from class javax.faces.component.UIInput

        ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, 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
      HtmlEditor()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getContentsCss()  
      String getCustomConfig()  
      String getDefaultEventName()  
      String getDefaultLanguage()  
      String getEnterMode()  
      Collection<String> getEventNames()  
      String getFamily()  
      String getFileBrowserUploadUrl()  
      String getFont()  
      String getFontSize()  
      String getHeight()  
      String getInterfaceColor()  
      String getLanguage()  
      String getPlaceholder()  
      String getShiftEnterMode()  
      String getSkin()  
      String getTabindex()  
      String getTheme()  
      String getToolbar()  
      String getWidgetVar()  
      String getWidth()  
      boolean isAdvancedContentFilter()  
      boolean isDisableNativeSpellChecker()  
      boolean isEscape()  
      boolean isReadonly()  
      void setAdvancedContentFilter​(boolean acf)  
      void setContentsCss​(String contentsCss)  
      void setCustomConfig​(String customConfig)  
      void setDefaultLanguage​(String defaultLanguage)  
      void setDisableNativeSpellChecker​(boolean spellCheck)  
      void setEnterMode​(String enterMode)  
      void setEscape​(boolean escape)  
      void setFileBrowserUploadUrl​(String fileBrowserUploadUrl)  
      void setFont​(String font)  
      void setFontSize​(String fontSize)  
      void setHeight​(String height)  
      void setInterfaceColor​(String interfaceColor)  
      void setLanguage​(String language)  
      void setPlaceholder​(String placeholder)  
      void setReadonly​(boolean readonly)  
      void setShiftEnterMode​(String shiftEnterMode)  
      void setSkin​(String skin)  
      void setTabindex​(String tabindex)  
      void setTheme​(String theme)  
      void setToolbar​(String toolbar)  
      void setWidgetVar​(String widgetVar)  
      void setWidth​(String width)  
      • Methods inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputTextArea

        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, getDir, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getRows, getStyle, getStyleClass, getTitle, isDisabled, setAccesskey, setCols, setDir, setDisabled, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRole, setRows, setStyle, setStyleClass, setTitle
      • Methods inherited from class javax.faces.component.UIInput

        addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, 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 interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors
      • Methods inherited from interface javax.faces.component.ValueHolder

        getConverter, getLocalValue, setConverter
      • Methods inherited from interface org.primefaces.component.api.Widget

        resolveWidgetVar, resolveWidgetVar
    • Constructor Detail

      • HtmlEditor

        public HtmlEditor()
    • Method Detail

      • getContentsCss

        public String getContentsCss()
      • getCustomConfig

        public String getCustomConfig()
      • getDefaultEventName

        public String getDefaultEventName()
        Specified by:
        getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getDefaultEventName in class javax.faces.component.html.HtmlInputTextarea
      • getDefaultLanguage

        public String getDefaultLanguage()
      • getEnterMode

        public String getEnterMode()
      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class org.primefaces.component.api.AbstractPrimeHtmlInputTextArea
      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UIInput
      • getFileBrowserUploadUrl

        public String getFileBrowserUploadUrl()
      • getFont

        public String getFont()
      • getFontSize

        public String getFontSize()
      • getHeight

        public String getHeight()
      • getInterfaceColor

        public String getInterfaceColor()
      • getLanguage

        public String getLanguage()
      • getPlaceholder

        public String getPlaceholder()
      • getShiftEnterMode

        public String getShiftEnterMode()
      • getSkin

        public String getSkin()
      • getTabindex

        public String getTabindex()
        Overrides:
        getTabindex in class javax.faces.component.html.HtmlInputTextarea
      • getTheme

        public String getTheme()
      • getToolbar

        public String getToolbar()
      • getWidgetVar

        public String getWidgetVar()
      • getWidth

        public String getWidth()
      • isAdvancedContentFilter

        public boolean isAdvancedContentFilter()
      • isDisableNativeSpellChecker

        public boolean isDisableNativeSpellChecker()
      • isEscape

        public boolean isEscape()
      • isReadonly

        public boolean isReadonly()
        Overrides:
        isReadonly in class javax.faces.component.html.HtmlInputTextarea
      • setAdvancedContentFilter

        public void setAdvancedContentFilter​(boolean acf)
      • setContentsCss

        public void setContentsCss​(String contentsCss)
      • setCustomConfig

        public void setCustomConfig​(String customConfig)
      • setDefaultLanguage

        public void setDefaultLanguage​(String defaultLanguage)
      • setDisableNativeSpellChecker

        public void setDisableNativeSpellChecker​(boolean spellCheck)
      • setEnterMode

        public void setEnterMode​(String enterMode)
      • setEscape

        public void setEscape​(boolean escape)
      • setFileBrowserUploadUrl

        public void setFileBrowserUploadUrl​(String fileBrowserUploadUrl)
      • setFont

        public void setFont​(String font)
      • setFontSize

        public void setFontSize​(String fontSize)
      • setHeight

        public void setHeight​(String height)
      • setInterfaceColor

        public void setInterfaceColor​(String interfaceColor)
      • setLanguage

        public void setLanguage​(String language)
      • setPlaceholder

        public void setPlaceholder​(String placeholder)
      • setReadonly

        public void setReadonly​(boolean readonly)
        Overrides:
        setReadonly in class javax.faces.component.html.HtmlInputTextarea
      • setShiftEnterMode

        public void setShiftEnterMode​(String shiftEnterMode)
      • setSkin

        public void setSkin​(String skin)
      • setTabindex

        public void setTabindex​(String tabindex)
        Overrides:
        setTabindex in class javax.faces.component.html.HtmlInputTextarea
      • setTheme

        public void setTheme​(String theme)
      • setToolbar

        public void setToolbar​(String toolbar)
      • setWidgetVar

        public void setWidgetVar​(String widgetVar)
      • setWidth

        public void setWidth​(String width)