ilog.views.faces.dhtml.taglib
Class IlvFacesViewTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      javax.faces.webapp.UIComponentBodyTag
          ilog.views.faces.taglib.IlvBaseTag
              ilog.views.faces.taglib.IlvSizedTag
                  ilog.views.faces.dhtml.taglib.IlvDHTMLSizedTag
                      ilog.views.faces.dhtml.taglib.IlvDHTMLViewTag
                          ilog.views.faces.dhtml.taglib.IlvFacesViewTag

All Implemented Interfaces:

IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

IlvFacesDashboardViewTag, IlvFacesDiagrammerViewTag

public class IlvFacesViewTag
extends IlvDHTMLViewTag
implements IlvDHTMLFrameworkConstants

This class defines the JSP custom tag handler for the IlvFacesDHTMLView component and its DHTML renderer.

Since:

JViews 6.5

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentBodyTag

bodyContent

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

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

SESSION_ID_PREFIX, STATE_URL, STATIC_LAYERS_COUNT_PARAM, TILE_MANAGER, UPDATE_INTERVAL

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

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.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

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 javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

IlvFacesViewTag()
Creates a new IlvFacesViewTag instance.

Method Summary

String	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	getBoundingBox() Returns the view bounding box in manager coordinates system.
String	getComponentType() Returns the component type for the component that is or will be bound to this tag.
String	getConstrainedOnContents() Returns whether the view is constrained to the manager content bounds or not.
String	getErrorMessage() Returns the message displayed by the view if an error occurred during the image generation by the server.
String	getGenerateImageMap() Returns the flag indicating whether an image map should be generated.
String	getImageFormat() Returns the image format of the image displayed by this view.
String	getImageMapGenerator() Returns the image map generator.
String	getImageMapGeneratorClass() Returns the image map generator class name.
String	getImageMapVisible() Returns the flag indicating whether an image map should be visible or not (if generated).
String	getInteractor() Returns the binding to an interactor to set on this view.
String	getInteractorId() Returns the interactor identifier current set on this view.
String	getMaxZoomLevel() Returns the maximum zoom level.
String	getMinZoomLevel() Returns the minimum zoom level.
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	getPanFactor() Returns the panFactor.
String	getRendererType() Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly.
String	getResizable() Returns whether the view is resizable or not.
String	getServlet() Returns the servlet that will generate the image.
String	getStaticLayersCount() Returns the number of static layers.
String	getTileManager() Returns the tile manager is responsible for retrieving and/or storing image tiles on the server side.
String	getTileSize() Returns the the tile size.
String	getUpdateInterval() Returns the interval in seconds between two automatic updates.
String	getView() Returns the value binding to the manager view to be displayed.
String	getVisibleLayers() Returns the visible manager layer names.
String	getWaitingImage() Returns the image URL displayed during the image loading.
String	getZoomFactor() Returns the zoom factor.
String	getZoomLevels() Returns the fixed zoom levels displayed by the view.
void	setBackgroundColor(String 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	setBoundingBox(String boundingBox) Sets the bounding box in "x,y,w,h" format.
void	setConstrainedOnContents(String constrainedOnContents) Defines whether the view is constrained to the manager content bounds or not.
void	setErrorMessage(String errorMessage) The message displayed by the view if an error occurred during the image generation by the server.
void	setGenerateImageMap(String generateImageMap) Sets the flag indicating whether an image map should be generated or not.
void	setImageFormat(String imageFormat) Sets the image format used to encode the image that is displayed by this view.
void	setImageMapGenerator(String imageMapGenerator) Sets the image map generator.
void	setImageMapGeneratorClass(String imageMapGeneratorClass) Sets the image map generator class name.
void	setImageMapVisible(String imageMapVisible) Sets the flag indicating whether an image map should be visible or not (if generated).
void	setInteractor(String interactor) Sets the binding to an interactor.
void	setInteractorId(String interactorId) Sets the interactor identifier to set on this view.
void	setMaxZoomLevel(String maxZoomLevel) Sets the maximum zoom level.
void	setMinZoomLevel(String minZoomLevel) Sets the minimum zoom level.
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	setPanFactor(String panFactor) Sets the factor used when pan JavaScript actions are called (like panNorth and so on.)
protected void	setProperties(UIComponent component) Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified component was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the component is added to the view. Tag subclasses that want to support additional set properties must ensure that the base class setProperties() method is still called. A typical implementation that supports extra properties foo and bar would look something like this: protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } }
void	setResizable(String resizable) Sets whether the view is resizable or not.
void	setServlet(String servlet) The servlet that will generate the image.
void	setStaticLayersCount(String layersCount) Sets the number of static layers.
void	setTileManager(String tileManager) Sets the tile manager is responsible for retrieving and/or storing image tiles on the server side.
void	setTileSize(String tileSize) Sets the size of a tile.
void	setUpdateInterval(String updateInterval) Sets the interval in seconds between two automatic updates.
void	setView(String view) Sets the manager view value binding.
void	setVisibleLayers(String visibleLayers) Sets the visible manager layer names.
void	setWaitingImage(String waitingImage) Sets the image displayed during the image loading.
void	setZoomFactor(String zoomFactor) Sets the factor used when zoomIn or zoomOut JavaScript actions are called.
void	setZoomLevels(String zoomLevels) Sets the fixed zoom levels displayed by the view.

Methods inherited from class ilog.views.faces.dhtml.taglib.IlvDHTMLViewTag

getData, getDoStartValue, getMessageBox, getMessageBoxId, setData, setMessageBox, setMessageBoxId

Methods inherited from class ilog.views.faces.dhtml.taglib.IlvDHTMLSizedTag

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class ilog.views.faces.taglib.IlvSizedTag

getHeight, getWidth, setHeight, setWidth

Methods inherited from class ilog.views.faces.taglib.IlvBaseTag

setProperty, setVBProperty, testSetProperties

Methods inherited from class javax.faces.webapp.UIComponentBodyTag

doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getPreviousOut, release, setBodyContent

Methods inherited from class javax.faces.webapp.UIComponentTag

doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

IlvFacesViewTag

public IlvFacesViewTag()

Creates a new IlvFacesViewTag instance.

Method Detail

getComponentType

public String getComponentType()

Returns the component type for the component that is or will be bound to this tag.

This implementation returns null, subclasses must override this method to return the appropriate value.

Overrides:

getComponentType in class IlvBaseTag

getRendererType

public String getRendererType()

Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. This implementation return null, subclasses must override this method to return the appropriate value.

Overrides:

getRendererType in class IlvBaseTag

setProperties

protected void setProperties(UIComponent component)

Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified component was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the component is added to the view.

Tag subclasses that want to support additional set properties must ensure that the base class setProperties() method is still called. A typical implementation that supports extra properties foo and bar would look something like this:

 protected void setProperties(UIComponent component) {
   super.setProperties(component);
   if (foo != null) {
     component.setAttribute("foo", foo);
   }
   if (bar != null) {
     component.setAttribute("bar", bar);
   }
 }
 

Overrides:

setProperties in class IlvDHTMLViewTag

Parameters:

component - The component whose properties are to be overridden

getBoundingBox

public String getBoundingBox()

Returns the view bounding box in manager coordinates system.

Returns:

The view bounding box.

setBoundingBox

public void setBoundingBox(String boundingBox)

Sets the bounding box in "x,y,w,h" format.

Parameters:

boundingBox -

getInteractor

public String getInteractor()

Returns the binding to an interactor to set on this view.

Returns:

The binding to an interactor.

setInteractor

public void setInteractor(String interactor)

Sets the binding to an interactor.

Parameters:

interactor - The binding to an interactor to set.

getInteractorId

public String getInteractorId()

Returns the interactor identifier current set on this view.

Returns:

The interactor ID.

setInteractorId

public void setInteractorId(String interactorId)

Sets the interactor identifier to set on this view.

Parameters:

interactorId - The interactor ID to set.

getZoomFactor

public String getZoomFactor()

Returns the zoom factor.

Returns:

The current zoom factor.

setZoomFactor

public void setZoomFactor(String zoomFactor)

Sets the factor used when zoomIn or zoomOut JavaScript actions are called.

Parameters:

zoomFactor - The zoomFactor to set.

getPanFactor

public String getPanFactor()

Returns the panFactor.

Returns:

The pan factor.

setPanFactor

public void setPanFactor(String panFactor)

Sets the factor used when pan JavaScript actions are called (like panNorth and so on.)

Parameters:

panFactor - The pan factor to set.

getUpdateInterval

public String getUpdateInterval()

Returns the interval in seconds between two automatic updates.

Returns:

The update interval.

setUpdateInterval

public void setUpdateInterval(String updateInterval)

Sets the interval in seconds between two automatic updates.

Parameters:

updateInterval - The update interval to set.

getImageFormat

public String getImageFormat()

Returns the image format of the image displayed by this view.

Overrides:

getImageFormat in class IlvDHTMLViewTag

Returns:

The image format.

setImageFormat

public void setImageFormat(String imageFormat)

Sets the image format used to encode the image that is displayed by this view.
Valid values are JPEG or PNG.

Overrides:

setImageFormat in class IlvDHTMLViewTag

Parameters:

imageFormat - The image format to set.

getWaitingImage

public String getWaitingImage()

Returns the image URL displayed during the image loading.

Overrides:

getWaitingImage in class IlvDHTMLViewTag

Returns:

The current image URL.

setWaitingImage

public void setWaitingImage(String waitingImage)

Sets the image displayed during the image loading.

Overrides:

setWaitingImage in class IlvDHTMLViewTag

Parameters:

waitingImage - The image URL to set.

getGenerateImageMap

public String getGenerateImageMap()

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

Returns:

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

setGenerateImageMap

public void setGenerateImageMap(String generateImageMap)

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

Parameters:

generateImageMap - The generation flag to set.

getImageMapVisible

public String getImageMapVisible()

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

Returns:

The image map visible flag value to set.

setImageMapVisible

public void setImageMapVisible(String imageMapVisible)

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

Parameters:

imageMapVisible - The visibility flag to set.

getImageMapGenerator

public String getImageMapGenerator()

Returns the image map generator.

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

Returns:

The imageMapGenerator.

Since:

JViews 7.5

setImageMapGenerator

public void setImageMapGenerator(String imageMapGenerator)

Sets the image map generator.

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

Parameters:

imageMapGenerator - The image generator to set.

Since:

JViews 7.5

getImageMapGeneratorClass

public String getImageMapGeneratorClass()

Returns the image map generator class name.

This property is used if, and only if, the imageMapGenerator is not set.

Returns:

The image map generator class name.

Since:

JViews 7.5

setImageMapGeneratorClass

public void setImageMapGeneratorClass(String imageMapGeneratorClass)

Sets the image map generator class name.

This property is used if, and only if, the imageMapGenerator is not set.

Parameters:

imageMapGeneratorClass - The image map generator class name.

Since:

JViews 7.5

getBackgroundColor

public String getBackgroundColor()

Returns the background color of the view.

Returns:

The background color.

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

Sets the background color of the view.

Parameters:

backgroundColor - The background color to set.

getOnImageLoaded

public String getOnImageLoaded()

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

Returns:

The JavaScript function registered on the imageLoaded event.

setOnImageLoaded

public void setOnImageLoaded(String onImageLoaded)

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

Parameters:

onImageLoaded - The new JavaScript function handler.

getOnCapabilitiesLoaded

public 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

public void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)

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

Parameters:

onCapabilitiesLoaded - The new JavaScript function handler.

getErrorMessage

public 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

public 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.

getServlet

public String getServlet()

Returns the servlet that will generate the image. This property could be a URL to the servlet or the fully qualified servlet class name.

Overrides:

getServlet in class IlvDHTMLViewTag

Returns:

The servlet.

setServlet

public void setServlet(String servlet)

The servlet that will generate the image. This property could be a URL to the servlet or the fully qualified servlet class name.

Overrides:

setServlet in class IlvDHTMLViewTag

Parameters:

servlet - The servlet to set.

getView

public String getView()

Returns the value binding to the manager view to be displayed.

Returns:

The manager view value binding.

setView

public void setView(String view)

Sets the manager view value binding.

Parameters:

view - The manager view value binding.

getResizable

public String getResizable()

Returns whether the view is resizable or not.

Returns:

The resizable flag.

setResizable

public void setResizable(String resizable)

Sets whether the view is resizable or not.

Parameters:

resizable - The resizable to set.

getTileSize

public String getTileSize()

Returns the the tile size. If the tile size is greater or equals to 0, the view is in tiled mode or in regular mode otherwise.

By default the tile size is -1 which means that the tiled mode is disabled

Returns:

The tile size of a tiled view or negative number otherwise.

Since:

JViews 8.0

setTileSize

public void setTileSize(String tileSize)

Sets the size of a tile. If the tile size is greater or equals to 0, the view will be set in tiled mode.

The tile size must be carefully chosen for performance reasons.
See the dedicated section of the user manual for more information.

Parameters:

tileSize - The tile size to set.

Since:

JViews 8.0

See Also:

getTileSize()

getTileManager

public String getTileManager()

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

The default implementation is an ilog.views.util.servlet.tiling.IlvFileTileManager that retrieve the tileimages on the file system. if a tile is not already cached, it generates the image and store it on the file system.

The tile manager is used when the view is tiled, i.e. if the tileSize is strictly positive.

Returns:

The tile manager.

Since:

JViews 8.0

setTileManager

public void setTileManager(String tileManager)

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

The default implementation is an ilog.views.util.servlet.tiling.IlvFileTileManager that retrieve the tileimages on the file system. if a tile is not already cached, it generates the image and store it on the file system.

The tile manager is used when the view is tiled, i.e. if the tileSize is strictly positive.

Parameters:

tileManager - The tile manager to set.

Since:

JViews 8.0

getStaticLayersCount

public String getStaticLayersCount()

Returns the number of static layers. In tiled view mode the static layers are tiled, as opposed to dynamic layers, which are drawn on top of them. This number represents the count of layers at the bottom of the view that are considered to be static. The default value is zero.

Returns:

The number of static layers.

Since:

JViews 8.0, JViews 8.0

setStaticLayersCount

public void setStaticLayersCount(String layersCount)

Sets the number of static layers. In tiled view mode the static layers are tiled, as opposed to dynamic layers, which are drawn on top of them. This number represents the count of layers at the bottom of the view that will be considered as static.

Parameters:

layersCount - The number of static layers.

Since:

JViews 8.0, JViews 8.0

See Also:

getStaticLayersCount()

getZoomLevels

public String getZoomLevels()

Returns the fixed zoom levels displayed by the view. If the zoom levels are not specified, the zoom is only bound by the maxZoomLevel property.

Returns:

The zoom levels.

Since:

JViews 8.0

setZoomLevels

public void setZoomLevels(String zoomLevels)

Sets the fixed zoom levels displayed by the view. If the zoom levels are not specified, the zoom is only bound by the maxZoomLevel property.

Parameters:

zoomLevels - The zoom levels to set, as a comma separated list.

Since:

JViews 8.0

getMaxZoomLevel

public String getMaxZoomLevel()

Returns the maximum zoom level. This property is used if and only if the zoomLevels property is not used.

The default value is 10.

Returns:

The max zoom level.

Since:

JViews 8.0

setMaxZoomLevel

public void setMaxZoomLevel(String maxZoomLevel)

Sets the maximum zoom level. This property is used if and only if the zoomLevels property is not used.

The default value is 10.

Parameters:

maxZoomLevel - The max zoom level to set.

Since:

JViews 8.0

getMinZoomLevel

public String getMinZoomLevel()

Returns the minimum zoom level. This property is used if and only if the zoomLevels property is not used.

The default value is 1.

Returns:

The max zoom level.

Since:

JViews 8.1

setMinZoomLevel

public void setMinZoomLevel(String minZoomLevel)

Sets the minimum zoom level. This property is used if and only if the zoomLevels property is not used.

The default value is 1.

Parameters:

minZoomLevel - The max zoom level to set.

Since:

JViews 8.1

getVisibleLayers

public String getVisibleLayers()

Returns the visible manager layer names.

This property controls the manager layers that will be visible. If the view is in tiled mode, manipulating only dynamic layer visibility is mandatory. As a matter of fact, static layers are meant to be cached and mustn't be updated.

Returns:

The visible layers.

Since:

JViews 8.0

setVisibleLayers

public void setVisibleLayers(String visibleLayers)

Sets the visible manager layer names.

This property controls the manager layers that will be visible. If the view is in tiled mode, manipulating only dynamic layer visibility is mandatory. As a matter of fact, static layers are meant to be cached and mustn't be updated.

Parameters:

visibleLayers - The visible layers to set as a comma separated list.

Since:

JViews 8.0

getBeforeSessionExpirationHandler

public 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

setBeforeSessionExpirationHandler

public void setBeforeSessionExpirationHandler(String handler)

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

Parameters:

handler - The JavasScript code.

Since:

JViews 8.1

getConstrainedOnContents

public String getConstrainedOnContents()

Returns whether the view is constrained to the manager content bounds or not. The default value is true.

Note that zoom levels (set by minZoomLevel or zoomLevels) lower than 1 will not be allowed if this property is set to true.

Returns:

Returns whether the view is constrained or not.

Since:

JViews 8.1

setConstrainedOnContents

public void setConstrainedOnContents(String constrainedOnContents)

Defines whether the view is constrained to the manager content bounds or not. The default value is true.

Note that zoom levels (set by minZoomLevel or zoomLevels) lower than 1 will not be allowed if this property is set to true.

Parameters:

constrainedOnContents - Defines whether the view is constrained or not.

Since:

JViews 8.1