ilog.tgo.faces.equipment.component
Class IltFacesEquipmentView

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
                          ilog.tgo.faces.equipment.component.IltFacesEquipmentView

All Implemented Interfaces:

IltFacesJTGOConstants, IlvFacesComponent, IlvFacesConstants, IlvFrameworkConstants, Serializable, StateHolder

Direct Known Subclasses:

IltFacesDHTMLEquipmentView

public abstract class IltFacesEquipmentView
extends IltFacesGraphView

This class defines the basic JTGO equipment faces component.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

static String

DefaultConfigurationFileName The file name of the default faces configuration.

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

protected

IltFacesEquipmentView() Creates a new IltFacesEquipmentView instance.

Method Summary

protected abstract IlpEquipment	createEquipmentComponent(String defaultStyleSheet, IlpContext context) Method called only once when creating the underlying IlpEquipment.
static String	getComponentType() Returns the component type identifier of this component.
String	getDefaultStyleSheet() Returns the URL of the default style sheet.
IlpEquipment	getEquipment() Returns the IlpEquipment instance wrapped by this IltFacesEquipmentView instance.
String	getFamily() Returns the identifier of the component family to which this component belongs.
void	setEquipment(IlpEquipment equipment) Sets the IlpEquipment wrapped by this IltFacesEquipmentView instance.

Methods inherited from class ilog.tgo.faces.graph.component.IltFacesGraphView

getBoundingBox, getBoundingBox, getContext, getDataSource, getDataSourceId, getDefaultObjectFinder, getGraphView, getProject, getStyleSheets, restoreState, saveState, setContext, setDataSource, setDataSourceId, setDefaultStyleSheet, setProject, setStyleSheets, setView, supportsDynamicLayers, updateModel

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

Field Detail

DefaultConfigurationFileName

public static String DefaultConfigurationFileName

The file name of the default faces configuration. It should be resolved using an IlpURLAccessService object.

Customized instances of IlpEquipment should be declared in the following way:

   IlpEquipment myEquipment = new IlpEquipment(IltFacesEquipmentView.DefaultConfigurationFileName, myContext);
 

Constructor Detail

IltFacesEquipmentView

protected IltFacesEquipmentView()

Creates a new IltFacesEquipmentView instance.

Method Detail

setEquipment

public void setEquipment(IlpEquipment equipment)

Sets the IlpEquipment wrapped by this IltFacesEquipmentView instance.

Parameters:

equipment - The IlpEquipment instance to set.

getDefaultStyleSheet

public String getDefaultStyleSheet()

Returns the URL of the default style sheet.

Overrides:

getDefaultStyleSheet in class IltFacesGraphView

createEquipmentComponent

protected abstract IlpEquipment createEquipmentComponent(String defaultStyleSheet,
                                                         IlpContext context)

Method called only once when creating the underlying IlpEquipment.

Parameters:

defaultStyleSheet - The default CSS style sheet to be applied.

context - The ILOG JTGO context to be used.

Returns:

The newly created IlpEquipment.

getEquipment

public IlpEquipment getEquipment()
                          throws Exception

Returns the IlpEquipment instance wrapped by this IltFacesEquipmentView instance.

Returns:

The IlpEquipment instance.

Throws:

Exception - If the session has expired between two requests and the IlpEquipment instance was lost.

getComponentType

public static String getComponentType()

Returns the component type identifier of this component.

Returns:

The component type identifier of this component.

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.