public class IlvFacesDHTMLDiagrammerView extends IlvFacesDiagrammerView implements IlvFacesDHTMLViewSupport
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
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
DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS
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 and Description |
---|
IlvFacesDHTMLDiagrammerView()
Creates a new
IlvFacesDHTMLDiagrammerView instance. |
Modifier and Type | Method and Description |
---|---|
Color |
getBackgroundColor()
Returns the background color of the view
|
String |
getBeforeSessionExpirationHandler()
Returns the JavaScript code that will be called when the session is about to expire.
|
static String |
getComponentType()
Returns the type of this component.
|
String |
getControllerURL()
Returns the URL of the controller servlet.
|
IlvDiagrammer |
getDiagrammer()
Returns the
IlvDiagrammer instance wrapped by
this IlvFacesDiagrammer instance. |
String |
getErrorMessage()
Returns the message displayed by the view if an error occurred during the image
generation by the server.
|
String |
getFamily()
Returns the identifier of the component family to which this component
belongs.
|
String |
getImageFormat()
Returns the desired format of the image generated by the servlet.
|
IlvImageMapAreaGenerator |
getImageMapGenerator()
Returns the image map generator.
|
String |
getImageMapGeneratorClass()
Returns the image map generator class name.
|
String |
getOnCapabilitiesLoaded()
Returns the JavaScript code executed when the capabilities are loaded from
the server.
|
String |
getOnImageLoaded()
Returns the JavaScript code that is executed when the image is loaded.
|
String |
getServlet()
Returns the servlet that will generate the image displayed by the view.
|
String |
getServletClass() |
String |
getServletURL() |
String |
getStateURL()
Returns a string that represents the client view state.
|
IlvTileManager |
getTileManager()
Returns the tile manager.
|
int |
getUpdateInterval()
Returns the interval in seconds between two automatic updates.
|
IlvManagerView |
getView()
Returns the manager view that will be displayed by the view.
|
String |
getWaitingImage()
Returns the path to the image displayed when the view loads the image.
|
boolean |
isAccessible()
Returns whether the view is accessible or not.
|
boolean |
isGenerateImageMap()
Returns the flag indicating that an image map should be generated.
|
boolean |
isImageMapVisible()
Returns the flag indicating whether an image map should be visible or not (if
generated)
|
boolean |
isResizable()
Returns whether the view is resizable or not.
|
void |
restoreState(javax.faces.context.FacesContext context,
Object stateObj)
Restores the state of this component from the
stateObj parameter. |
Object |
saveState(javax.faces.context.FacesContext context)
Returns the state of this component.
|
void |
setAccessible(boolean accessible)
Sets whether the view is accessible or not.
|
void |
setBackgroundColor(Color backgroundColor)
Sets the background color of the view.
|
void |
setBeforeSessionExpirationHandler(String handler)
Sets the JavaScript code that will be called when the session is about to expire.
|
void |
setErrorMessage(String errorMessage)
The message displayed by the view if an error occurred during the image
generation by the server.
|
void |
setGenerateImageMap(boolean generateImageMap)
Sets the flag indicating whether an image map should be generated or not.
|
void |
setImageFormat(String imageFormat)
Sets the desired format of the image generated by the servlet.
|
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 flag indicating whether an image map should be visible or not (if generated)
|
void |
setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
The JavaScript code executed when the capabilities are loaded from the
server.
|
void |
setOnImageLoaded(String onImageLoaded)
The JavaScript code that is executed when the image is loaded.
|
void |
setResizable(boolean resizable)
Sets whether the view is resizable or not.
|
void |
setServlet(String servlet)
Sets the servlet that will generate the image displayed by the view.
|
void |
setServletClass(String servletClass) |
void |
setServletURL(String servletURL) |
void |
setStateURL(String clientState)
Sets the client state of the component.
|
void |
setTileManager(IlvTileManager tileManager)
Sets the tile manager.
|
void |
setUpdateInterval(int updateInterval)
The interval in seconds between two automatic updates.
|
void |
setValue(Object value)
Sets the servlet that will generate the image displayed by the view.
|
void |
setWaitingImage(String waitingImage)
Sets the path of the image displayed when the view loads the image.
|
void |
updateModel(javax.faces.context.FacesContext ctx)
This method updates the referenced values with the local values of the
component if these values were updated from the client.
|
getDataSource, getDataSourceId, getDefaultObjectFinder, getProject, getStyleSheets, isEditable, setDataSource, setDataSourceId, setDiagrammer, setEditable, setProject, setStyleSheets, showAll
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, setView, 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 IlvFacesDHTMLDiagrammerView()
IlvFacesDHTMLDiagrammerView
instance.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 IlvFacesDiagrammerView
public static String getComponentType()
public Color getBackgroundColor()
getBackgroundColor
in interface IlvFacesDHTMLViewSupport
public String getControllerURL() throws Exception
IllegalStateException
- if this type of request is not handled.Exception
public String getErrorMessage()
getErrorMessage
in interface IlvFacesDHTMLViewSupport
public String getImageFormat()
getImageFormat
in interface IlvDHTMLHelper
public String getOnCapabilitiesLoaded()
getOnCapabilitiesLoaded
in interface IlvFacesDHTMLViewSupport
capabilitiesLoaded
event.public String getOnImageLoaded()
getOnImageLoaded
in interface IlvFacesDHTMLViewSupport
imageLoaded
event.public String getServlet()
getServlet
in interface IlvDHTMLHelper
public String getServletClass()
getServletClass
in interface IlvDHTMLHelper
public String getServletURL()
getServletURL
in interface IlvDHTMLHelper
public String getStateURL()
getStateURL
in interface IlvFacesDHTMLViewSupport
public int getUpdateInterval()
getUpdateInterval
in interface IlvFacesDHTMLViewSupport
public String getWaitingImage()
getWaitingImage
in interface IlvDHTMLHelper
public boolean isGenerateImageMap()
isGenerateImageMap
in interface IlvFacesDHTMLViewSupport
true
if the image map will be generated, false
otherwise.public boolean isImageMapVisible()
isImageMapVisible
in interface IlvFacesDHTMLViewSupport
true
if the image map will be shown, false
otherwise.public void setBackgroundColor(Color backgroundColor)
setBackgroundColor
in interface IlvFacesDHTMLViewSupport
backgroundColor
- The background color to set.public void setErrorMessage(String errorMessage)
setErrorMessage
in interface IlvFacesDHTMLViewSupport
errorMessage
- The new error message to set.public void setGenerateImageMap(boolean generateImageMap)
setGenerateImageMap
in interface IlvFacesDHTMLViewSupport
generateImageMap
- The flag value to set.public void setImageFormat(String imageFormat)
setImageFormat
in interface IlvDHTMLHelper
imageFormat
- The desired image format of the image displayed by the view.public void setImageMapVisible(boolean imageMapVisible)
setImageMapVisible
in interface IlvFacesDHTMLViewSupport
imageMapVisible
- The flag value to set.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
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.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
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.public void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
setOnCapabilitiesLoaded
in interface IlvFacesDHTMLViewSupport
onCapabilitiesLoaded
- The new JavaScript function handler.public void setOnImageLoaded(String onImageLoaded)
setOnImageLoaded
in interface IlvFacesDHTMLViewSupport
onImageLoaded
- The new JavaScript function handler.public void setServlet(String servlet)
setValue
.
The servlet parameter could be a URL to the servlet or a fully qualified
servlet class that will be instantiated to generate the image.setServlet
in interface IlvDHTMLHelper
servlet
- The image generating servlet.public void setServletClass(String servletClass)
setServletClass
in interface IlvDHTMLHelper
public void setServletURL(String servletURL)
setServletURL
in interface IlvDHTMLHelper
public void setStateURL(String clientState)
setStateURL
in interface IlvFacesDHTMLViewSupport
clientState
- The client state of the component.public void setUpdateInterval(int updateInterval)
setUpdateInterval
in interface IlvFacesDHTMLViewSupport
updateInterval
- The new update interval to set.public void setValue(Object value)
setValue
in interface IlvDHTMLHelper
setValue
in class javax.faces.component.UIGraphic
value
- The image generating servlet.public void setWaitingImage(String waitingImage)
setWaitingImage
in interface IlvDHTMLHelper
waitingImage
- The path of the image displayed when the view loads the image.public boolean isResizable()
isResizable
in interface IlvFacesDHTMLViewSupport
public void setResizable(boolean resizable)
setResizable
in interface IlvFacesDHTMLViewSupport
resizable
- The resizable flag to set.public boolean isAccessible()
isAccessible
in interface IlvFacesDHTMLViewSupport
public void setAccessible(boolean accessible)
setAccessible
in interface IlvFacesDHTMLViewSupport
accessible
- The accessible flag to set.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 IlvManagerView getView() throws Exception
getView
in interface IlvFacesDHTMLViewSupport
getView
in class IlvFacesView
Exception
public IlvDiagrammer getDiagrammer() throws Exception
IlvDiagrammer
instance wrapped by
this IlvFacesDiagrammer
instance.getDiagrammer
in class IlvFacesDiagrammerView
IlvDiagrammer
instance.Exception
- If the session has expired between two requests the
IlvDiagrammer
instance was lost.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 updateModel(javax.faces.context.FacesContext ctx)
updateModel
in interface IlvDHTMLHelper
updateModel
in class IlvFacesDiagrammerView
ctx
- The current faces context.public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface IlvFacesComponent
saveState
in interface IlvDHTMLHelper
saveState
in interface javax.faces.component.StateHolder
saveState
in class IlvFacesDiagrammerView
context
- The current faces context.state
of this component.public void restoreState(javax.faces.context.FacesContext context, Object stateObj)
stateObj
parameter.restoreState
in interface IlvFacesComponent
restoreState
in interface IlvDHTMLHelper
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class IlvFacesDiagrammerView
context
- The current faces context.stateObj
- The previously saved state of this component.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.