Package de.ipb_halle.molecularfaces.component.molplugin

Class MolPluginCore

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
jakarta.faces.component.UIInput
de.ipb_halle.molecularfaces.component.molplugin.MolPluginCore
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:
MarvinJSComponent, MolPaintJSComponent, OpenChemLibJSComponent
public abstract class MolPluginCore extends jakarta.faces.component.UIInput
This class holds the attribute states of the chemical structure plugins.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    MolPluginCore.Format
    Possible values for the format property.
    static enum 
    MolPluginCore.PluginType
    Supported chemical structure plugin types.
    protected static enum 
    MolPluginCore.PropertyKeys
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COMPONENT_FAMILY
    Component family returned by getFamily()
    static final String
    DEFAULT_FORMAT
     
    static final int
    DEFAULT_HEIGHT
     
    static final int
    DEFAULT_WIDTH
     
    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
    Modifier
    Constructor
    Description
    protected
    MolPluginCore()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFamily()
     
    String
    getFormat()
    Return the value of the format property.
    int
    getHeight()
    Return the value of the height property.
    protected ResourceLoader
    getResourceLoader()
     
    String
    getWidgetVar()
    Return the value of the widgetVar property.
    int
    getWidth()
    Return the value of the width property.
    boolean
    isBorder()
    Return the value of the border property.
    boolean
    isReadonly()
    Return the value of the readonly property.
    void
    setBorder(boolean border)
    Set the value of the border property.
    void
    setFormat(String format)
    Set the value of the format property.
    void
    setHeight(int height)
    Set the value of the height property.
    void
    setReadonly(boolean readonly)
    Set the value of the readonly property.
    void
    setWidgetVar(String widgetVar)
    Set the value of the widgetVar property.
    void
    setWidth(int width)
    Set the value of the width 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

  • Constructor Details

    • MolPluginCore

      protected MolPluginCore()

  • Method Details

    • getResourceLoader

      protected ResourceLoader getResourceLoader()

    • getFamily

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

    • isBorder

      public boolean isBorder()
      Return the value of the border property.

      Flag indicating that this element is rendered with a border.

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

    • setBorder

      public void setBorder(boolean border)
      Set the value of the border property.
      Parameters:
      border - boolean value which indicates that the plugin component renders surrounded by a border

    • getFormat

      public String getFormat()
      Return the value of the format property.

      Controls the chemical file format to be used in the value property.

      Possible values are provided by the MolPluginCore.Format enumeration.

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

    • setFormat

      public void setFormat(String format)
      Set the value of the format property.
      Parameters:
      format - chemical file format

    • getHeight

      public int getHeight()
      Return the value of the height property.

      The height of the plugin in pixels.

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

    • setHeight

      public void setHeight(int height)
      Set the value of the height property.
      Parameters:
      height - height of the rendered plugin

    • isReadonly

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

      Flag indicating that this element is in editable (full structure editor) or in view-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 if the plugin component renders an editor or a viewer

    • 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

    • getWidth

      public int getWidth()
      Return the value of the width property.

      The width of the plugin in pixels.

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

    • setWidth

      public void setWidth(int width)
      Set the value of the width property.
      Parameters:
      width - width of the rendered plugin