ilog.views.diagrammer.faces.component

Class IlvFacesDiagrammerView

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIGraphic

ilog.views.faces.component.IlvBasicView

ilog.views.faces.component.IlvFacesView

ilog.views.diagrammer.faces.component.IlvFacesDiagrammerView

All Implemented Interfaces:

IlvFacesDiagrammerConstants, IlvFacesComponent, IlvFacesConstants, IlvFrameworkConstants, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

Direct Known Subclasses:

IlvFacesDHTMLDiagrammerView

public class IlvFacesDiagrammerView
extends IlvFacesView
implements IlvFacesConstants, IlvFacesDiagrammerConstants

This class defines the base JViews Faces Diagrammer View component.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.component.IlvFacesView

MAX_ZOOM_DEFAULT_VALUE, MIN_ZOOM_DEFAULT_VALUE, PAN_FACTOR_DEFAULT_VALUE, ZOOM_FACTOR_DEFAULT_VALUE

Fields inherited from class ilog.views.faces.component.IlvBasicView

DEFAULT_OBJECT_FINDER

Fields inherited from class jakarta.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class jakarta.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 ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Fields inherited from interface ilog.views.diagrammer.faces.IlvFacesDiagrammerConstants

DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

AUTO_REFRESH, BOUNDING_BOX, COLOR, CONSTRAINED_ON_CONTENTS, GROUPABLE, HITMAP_LAYERS, IGNORE_CONTENT_ASPECT_RATIO, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, OPACITY, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TEMPLATE, TILE_SIZE, TOLERANCE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Constructor Summary

Constructors

Constructor and Description
IlvFacesDiagrammerView() Creates a new IlvFacesDiagrammerView instance.

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component.
IlvFacesDiagrammerDataSource	getDataSource() Returns the diagrammer data source.
String	getDataSourceId() Returns the data source identifier.
IlvObjectSelectedFinder	getDefaultObjectFinder() Returns the default finder of this view.
IlvDiagrammer	getDiagrammer() Returns the IlvDiagrammer instance wrapped by this IlvFacesDiagrammer instance.
String	getFamily() Returns the identifier of the component family to which this component belongs.
String	getProject() Returns the URL of the diagrammer designer project of this diagrammer.
String	getStyleSheets() Returns the comma separated list of style sheets URL.
boolean	isEditable() Returns whether or not the IlvFacesDiagrammerView is editable.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the stateObj parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setDataSource(IlvFacesDiagrammerDataSource dataSource) Sets the data source to this diagrammer instance.
void	setDataSourceId(String dataSourceId) Sets the data source identifier to this diagrammer instance.
void	setDiagrammer(IlvDiagrammer diagrammer) Sets the IlvDiagrammer wrapped by this IlvFacesDiagrammer instance.
void	setEditable(boolean value) Sets whether or not the IlvFacesDiagrammerView is editable.
void	setProject(String project) Sets the diagrammer designer project to this diagrammer.
void	setStyleSheets(String styleSheets) Sets the comma separated list of style sheets URL.
void	showAll() Resets the view bounding box to show all the diagrammer view.
void	updateModel(jakarta.faces.context.FacesContext context) This method updates the referenced values with the local values of the component if these values were updated from the client.

Methods inherited from class ilog.views.faces.component.IlvFacesView

getBoundingBox, getHitmapLayers, getHotkeys, getInteractor, getInteractorId, getMaxZoomLevel, getMinZoomLevel, getPanFactor, getScrollBar, getStaticLayersCount, getTileSize, getView, getVisibleLayers, getZoomFactor, getZoomLevels, isConstrainedOnContents, isProgressiveZoom, processValidators, setBoundingBox, setConstrainedOnContents, setHitmapLayers, setHotkeys, setInteractor, setInteractorId, setMaxZoomLevel, setMinZoomLevel, setPanFactor, setProgressiveZoom, setScrollBar, setStaticLayersCount, setTileSize, setView, setVisibleLayers, setZoomFactor, setZoomLevels

Methods inherited from class ilog.views.faces.component.IlvBasicView

clearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth

Methods inherited from class jakarta.faces.component.UIGraphic

getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesDiagrammerView

public IlvFacesDiagrammerView()

Creates a new IlvFacesDiagrammerView instance.

Method Detail

getFamily

public String getFamily()

Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

This implementation returns the fully qualified class name.

Overrides:

getFamily in class IlvBasicView

Returns:

The family to which this component belongs.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getDataSource

public IlvFacesDiagrammerDataSource getDataSource()

Returns the diagrammer data source.

Returns:

The data source.

setDataSource

public void setDataSource(IlvFacesDiagrammerDataSource dataSource)

Sets the data source to this diagrammer instance.

Parameters:

dataSource - The data source to set.

getDataSourceId

public String getDataSourceId()

Returns the data source identifier.

Returns:

The data source ID.

setDataSourceId

public void setDataSourceId(String dataSourceId)

Sets the data source identifier to this diagrammer instance. The real data source will be retrieved from this ID during the rendering.

Parameters:

dataSourceId - The data source ID to set.

getProject

public String getProject()

Returns the URL of the diagrammer designer project of this diagrammer.

Returns:

The diagrammer designer project URL.

setProject

public void setProject(String project)

Sets the diagrammer designer project to this diagrammer.

Parameters:

project - The diagrammer designer project to set.

showAll

public void showAll()
             throws Exception

Resets the view bounding box to show all the diagrammer view.

Throws:

Exception

setDiagrammer

public void setDiagrammer(IlvDiagrammer diagrammer)

Sets the IlvDiagrammer wrapped by this IlvFacesDiagrammer instance.

Parameters:

diagrammer - The IlvDiagrammer instance to set.

getDiagrammer

public IlvDiagrammer getDiagrammer()
                            throws Exception

Returns the IlvDiagrammer instance wrapped by this IlvFacesDiagrammer instance.

Returns:

The IlvDiagrammer instance.

Throws:

Exception

getStyleSheets

public String getStyleSheets()

Returns the comma separated list of style sheets URL.

Returns:

The list of style sheets URL.

setStyleSheets

public void setStyleSheets(String styleSheets)

Sets the comma separated list of style sheets URL.

Parameters:

styleSheets - The style sheets to set.

isEditable

public boolean isEditable()

Returns whether or not the IlvFacesDiagrammerView is editable. An editable view allows users to add or remove nodes and links to the model. It also gives the ability to modify selected objects properties from the client. The default value is false.

Since:

JViews 8.0

setEditable

public void setEditable(boolean value)

Sets whether or not the IlvFacesDiagrammerView is editable. An editable view allows users to add or remove nodes and links to the model. It also gives the ability to modify selected objects properties from the client.

Parameters:

value - Whether the diagrammer is editable.

Since:

JViews 8.0

getDefaultObjectFinder

public IlvObjectSelectedFinder getDefaultObjectFinder()

Returns the default finder of this view.

Overrides:

getDefaultObjectFinder in class IlvFacesView

Returns:

The default finder if any, null otherwise.

Since:

JViews 7.5

Internal: do not use!

updateModel

public void updateModel(jakarta.faces.context.FacesContext context)

This method updates the referenced values with the local values of the component if these values were updated from the client.

Overrides:

updateModel in class IlvFacesView

Parameters:

context - The current faces context.

saveState

public Object saveState(jakarta.faces.context.FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvFacesView

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Restores the state of this component from the stateObj parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvFacesView

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.