Class JsonSchemaEditor

  • 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.InputHolder, org.primefaces.component.api.Widget

    public class JsonSchemaEditor
    extends javax.faces.component.html.HtmlInputTextarea
    implements org.primefaces.component.api.Widget, org.primefaces.component.api.InputHolder
    PrimeFaces component for the JsonSchemaEditor component. Provides a visual editor for JSON Schemas.
    Since:
    8.5.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String DEFAULT_RENDERER  
      static String STYLE_CLASS  
      • 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, 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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Collection<String> getEventNames()  
      String getFamily()  
      String getHeight()
      Gets the height of the JSON schema editor, as a CSS length.
      String getInputClientId()  
      String getLabelledBy()  
      Locale getLocale()
      Gets the locale for the JSON schema editor.
      int getPrettyPrint()
      Gets whether to pretty print the JSON schema in the component's value.
      String getValidatableInputClientId()  
      String getWidgetVar()  
      void setHeight​(String height)
      Sets the height of the JSON schema editor, as a CSS length.
      void setLabelledBy​(String labelledBy)  
      void setLocale​(Locale locale)
      Sets the locale for the JSON schema editor.
      void setPrettyPrint​(int prettyPrint)
      Sets whether to pretty print the JSON schema in the component's value.
      void setWidgetVar​(String widgetVar)  
      • Methods inherited from class javax.faces.component.html.HtmlInputTextarea

        getAccesskey, getCols, getDefaultEventName, getDir, 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, setDir, 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, 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

      • JsonSchemaEditor

        public JsonSchemaEditor()
    • Method Detail

      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class javax.faces.component.html.HtmlInputTextarea
      • getFamily

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

        public String getHeight()
        Gets the height of the JSON schema editor, as a CSS length. Defaults to "300px".
        Returns:
        The height of the JSON schema editor.
      • setHeight

        public void setHeight​(String height)
        Sets the height of the JSON schema editor, as a CSS length. Defaults to "300px".
        Parameters:
        height - The height of the JSON schema editor.
      • getInputClientId

        public String getInputClientId()
        Specified by:
        getInputClientId in interface org.primefaces.component.api.InputHolder
      • getLabelledBy

        public String getLabelledBy()
        Specified by:
        getLabelledBy in interface org.primefaces.component.api.InputHolder
      • setLabelledBy

        public void setLabelledBy​(String labelledBy)
        Specified by:
        setLabelledBy in interface org.primefaces.component.api.InputHolder
      • getLocale

        public Locale getLocale()
        Gets the locale for the JSON schema editor. Defaults to the current locale of the Faces context.
        Returns:
        The locale for the JSON schema editor.
      • setLocale

        public void setLocale​(Locale locale)
        Sets the locale for the JSON schema editor. Defaults to the current locale of the Faces context.
        Parameters:
        locale - The locale for the JSON schema editor.
      • getPrettyPrint

        public int getPrettyPrint()
        Gets whether to pretty print the JSON schema in the component's value. Must be the number of spaces to use for indentation. Values smaller than 1 disable pretty printing. Values Defaults to 0 (disabled).
        Returns:
        The number of spaces to use for pretty printing.
      • setPrettyPrint

        public void setPrettyPrint​(int prettyPrint)
        Sets whether to pretty print the JSON schema in the component's value. Must be the number of spaces to use for indentation. Values smaller than 1 disable pretty printing. Values Defaults to 0 (disabled).
        Parameters:
        prettyPrint - The number of spaces to use for pretty printing.
      • getValidatableInputClientId

        public String getValidatableInputClientId()
        Specified by:
        getValidatableInputClientId in interface org.primefaces.component.api.InputHolder
      • getWidgetVar

        public String getWidgetVar()
      • setWidgetVar

        public void setWidgetVar​(String widgetVar)