Package de.ipb_halle.molecularfaces.component.molplugin

Class MarvinJSComponent

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

de.ipb_halle.molecularfaces.component.molplugin.MarvinJSComponent

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

public class MarvinJSComponent
extends MolPluginCore
implements jakarta.faces.event.ComponentSystemEventListener

This UIComponent renders a chemical structure editor or viewer using the Marvin JS JavaScript plugin.

Nested Class Summary

Nested classes/interfaces inherited from class de.ipb_halle.molecularfaces.component.molplugin.MolPluginCore

MolPluginCore.Format, MolPluginCore.PluginType, MolPluginCore.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
private final String	baseDir
static final String	COMPONENT_TYPE
static final String	DEFAULT_RENDERER
private WebXml	webXml
static final String	WEBXML_MARVINJS_BASE_URL	Name of the context-param in web.xml that specifies the location of the extracted Marvin JS archive (marvinjs-version-core.zip) relative to the application's context root.
static final String	WEBXML_MARVINJS_LICENSE_URL	Name of the context-param in web.xml that specifies the location of Marvin JS' license file (marvin4js-license.cxl) relative to WEBXML_MARVINJS_BASE_URL.
static final String	WEBXML_MARVINJS_WEBSERVICES	Name of the context-param in web.xml that specifies if Marvin JS should use its webservices.

Fields inherited from class de.ipb_halle.molecularfaces.component.molplugin.MolPluginCore

COMPONENT_FAMILY, DEFAULT_FORMAT, DEFAULT_HEIGHT, DEFAULT_WIDTH

Fields inherited from class jakarta.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 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
MarvinJSComponent()

Method Summary

Modifier and Type	Method	Description
void	processEvent(jakarta.faces.event.ComponentSystemEvent event)
private void	processPostAddToViewEvent()

Methods inherited from class de.ipb_halle.molecularfaces.component.molplugin.MolPluginCore

getFamily, getFormat, getHeight, getResourceLoader, getWidgetVar, getWidth, isBorder, isReadonly, setBorder, setFormat, setHeight, setReadonly, setWidgetVar, setWidth

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, 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_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

• Constant Field Values

WEBXML_MARVINJS_BASE_URL

public static final String WEBXML_MARVINJS_BASE_URL

Name of the context-param in web.xml that specifies the location of the extracted Marvin JS archive (marvinjs-version-core.zip) relative to the application's context root.

See Also:

• Constant Field Values

WEBXML_MARVINJS_WEBSERVICES

public static final String WEBXML_MARVINJS_WEBSERVICES

Name of the context-param in web.xml that specifies if Marvin JS should use its webservices. If "true", the <iframe> will embed editorws.html, else it will embed editor.html. In readonly mode, the component will load /js/webservices.js relative to WEBXML_MARVINJS_BASE_URL.

See Also:

• https://marvinjs-demo.chemaxon.com/latest/docs/dev/embed.html
• Constant Field Values

WEBXML_MARVINJS_LICENSE_URL

public static final String WEBXML_MARVINJS_LICENSE_URL

Name of the context-param in web.xml that specifies the location of Marvin JS' license file (marvin4js-license.cxl) relative to WEBXML_MARVINJS_BASE_URL.

See Also:

• Constant Field Values

webXml

private WebXml webXml

baseDir

private final String baseDir

Constructor Details

MarvinJSComponent

public MarvinJSComponent()

Method Details

processEvent

public void processEvent(jakarta.faces.event.ComponentSystemEvent event)
                  throws jakarta.faces.event.AbortProcessingException

Specified by:

processEvent in interface jakarta.faces.event.ComponentSystemEventListener

Overrides:

processEvent in class jakarta.faces.component.UIComponent

Throws:

jakarta.faces.event.AbortProcessingException

processPostAddToViewEvent

private void processPostAddToViewEvent()