public class IltFacesDHTMLNetworkView extends IltFacesNetworkView implements IlvDHTMLFrameworkConstants, IlvFacesDHTMLViewSupport
This class defines the JTGO Network Faces component for DHTML rendering.
DefaultConfigurationFileName
MAX_ZOOM_DEFAULT_VALUE, MIN_ZOOM_DEFAULT_VALUE, PAN_FACTOR_DEFAULT_VALUE, ZOOM_FACTOR_DEFAULT_VALUE
DEFAULT_OBJECT_FINDER
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
SESSION_ID_PREFIX, STATE_URL, STATIC_LAYERS_COUNT_PARAM, TILE_MANAGER, UPDATE_INTERVAL
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
ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE
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
CONTEXT, DATA_SOURCE, DATA_SOURCE_ID, DEFAULT_STYLE_SHEET, EQUIPMENT, NETWORK, OBJECT_ACTION_MB, PROPERTY_ACCESSOR, STYLE_SHEETS
Constructor and Description |
---|
IltFacesDHTMLNetworkView()
Creates a new
IltFacesDHTMLNetworkView instance. |
Modifier and Type | Method and Description |
---|---|
protected IlpNetwork |
createNetworkComponent(String defaultStyleSheet,
IlpContext context)
Method called only once when creating the underlying
IlpNetwork . |
Color |
getBackgroundColor()
Returns the backgroundColor property.
|
String |
getBeforeSessionExpirationHandler()
Returns the JavaScript code that will be called when the session is about to expire.
|
static String |
getComponentType()
Returns the component type identifier of this component.
|
String |
getControllerURL()
Retrieves the
controllerURL property. |
String |
getErrorMessage()
Returns the errorMessage property.
|
String |
getFamily()
Returns the identifier of the component family to which this component
belongs.
|
String |
getImageFormat()
Retrieves the
imageFormat property. |
IlvImageMapAreaGenerator |
getImageMapGenerator()
Returns the image map generator.
|
String |
getImageMapGeneratorClass()
Returns the image map generator class name.
|
IlpNetwork |
getNetwork()
Returns the
IlpNetwork instance wrapped by this
IltFacesNetworkView instance. |
String |
getOnCapabilitiesLoaded()
Retrieves the
onCapabilitiesLoaded property. |
String |
getOnImageLoaded()
Retrieves the
onImageLoaded property. |
String |
getServlet()
Retrieves the
servlet property. |
String |
getServletClass()
Retrieves the
servletClass property. |
String |
getServletURL()
Retrieves the
servletURL property. |
String |
getStateURL()
Retrieves the
stateURL property. |
IlvTileManager |
getTileManager()
Returns the tile manager.
|
int |
getUpdateInterval()
Retrieves the
updateInterval property. |
IlvManagerView |
getView()
Returns the
IlvManagerView associated with the
IlpNetworkView . |
String |
getWaitingImage()
Retrieves the
waitingImage property. |
boolean |
isAccessible()
Returns whether the
accessible property is
true or false . |
boolean |
isGenerateImageMap()
Returns whether the
generateImageMap property is
true or false . |
boolean |
isImageMapVisible()
Returns whether the
imageMapVisible property is
true or false . |
boolean |
isResizable()
Returns whether the
resizable property is
true or false . |
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 |
setAccessible(boolean accessible)
Sets the
accessible property. |
void |
setBackgroundColor(Color backgroundColor)
Sets the
backgroundColor property. |
void |
setBeforeSessionExpirationHandler(String handler)
Sets the JavaScript code that will be called when the session is about to expire.
|
void |
setErrorMessage(String errorMessage)
Sets the
errorMessage property. |
void |
setGenerateImageMap(boolean generateImageMap)
Sets the
generateImageMap property. |
void |
setImageFormat(String imageFormat)
Sets the
imageFormat property. |
void |
setImageMapGenerator(IlvImageMapAreaGenerator imageMapGenerator)
Sets the image map generator.
|
void |
setImageMapGeneratorClass(String imageMapGeneratorClass)
Sets the image map generator class name.
|
void |
setImageMapVisible(boolean imageMapVisible)
Sets the
imageMapVisible property. |
void |
setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
Sets the
onCapabilitiesLoaded property. |
void |
setOnImageLoaded(String onImageLoaded)
Sets the
onImageLoaded property. |
void |
setResizable(boolean resizable)
Sets the
resizable property. |
void |
setServlet(String servlet)
Sets the
servlet property. |
void |
setServletClass(String servletClass)
Sets the
servletClass property. |
void |
setServletURL(String servletURL)
Sets the
servletURL property. |
void |
setStateURL(String clientState)
Sets the
stateURL property. |
void |
setTileManager(IlvTileManager tileManager)
Sets the tile manager.
|
void |
setUpdateInterval(int updateInterval)
Sets the
updateInterval property. |
void |
setValue(Object value)
Sets the
value property. |
void |
setWaitingImage(String waitingImage)
Sets the
waitingImage property. |
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.
|
getDefaultStyleSheet, setNetwork
getBoundingBox, getBoundingBox, getContext, getDataSource, getDataSourceId, getDefaultObjectFinder, getGraphView, getProject, getStyleSheets, setContext, setDataSource, setDataSourceId, setDefaultStyleSheet, setProject, setStyleSheets, setView, supportsDynamicLayers
getBoundingBox, getHitmapLayers, getHotkeys, getInteractor, getInteractorId, getMaxZoomLevel, getMinZoomLevel, getPanFactor, getScrollBar, getStaticLayersCount, getTileSize, getVisibleLayers, getZoomFactor, getZoomLevels, isConstrainedOnContents, isProgressiveZoom, processValidators, setBoundingBox, setConstrainedOnContents, setHitmapLayers, setHotkeys, setInteractor, setInteractorId, setMaxZoomLevel, setMinZoomLevel, setPanFactor, setProgressiveZoom, setScrollBar, setStaticLayersCount, setTileSize, setVisibleLayers, setZoomFactor, setZoomLevels
clearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth
getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValueBinding, setValueExpression
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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree
public IltFacesDHTMLNetworkView()
IltFacesDHTMLNetworkView
instance.public static String getComponentType()
public int getUpdateInterval()
Retrieves the updateInterval
property.
getUpdateInterval
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.getUpdateInterval()
public void setUpdateInterval(int updateInterval)
Sets the updateInterval
property.
setUpdateInterval
in interface IlvFacesDHTMLViewSupport
updateInterval
- The new update interval to set.IlvFacesDHTMLViewSupport.setUpdateInterval(int)
public boolean isGenerateImageMap()
Returns whether the generateImageMap
property is
true
or false
.
isGenerateImageMap
in interface IlvFacesDHTMLViewSupport
true
if the image map will be generated, false
otherwise.IlvFacesDHTMLViewSupport.isGenerateImageMap()
public void setGenerateImageMap(boolean generateImageMap)
Sets the generateImageMap
property.
setGenerateImageMap
in interface IlvFacesDHTMLViewSupport
generateImageMap
- The flag value to set.IlvFacesDHTMLViewSupport.setGenerateImageMap(boolean)
public boolean isImageMapVisible()
Returns whether the imageMapVisible
property is
true
or false
.
isImageMapVisible
in interface IlvFacesDHTMLViewSupport
true
if the image map will be shown, false
otherwise.IlvFacesDHTMLViewSupport.isImageMapVisible()
public void setImageMapVisible(boolean imageMapVisible)
Sets the imageMapVisible
property.
setImageMapVisible
in interface IlvFacesDHTMLViewSupport
imageMapVisible
- The flag value to set.IlvFacesDHTMLViewSupport.setImageMapVisible(boolean)
public IlvImageMapAreaGenerator getImageMapGenerator()
Returns the image map generator.
If thegenerateImageMap
property is true
,
this generator will be invoked to dynamically create the image map.
getImageMapGenerator
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.getImageMapGenerator()
public void setImageMapGenerator(IlvImageMapAreaGenerator imageMapGenerator)
Sets the image map generator.
If thegenerateImageMap
property is true
,
this generator will be invoked to dynamically create the image map.
setImageMapGenerator
in interface IlvFacesDHTMLViewSupport
imageMapGenerator
- The image map generator.IlvFacesDHTMLViewSupport.setImageMapGenerator(ilog.views.servlet.IlvImageMapAreaGenerator)
public String getImageMapGeneratorClass()
Returns the image map generator class name.
If the generateImageMap
property is true
,
and the imageMapgenerator
property is not set, an instance
of this generator will be created and this generator will be invoked to
dynamically create the image map.
getImageMapGeneratorClass
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.getImageMapGeneratorClass()
public void setImageMapGeneratorClass(String imageMapGeneratorClass)
Sets the image map generator class name.
If the generateImageMap
property is true
,
and the imageMapgenerator
property is not set, an instance
of this generator will be created and this generator will be invoked to
dynamically create the image map.
setImageMapGeneratorClass
in interface IlvFacesDHTMLViewSupport
imageMapGeneratorClass
- The image map generator class name.IlvFacesDHTMLViewSupport.setImageMapGeneratorClass(java.lang.String)
public Color getBackgroundColor()
Returns the backgroundColor property.
getBackgroundColor
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.getBackgroundColor()
public void setBackgroundColor(Color backgroundColor)
Sets the backgroundColor
property.
setBackgroundColor
in interface IlvFacesDHTMLViewSupport
backgroundColor
- The background color to set.IlvFacesDHTMLViewSupport.setBackgroundColor(java.awt.Color)
public String getOnImageLoaded()
Retrieves the onImageLoaded
property.
getOnImageLoaded
in interface IlvFacesDHTMLViewSupport
imageLoaded
event.IlvFacesDHTMLViewSupport.getOnImageLoaded()
public void setOnImageLoaded(String onImageLoaded)
Sets the onImageLoaded
property.
setOnImageLoaded
in interface IlvFacesDHTMLViewSupport
onImageLoaded
- The new JavaScript function handler.IlvFacesDHTMLViewSupport.setOnImageLoaded(java.lang.String)
public String getOnCapabilitiesLoaded()
Retrieves the onCapabilitiesLoaded
property.
getOnCapabilitiesLoaded
in interface IlvFacesDHTMLViewSupport
capabilitiesLoaded
event.IlvFacesDHTMLViewSupport.getOnCapabilitiesLoaded()
public void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
Sets the onCapabilitiesLoaded
property.
setOnCapabilitiesLoaded
in interface IlvFacesDHTMLViewSupport
onCapabilitiesLoaded
- The new JavaScript function handler.IlvFacesDHTMLViewSupport.setOnCapabilitiesLoaded(java.lang.String)
public String getErrorMessage()
Returns the errorMessage property.
getErrorMessage
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.getErrorMessage()
public void setErrorMessage(String errorMessage)
Sets the errorMessage
property.
setErrorMessage
in interface IlvFacesDHTMLViewSupport
errorMessage
- The new error message to set.IlvFacesDHTMLViewSupport.setErrorMessage(java.lang.String)
public String getStateURL()
Retrieves the stateURL
property.
getStateURL
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.getStateURL()
public void setStateURL(String clientState)
Sets the stateURL
property.
setStateURL
in interface IlvFacesDHTMLViewSupport
clientState
- The client state of the component.IlvFacesDHTMLViewSupport.setStateURL(java.lang.String)
public boolean isResizable()
Returns whether the resizable
property is
true
or false
.
isResizable
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.isResizable()
public void setResizable(boolean resizable)
Sets the resizable
property.
setResizable
in interface IlvFacesDHTMLViewSupport
resizable
- The resizable flag to set.IlvFacesDHTMLViewSupport.setResizable(boolean)
public void setAccessible(boolean accessible)
Sets the accessible
property.
setAccessible
in interface IlvFacesDHTMLViewSupport
accessible
- The accessible flag to set.IlvFacesDHTMLViewSupport.setAccessible(boolean)
public boolean isAccessible()
Returns whether the accessible
property is
true
or false
.
isAccessible
in interface IlvFacesDHTMLViewSupport
IlvFacesDHTMLViewSupport.isAccessible()
public IlvManagerView getView() throws Exception
Returns the IlvManagerView
associated with the
IlpNetworkView
.
getView
in interface IlvFacesDHTMLViewSupport
getView
in class IlvFacesView
Exception
public IlvTileManager getTileManager()
The tile manager is used when the view is tiled, that is, if the tileSize
property is greater or equals to 0.
getTileManager
in interface IlvFacesDHTMLViewSupport
public void setTileManager(IlvTileManager tileManager)
The tile manager is used when the view is tiled, that is, if the tileSize
property is greater or equals to 0.
setTileManager
in interface IlvFacesDHTMLViewSupport
tileManager
- The tile manager to set.public String getBeforeSessionExpirationHandler()
getBeforeSessionExpirationHandler
in interface IlvFacesDHTMLViewSupport
public void setBeforeSessionExpirationHandler(String handler)
This code can use the view
implicit variable that represents the JavaScript proxy of this component.
setBeforeSessionExpirationHandler
in interface IlvFacesDHTMLViewSupport
handler
- The JavasScript code.public void setServlet(String servlet)
Sets the servlet
property.
setServlet
in interface IlvDHTMLHelper
servlet
- The image generating servlet.IlvDHTMLHelper.setServlet(java.lang.String)
public String getServlet()
Retrieves the servlet
property.
getServlet
in interface IlvDHTMLHelper
IlvDHTMLHelper.getServlet()
public void setServletClass(String servletClass)
Sets the servletClass
property.
setServletClass
in interface IlvDHTMLHelper
IlvDHTMLHelper.setServletClass(java.lang.String)
public String getServletClass()
Retrieves the servletClass
property.
getServletClass
in interface IlvDHTMLHelper
IlvDHTMLHelper.getServletClass()
public void setServletURL(String servletURL)
Sets the servletURL
property.
setServletURL
in interface IlvDHTMLHelper
IlvDHTMLHelper.setServletURL(java.lang.String)
public String getServletURL()
Retrieves the servletURL
property.
getServletURL
in interface IlvDHTMLHelper
IlvDHTMLHelper.getServletURL()
public String getImageFormat()
Retrieves the imageFormat
property.
getImageFormat
in interface IlvDHTMLHelper
IlvDHTMLHelper.getImageFormat()
public String getWaitingImage()
Retrieves the waitingImage
property.
getWaitingImage
in interface IlvDHTMLHelper
IlvDHTMLHelper.getWaitingImage()
public void setImageFormat(String imageFormat)
Sets the imageFormat
property.
setImageFormat
in interface IlvDHTMLHelper
imageFormat
- The desired image format of the image displayed by the view.IlvDHTMLHelper.setImageFormat(java.lang.String)
public void setWaitingImage(String waitingImage)
Sets the waitingImage
property.
setWaitingImage
in interface IlvDHTMLHelper
waitingImage
- The path of the image displayed when the view loads the image.IlvDHTMLHelper.setWaitingImage(java.lang.String)
public String getControllerURL() throws Exception
Retrieves the controllerURL
property.
Exception
IlvDHTMLUtil.getControllerURL()
protected IlpNetwork createNetworkComponent(String defaultStyleSheet, IlpContext context)
Method called only once when creating the underlying
IlpNetwork
.
createNetworkComponent
in class IltFacesNetworkView
defaultStyleSheet
- The default CSS style sheet to be applied.context
- the JTGO context to be used.IlpNetwork
.public IlpNetwork getNetwork() throws Exception
Returns the IlpNetwork
instance wrapped by this
IltFacesNetworkView
instance.
getNetwork
in class IltFacesNetworkView
IlpNetwork
instance.Exception
- If the session has expired between two requests
and the IlpNetwork
instance was lost.public void updateModel(jakarta.faces.context.FacesContext context)
updateModel
in interface IlvDHTMLHelper
updateModel
in class IltFacesGraphView
context
- The current faces context.public Object saveState(jakarta.faces.context.FacesContext context)
saveState
in interface IlvFacesComponent
saveState
in interface IlvDHTMLHelper
saveState
in interface jakarta.faces.component.StateHolder
saveState
in class IltFacesGraphView
context
- The current faces context.state
of this component.public void restoreState(jakarta.faces.context.FacesContext context, Object stateObj)
stateObj
parameter.restoreState
in interface IlvFacesComponent
restoreState
in interface IlvDHTMLHelper
restoreState
in interface jakarta.faces.component.StateHolder
restoreState
in class IltFacesGraphView
context
- The current faces context.stateObj
- The previously saved state of this component.public void setValue(Object value)
Sets the value
property.
setValue
in interface IlvDHTMLHelper
setValue
in class jakarta.faces.component.UIGraphic
value
- The image generating servlet.UIGraphic.setValue(java.lang.Object)
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.
getFamily
in class IltFacesNetworkView
© Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.