de.ipb_halle.molecularfaces.component.molplugin

Class MolPluginCore

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

de.ipb_halle.molecularfaces.component.molplugin.MolPluginCore

All Implemented Interfaces:

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

Direct Known Subclasses:

MarvinJSComponent, MolPaintJSComponent, OpenChemLibJSComponent

public abstract class MolPluginCore
extends javax.faces.component.UIInput
implements javax.faces.event.ComponentSystemEventListener

This class holds the attribute states of the chemical structure plugins and provides support for dynamic resource loading.

Author:

flange

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY Component family returned by getFamily()
static String	DEFAULT_FORMAT
static int	DEFAULT_HEIGHT
static int	DEFAULT_WIDTH

Fields inherited from class javax.faces.component.UIInput

COMPONENT_TYPE, CONVERSION_MESSAGE_ID, 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

Constructor Summary

Constructors

Constructor and Description
MolPluginCore()

Method Summary

Modifier and Type	Method and Description
protected void	addCssExt(String href) Enqueues loading of a stylesheet resource file.
protected void	addCssResource(String resource) Enqueues loading of a stylesheet resource file.
protected void	addScriptExt(String src) Enqueues loading of a JavaScript resource file.
protected void	addScriptResource(String resource) Enqueues loading of a JavaScript resource file.
protected StringBuilder	encodeLoadExtResources(String loaderJSVar) Creates an inline JavaScript code fragment for loading resources that have been enqueued via addScriptExt(String) and addCssExt(String).
String	getFamily()
String	getFormat() Return the value of the format property.
int	getHeight() Return the value of the height property.
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	processEvent(javax.faces.event.ComponentSystemEvent event)
protected void	processPostAddToViewEvent() Interested client components can override this method to execute code in the PostAddToViewEvent of the component.
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 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, getDefaultEventName, getEventNames, 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, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

Component family returned by getFamily()

See Also:

Constant Field Values

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

Constructor Detail

MolPluginCore

public MolPluginCore()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.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 structure editor 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 structure editor 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

addScriptResource

protected void addScriptResource(String resource)

Enqueues loading of a JavaScript resource file. The resource will be added via JSF's resource mechanism by the processEvent(ComponentSystemEvent) method in the PostAddToViewEvent event.

Parameters:

resource - name of the file in the web project's resource library

addScriptExt

protected void addScriptExt(String src)

Enqueues loading of a JavaScript resource file. The resource will be loaded via the JavaScript class molecularfaces.ResourcesLoader.

Parameters:

src - path of the resource file

addCssResource

protected void addCssResource(String resource)

Enqueues loading of a stylesheet resource file. The resource will be added via JSF's resource mechanism by the processEvent(ComponentSystemEvent) method in the PostAddToViewEvent event.

Parameters:

resource - name of the file in the web project's resource library

addCssExt

protected void addCssExt(String href)

Enqueues loading of a stylesheet resource file. The resource will be loaded via the JavaScript class molecularfaces.ResourcesLoader.

Parameters:

href - path of the resource file

processEvent

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

Specified by:

processEvent in interface javax.faces.event.ComponentSystemEventListener

Overrides:

processEvent in class javax.faces.component.UIComponent

Throws:

javax.faces.event.AbortProcessingException

processPostAddToViewEvent

protected void processPostAddToViewEvent()

Interested client components can override this method to execute code in the PostAddToViewEvent of the component. The default implementation does nothing.

encodeLoadExtResources

protected StringBuilder encodeLoadExtResources(String loaderJSVar)

Creates an inline JavaScript code fragment for loading resources that have been enqueued via addScriptExt(String) and addCssExt(String).

Parameters:

loaderJSVar - JavaScript variable name of the molecularfaces.ResourcesLoader instance

Returns:

JavaScript code