ilog.views.faces.dhtml.component
Interface IlvFacesDHTMLViewSupport

All Superinterfaces:

IlvDHTMLConstants, IlvDHTMLHelper, IlvFacesConstants, Serializable

All Known Implementing Classes:

IlvFacesDHTMLDashboardView, IlvFacesDHTMLDiagrammerView, IlvFacesDHTMLMapView, IlvFacesDHTMLView, IlvFacesDHTMLViewSupportImpl

public interface IlvFacesDHTMLViewSupport
extends IlvDHTMLHelper

This interface defines a class that handles the necessary properties to render a DHTML view.

Since:

JViews 6.5

Field Summary

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, 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, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

Method Summary

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.
String	getErrorMessage() Returns the message displayed by the view if an error occurred during the image generation by the server.
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	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 to be displayed by the helped view.
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	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	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	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.

Methods inherited from interface ilog.views.faces.dhtml.component.IlvDHTMLHelper

getImageFormat, getServlet, getServletClass, getServletURL, getWaitingImage, restoreState, saveState, setImageFormat, setServlet, setServletClass, setServletURL, setValue, setWaitingImage, updateModel

Method Detail

getUpdateInterval

int getUpdateInterval()

Returns the interval in seconds between two automatic updates.

Returns:

The update interval.

setUpdateInterval

void setUpdateInterval(int updateInterval)

The interval in seconds between two automatic updates.

Parameters:

updateInterval - The new update interval to set.

isGenerateImageMap

boolean isGenerateImageMap()

Returns the flag indicating that an image map should be generated.

Returns:

true if the image map will be generated, false otherwise.

setGenerateImageMap

void setGenerateImageMap(boolean generateImageMap)

Sets the flag indicating whether an image map should be generated or not.

Parameters:

generateImageMap - The flag value to set.

isImageMapVisible

boolean isImageMapVisible()

Returns the flag indicating whether an image map should be visible or not (if generated)

Returns:

true if the image map will be shown, false otherwise.

setImageMapVisible

void setImageMapVisible(boolean imageMapVisible)

Sets the flag indicating whether an image map should be visible or not (if generated)

Parameters:

imageMapVisible - The flag value to set.

getImageMapGenerator

IlvImageMapAreaGenerator getImageMapGenerator()

Returns the image map generator.

If thegenerateImageMap property is true, this generator will be invoked to dynamically create the image map.

Returns:

The image map generator.

Since:

JViews 7.5

setImageMapGenerator

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.

Parameters:

imageMapGenerator - The image map generator.

Since:

JViews 7.5

getImageMapGeneratorClass

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.

Returns:

The image map generator class name.

Since:

JViews 7.5

setImageMapGeneratorClass

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.

Parameters:

imageMapGeneratorClass - The image map generator class name.

Since:

JViews 7.5

getBackgroundColor

Color getBackgroundColor()

Returns the background color of the view

Returns:

The background color of the view.

setBackgroundColor

void setBackgroundColor(Color backgroundColor)

Sets the background color of the view.

Parameters:

backgroundColor - The background color to set.

getOnImageLoaded

String getOnImageLoaded()

Returns the JavaScript code that is executed when the image is loaded.

Returns:

The JavaScript function registered on the imageLoaded event.

setOnImageLoaded

void setOnImageLoaded(String onImageLoaded)

The JavaScript code that is executed when the image is loaded.

Parameters:

onImageLoaded - The new JavaScript function handler.

getOnCapabilitiesLoaded

String getOnCapabilitiesLoaded()

Returns the JavaScript code executed when the capabilities are loaded from the server.

Returns:

The JavaScript function registered on the capabilitiesLoaded event.

setOnCapabilitiesLoaded

void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)

The JavaScript code executed when the capabilities are loaded from the server.

Parameters:

onCapabilitiesLoaded - The new JavaScript function handler.

getErrorMessage

String getErrorMessage()

Returns the message displayed by the view if an error occurred during the image generation by the server.

Returns:

The message when an error occurred.

setErrorMessage

void setErrorMessage(String errorMessage)

The message displayed by the view if an error occurred during the image generation by the server.

Parameters:

errorMessage - The new error message to set.

getStateURL

String getStateURL()

Returns a string that represents the client view state.

Returns:

The client state of the component.

setStateURL

void setStateURL(String clientState)

Sets the client state of the component.

Parameters:

clientState - The client state of the component.

isResizable

boolean isResizable()

Returns whether the view is resizable or not.

Returns:

The resizable flag.

setResizable

void setResizable(boolean resizable)

Sets whether the view is resizable or not.

Parameters:

resizable - The resizable flag to set.

getView

IlvManagerView getView()
                       throws Exception

Returns the manager view to be displayed by the helped view.

Returns:

The manager view.

Throws:

Exception

getTileManager

IlvTileManager getTileManager()

Returns the tile manager. The tile manager is responsible for retrieving and/or storing image tiles on the server side.

The tile manager is used when the view is tiled, that is, if the tileSize property is greater or equals to 0.

Returns:

The tile manager.

Since:

JViews 8.0

setTileManager

void setTileManager(IlvTileManager tileManager)

Sets the tile manager.

The tile manager is used when the view is tiled, that is, if the tileSize property is greater or equals to 0.

Parameters:

tileManager - The tile manager to set.

Since:

JViews 8.0

setBeforeSessionExpirationHandler

void setBeforeSessionExpirationHandler(String handler)

Sets the JavaScript code that will be called when the session is about to expire.

This code can use the view implicit variable that represents the JavaScript proxy of this component.

Parameters:

handler - The JavasScript code.

Since:

JViews 8.1

getBeforeSessionExpirationHandler

String getBeforeSessionExpirationHandler()

Returns the JavaScript code that will be called when the session is about to expire.

Returns:

The JavasScript code to execute when the session is about to expire.

Since:

JViews 8.1