Package de.ipb_halle.molecularfaces.component.openvectoreditor

Class OpenVectorEditorCore

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
jakarta.faces.component.UIInput
de.ipb_halle.molecularfaces.component.openvectoreditor.OpenVectorEditorCore
All Implemented Interfaces:
jakarta.faces.component.EditableValueHolder, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener
Direct Known Subclasses:
OpenVectorEditorComponent
public abstract class OpenVectorEditorCore extends jakarta.faces.component.UIInput
This class holds the attribute states of the <mol:openVectorEditor> component.

  • Nested Class Summary

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COMPONENT_FAMILY
    Component family returned by getFamily()
    static final String
    EMPTY_PROTEIN_SEQUENCE_JSON
    An empty protein sequence as JSON string that may be used to initiate the OpenVectorEditor in protein sequence mode.
    private ResourceLoader
    resourceLoader
     

    Fields inherited from class jakarta.faces.component.UIInput

    ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    Fields inherited from class jakarta.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenVectorEditorCore()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFamily()
     
    protected ResourceLoader
    getResourceLoader()
     
    String
    getWidgetVar()
    Return the value of the widgetVar property.
    boolean
    isReadonly()
    Return the value of the readonly property.
    void
    setReadonly(boolean readonly)
    Set the value of the readonly property.
    void
    setWidgetVar(String widgetVar)
    Set the value of the widgetVar property.

    Methods inherited from class jakarta.faces.component.UIInput

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

    Methods inherited from class jakarta.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Methods inherited from class jakarta.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

    Methods inherited from class jakarta.faces.component.UIComponent

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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface jakarta.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

  • Field Details

    • COMPONENT_FAMILY

      public static final String COMPONENT_FAMILY
      Component family returned by getFamily()
      See Also:

    • EMPTY_PROTEIN_SEQUENCE_JSON

      public static final String EMPTY_PROTEIN_SEQUENCE_JSON
      An empty protein sequence as JSON string that may be used to initiate the OpenVectorEditor in protein sequence mode.
      See Also:

    • resourceLoader

      private ResourceLoader resourceLoader

  • Constructor Details

    • OpenVectorEditorCore

      public OpenVectorEditorCore()

  • Method Details

    • getResourceLoader

      protected ResourceLoader getResourceLoader()

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class jakarta.faces.component.UIInput

    • isReadonly

      public boolean isReadonly()
      Return the value of the readonly property.

      Flag indicating that this element is in editable or in read-only mode.

      Returns:
      the value of the attribute or false if it has not been set in the JSF view.

    • setReadonly

      public void setReadonly(boolean readonly)
      Set the value of the readonly property.
      Parameters:
      readonly - boolean value which indicates the rendering of the component in read-only mode

    • getWidgetVar

      public String getWidgetVar()
      Return the value of the widgetVar property.

      The client-side variable name of a Promise object that embeds the plugin's JavaScript instance.

      Returns:
      the value of the attribute.

    • setWidgetVar

      public void setWidgetVar(String widgetVar)
      Set the value of the widgetVar property.
      Parameters:
      widgetVar - name of the client-side Promise object that embeds the plugin's JavaScript instance