ilog.tgo.faces.graph.component
Class IltFacesGraphView

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIGraphic
              ilog.views.faces.component.IlvBasicView
                  ilog.views.faces.component.IlvFacesView
                      ilog.tgo.faces.graph.component.IltFacesGraphView

All Implemented Interfaces:

IltFacesJTGOConstants, IlvFacesComponent, IlvFacesConstants, IlvFrameworkConstants, Serializable, StateHolder

Direct Known Subclasses:

IltFacesEquipmentView, IltFacesNetworkView

public abstract class IltFacesGraphView
extends IlvFacesView
implements IlvFacesConstants, IltFacesJTGOConstants

This class defines the basic Graph View Faces component, which holds common properties for both Network and Equipment View components.

Since:

JViews 7.5

See Also:

IlvFacesView, IlvFacesConstants, IltFacesJTGOConstants, 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 javax.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Fields inherited from interface ilog.tgo.faces.IltFacesJTGOConstants

CONTEXT, DATA_SOURCE, DATA_SOURCE_ID, DEFAULT_STYLE_SHEET, EQUIPMENT, NETWORK, OBJECT_ACTION_MB, PROPERTY_ACCESSOR, STYLE_SHEETS

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

ACTION_NAME, AUTO_REFRESH, BOUNDING_BOX, CONSTRAINED_ON_CONTENTS, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TILE_SIZE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Constructor Summary

IltFacesGraphView()
Creates a new IltFacesGraphView.

Method Summary

IlvRect	getBoundingBox(Collection objects) Returns the combined bounding box of the IlpRepresentationObject instances contained in the Collection provided in manager coordinates.
IlvRect	getBoundingBox(IlpRepresentationObject object) Returns the bounding box of the given IlpRepresentationObject instance in manager coordinates.
IlpContext	getContext() Returns the JTGO context.
IltFacesDataSource	getDataSource() Returns the data source.
String	getDataSourceId() Returns the data source identifier.
IlvObjectSelectedFinder	getDefaultObjectFinder() Returns the default finder of this view.
String	getDefaultStyleSheet() Returns the URL of the default style sheet.
IlpGraphView	getGraphView() Access the view component.
String	getProject() Returns the component project configuration.
String	getStyleSheets() Returns the comma separated list of style sheets URL.
void	restoreState(FacesContext context, Object stateObj) Restores the state of this component from the stateObj parameter.
Object	saveState(FacesContext context) Returns the state of this component.
void	setContext(IlpContext context) Sets the JTGO context.
void	setDataSource(IltFacesDataSource dataSource) Sets the IltFacesDataSource data source.
void	setDataSourceId(String dataSourceId) Sets the data source identifier.
void	setDefaultStyleSheet(String defSSheets) Sets the URL of the default style sheet.
void	setProject(String proj) Sets the component project configuration.
void	setStyleSheets(String styleSheets) Sets the comma separated list of style sheets URL.
void	setView(IlvManagerView view) Sets the manager view that will be displayed by the view.
protected boolean	supportsDynamicLayers() Returns a boolean determining if this component supports dynamic layers.
void	updateModel(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, getInteractor, getInteractorId, getMaxZoomLevel, getMinZoomLevel, getPanFactor, getStaticLayersCount, getTileSize, getView, getVisibleLayers, getZoomFactor, getZoomLevels, isConstrainedOnContents, processValidators, setBoundingBox, setConstrainedOnContents, setInteractor, setInteractorId, setMaxZoomLevel, setMinZoomLevel, setPanFactor, setStaticLayersCount, setTileSize, setVisibleLayers, setZoomFactor, setZoomLevels

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

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

Methods inherited from class javax.faces.component.UIGraphic

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

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Constructor Detail

IltFacesGraphView

public IltFacesGraphView()

Creates a new IltFacesGraphView.

Method Detail

getContext

public IlpContext getContext()

Returns the JTGO context.

setContext

public void setContext(IlpContext context)

Sets the JTGO context.

Parameters:

context - The JTGO context to be set.

getDataSource

public IltFacesDataSource getDataSource()

Returns the data source.

setDataSource

public void setDataSource(IltFacesDataSource dataSource)

Sets the IltFacesDataSource data source.

Parameters:

dataSource - The data source to be set.

getDataSourceId

public String getDataSourceId()

Returns the data source identifier.

setDataSourceId

public void setDataSourceId(String dataSourceId)

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

Parameters:

dataSourceId - The data source ID to be set.

getStyleSheets

public String getStyleSheets()

Returns the comma separated 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 be set.

getDefaultStyleSheet

public String getDefaultStyleSheet()

Returns the URL of the default style sheet.

setDefaultStyleSheet

public void setDefaultStyleSheet(String defSSheets)

Sets the URL of the default style sheet.

Parameters:

defSSheets - The default style sheet to be set.

getProject

public String getProject()

Returns the component project configuration.

setProject

public void setProject(String proj)

Sets the component project configuration.

Parameters:

proj - The new project configuration.

getGraphView

public IlpGraphView getGraphView()

Access the view component.

Returns:

The underlying IlpGraphView.

Internal method or field: do not use!

setView

public void setView(IlvManagerView view)

Sets the manager view that will be displayed by the view.

Overrides:

setView in class IlvFacesView

Parameters:

view - The manager view to be displayed.

getBoundingBox

public IlvRect getBoundingBox(IlpRepresentationObject object)

Returns the bounding box of the given IlpRepresentationObject instance in manager coordinates.

The bounding box returned is based on the transformer of the current view. It includes the base rectangle plus all decorations.

Parameters:

object - The representation object whose bounding box you wish to compute.

Returns:

The bounding box of object in manager coordinates according to the current view transformer. If object is not currently visible, null is returned.

Throws:

IllegalArgumentException - if object is null.

Since:

JViews 8.1

getBoundingBox

public IlvRect getBoundingBox(Collection objects)

Returns the combined bounding box of the IlpRepresentationObject instances contained in the Collection provided in manager coordinates.

The bounding box is based on the transformer of the current view. It includes the base rectangle plus all decorations of each object.

Parameters:

objects - The Collection of representation objects whose bounding box you wish to compute.

Returns:

The bounding box of objects in manager coordinates according to the current view transformer. If none of the objects in objects is currently visible, null is returned.

Throws:

IllegalArgumentException - if any object in objects is not an IlpRepresentationObject instance or if objects is null.

Since:

JViews 8.1

supportsDynamicLayers

protected boolean supportsDynamicLayers()

Returns a boolean determining if this component supports dynamic layers.

This component supports dynamic layers when it is interacted with interactor faces components using the JSF lifecycle.

Returns:

true if dynamic layers are supported and false otherwise.

Internal method or field: do not use!

getDefaultObjectFinder

public IlvObjectSelectedFinder getDefaultObjectFinder()

Returns the default finder of this view.

Overrides:

getDefaultObjectFinder in class IlvFacesView

Returns:

The default finder, if any, or null.

Internal method or field: do not use!

updateModel

public void updateModel(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(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvFacesView

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(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 StateHolder

Overrides:

restoreState in class IlvFacesView

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.