public class IlvFacesDHTMLDashboardView extends IlvFacesDashboardView implements IlvFacesDHTMLViewSupport
MAX_ZOOM_DEFAULT_VALUE, MIN_ZOOM_DEFAULT_VALUE, PAN_FACTOR_DEFAULT_VALUE, ZOOM_FACTOR_DEFAULT_VALUEDEFAULT_OBJECT_FINDERATTRS_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_KEYACCESSIBLE, 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_IMAGEAFTER_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, WIDTHAUTO_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_LEVELSDASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS| Constructor and Description |
|---|
IlvFacesDHTMLDashboardView()
Creates a new
IlvFacesDHTMLDashboardView 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.
|
IlvDashboardDiagram |
getDashboardDiagram()
Returns the
IlvDashboardDiagram instance wrapped by
this IlvFacesDHTMLDashboardView 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(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 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(jakarta.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.
|
getDefaultObjectFinder, setDashboardDiagramgetBoundingBox, 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, setZoomLevelsclearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidthgetUrl, getValue, getValueBinding, getValueExpression, setUrl, setValueBinding, setValueExpressionaddClientBehavior, 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, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTreepublic IlvFacesDHTMLDashboardView()
IlvFacesDHTMLDashboardView 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 IlvFacesDashboardViewpublic static String getComponentType()
public Color getBackgroundColor()
getBackgroundColor in interface IlvFacesDHTMLViewSupportpublic String getControllerURL() throws Exception
IllegalStateException - if the type of the request is not handled.Exceptionpublic String getErrorMessage()
getErrorMessage in interface IlvFacesDHTMLViewSupportpublic String getImageFormat()
getImageFormat in interface IlvDHTMLHelperpublic String getOnCapabilitiesLoaded()
getOnCapabilitiesLoaded in interface IlvFacesDHTMLViewSupportcapabilitiesLoaded event.public String getOnImageLoaded()
getOnImageLoaded in interface IlvFacesDHTMLViewSupportimageLoaded event.public String getServlet()
getServlet in interface IlvDHTMLHelperpublic String getServletClass()
getServletClass in interface IlvDHTMLHelperpublic String getServletURL()
getServletURL in interface IlvDHTMLHelperpublic String getStateURL()
getStateURL in interface IlvFacesDHTMLViewSupportpublic int getUpdateInterval()
getUpdateInterval in interface IlvFacesDHTMLViewSupportpublic String getWaitingImage()
getWaitingImage in interface IlvDHTMLHelperpublic boolean isGenerateImageMap()
isGenerateImageMap in interface IlvFacesDHTMLViewSupporttrue if the image map will be generated, false otherwise.public boolean isImageMapVisible()
isImageMapVisible in interface IlvFacesDHTMLViewSupporttrue if the image map will be shown, false otherwise.public void setBackgroundColor(Color backgroundColor)
setBackgroundColor in interface IlvFacesDHTMLViewSupportbackgroundColor - The background color to set.public void setErrorMessage(String errorMessage)
setErrorMessage in interface IlvFacesDHTMLViewSupporterrorMessage - The new error message to set.public void setGenerateImageMap(boolean generateImageMap)
setGenerateImageMap in interface IlvFacesDHTMLViewSupportgenerateImageMap - The flag value to set.public void setImageFormat(String imageFormat)
setImageFormat in interface IlvDHTMLHelperimageFormat - The desired image format of the image displayed by the view.public void setImageMapVisible(boolean imageMapVisible)
setImageMapVisible in interface IlvFacesDHTMLViewSupportimageMapVisible - 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 IlvFacesDHTMLViewSupportpublic 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 IlvFacesDHTMLViewSupportimageMapGenerator - 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 IlvFacesDHTMLViewSupportpublic 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 IlvFacesDHTMLViewSupportimageMapGeneratorClass - The image map generator class name.public void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
setOnCapabilitiesLoaded in interface IlvFacesDHTMLViewSupportonCapabilitiesLoaded - The new JavaScript function handler.public void setOnImageLoaded(String onImageLoaded)
setOnImageLoaded in interface IlvFacesDHTMLViewSupportonImageLoaded - 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 IlvDHTMLHelperservlet - The image generating servlet.public void setServletClass(String servletClass)
setServletClass in interface IlvDHTMLHelperpublic void setServletURL(String servletURL)
setServletURL in interface IlvDHTMLHelperpublic void setStateURL(String clientState)
setStateURL in interface IlvFacesDHTMLViewSupportclientState - The client state of the component.public void setUpdateInterval(int updateInterval)
setUpdateInterval in interface IlvFacesDHTMLViewSupportupdateInterval - The new update interval to set.public void setValue(Object value)
setValue in interface IlvDHTMLHelpersetValue in class jakarta.faces.component.UIGraphicvalue - The image generating servlet.public void setWaitingImage(String waitingImage)
setWaitingImage in interface IlvDHTMLHelperwaitingImage - The path of the image displayed when the view loads the image.public boolean isResizable()
isResizable in interface IlvFacesDHTMLViewSupportpublic void setResizable(boolean resizable)
setResizable in interface IlvFacesDHTMLViewSupportresizable - The resizable flag to set.public boolean isAccessible()
isAccessible in interface IlvFacesDHTMLViewSupportpublic void setAccessible(boolean accessible)
setAccessible in interface IlvFacesDHTMLViewSupportaccessible - 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 IlvFacesDHTMLViewSupportpublic 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 IlvFacesDHTMLViewSupporttileManager - The tile manager to set.public String getBeforeSessionExpirationHandler()
getBeforeSessionExpirationHandler in interface IlvFacesDHTMLViewSupportpublic void setBeforeSessionExpirationHandler(String handler)
This code can use the view implicit variable that represents the JavaScript proxy of this component.
setBeforeSessionExpirationHandler in interface IlvFacesDHTMLViewSupporthandler - The JavasScript code.public IlvManagerView getView() throws Exception
getView in interface IlvFacesDHTMLViewSupportgetView in class IlvFacesViewExceptionpublic IlvDashboardDiagram getDashboardDiagram() throws Exception
IlvDashboardDiagram instance wrapped by
this IlvFacesDHTMLDashboardView instance.
If the diagrammer does not already exist, create an
IlvDashboardDiagram.getDashboardDiagram in class IlvFacesDashboardViewIlvDashboardDiagram instance.Exceptionpublic void updateModel(jakarta.faces.context.FacesContext ctx)
updateModel in interface IlvDHTMLHelperupdateModel in class IlvFacesViewctx - The current faces context.public Object saveState(jakarta.faces.context.FacesContext context)
saveState in interface IlvFacesComponentsaveState in interface IlvDHTMLHelpersaveState in interface jakarta.faces.component.StateHoldersaveState in class IlvFacesViewcontext - The current faces context.state of this component.public void restoreState(jakarta.faces.context.FacesContext context,
Object stateObj)
stateObj parameter.restoreState in interface IlvFacesComponentrestoreState in interface IlvDHTMLHelperrestoreState in interface jakarta.faces.component.StateHolderrestoreState in class IlvFacesViewcontext - The current faces context.stateObj - The previously saved state of this component.© Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.