public class IlvFacesViewTag extends IlvDHTMLViewTag implements IlvDHTMLFrameworkConstants
IlvFacesDHTMLView
component and its DHTML renderer.bodyContent, pageContext, UNIQUE_ID_PREFIX
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
Constructor and Description |
---|
IlvFacesViewTag()
Creates a new
IlvFacesViewTag instance. |
Modifier and Type | Method and Description |
---|---|
String |
getAccessible()
Returns whether the view is accessible or not.
|
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 |
getHitmapLayers()
Returns the hitmap layers of this view.
|
String |
getHotkeys()
Returns the keyboard hotkeys for the view.
|
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 |
getProgressiveZoom()
Gets the progressive zoom property.
|
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 |
getScrollBar()
Gets the scroll bar state property from view.
|
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 |
setAccessible(String accessible)
Sets whether the view is accessible or not.
|
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 |
setHitmapLayers(String hitmapLayers)
Sets the hitmap layers for this view.
|
void |
setHotkeys(String hotkeys)
Sets the keyboard hotkeys for the view.
|
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.) |
void |
setProgressiveZoom(String progressiveZoom)
Sets the progressive zoom property
|
protected void |
setProperties(javax.faces.component.UIComponent component)
Override properties and attributes of the specified component,
if the corresponding properties of this tag handler instance were
explicitly set.
|
void |
setResizable(String resizable)
Sets whether the view is resizable or not.
|
void |
setScrollBar(String scrollBarState)
Sets the scroll bar state property for view.
|
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.
|
getData, getDoStartValue, getMessageBox, getMessageBoxId, setData, setMessageBox, setMessageBoxId
getStyle, getStyleClass, setStyle, setStyleClass
getHeight, getWidth, setHeight, setWidth
getPartialTriggers, getStringArray, setPartialTriggers, setProperty, setVBProperty, testSetProperties
createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setRendered
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
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.
getComponentType
in class IlvBaseTag
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.
getRendererType
in class IlvBaseTag
protected void setProperties(javax.faces.component.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); } }
setProperties
in class IlvDHTMLViewTag
component
- The component whose properties are to be
overriddenpublic String getBoundingBox()
public void setBoundingBox(String boundingBox)
boundingBox
- The bounding box in "x,y,w,h" format.public String getInteractor()
public void setInteractor(String interactor)
interactor
- The binding to an interactor to set.public String getInteractorId()
public void setInteractorId(String interactorId)
interactorId
- The interactor ID to set.public String getHitmapLayers()
public void setHitmapLayers(String hitmapLayers)
hitmapLayers
- The hitmapLayers to set.public String getZoomFactor()
public void setZoomFactor(String zoomFactor)
zoomIn
or zoomOut
JavaScript actions are called.zoomFactor
- The zoomFactor
to set.public String getPanFactor()
panFactor
.public void setPanFactor(String panFactor)
panNorth
and so on.)panFactor
- The pan factor to set.public String getUpdateInterval()
public void setUpdateInterval(String updateInterval)
updateInterval
- The update interval to set.public String getImageFormat()
getImageFormat
in class IlvDHTMLViewTag
public void setImageFormat(String imageFormat)
JPEG
or PNG
.setImageFormat
in class IlvDHTMLViewTag
imageFormat
- The image format to set.public String getWaitingImage()
getWaitingImage
in class IlvDHTMLViewTag
public void setWaitingImage(String waitingImage)
setWaitingImage
in class IlvDHTMLViewTag
waitingImage
- The image URL to set.public String getGenerateImageMap()
true
if the image map will be generated, false
otherwise.public void setGenerateImageMap(String generateImageMap)
generateImageMap
- The generation flag to set.public String getImageMapVisible()
public void setImageMapVisible(String imageMapVisible)
imageMapVisible
- The visibility flag to set.public String getImageMapGenerator()
Returns the image map generator.
If thegenerateImageMap
property is true
,
this generator will be invoked to create the image map dynamically.
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.
imageMapGenerator
- The image generator to set.public String getImageMapGeneratorClass()
Returns the image map generator class name.
This property is used if, and only if, the imageMapGenerator
is not set.
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.
imageMapGeneratorClass
- The image map generator class name.public String getBackgroundColor()
public void setBackgroundColor(String backgroundColor)
backgroundColor
- The background color to set.public String getOnImageLoaded()
imageLoaded
event.public void setOnImageLoaded(String onImageLoaded)
onImageLoaded
- The new JavaScript function handler.public String getOnCapabilitiesLoaded()
capabilitiesLoaded
event.public void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)
onCapabilitiesLoaded
- The new JavaScript function handler.public String getErrorMessage()
public void setErrorMessage(String errorMessage)
errorMessage
- The new error message to set.public String getServlet()
getServlet
in class IlvDHTMLViewTag
public void setServlet(String servlet)
setServlet
in class IlvDHTMLViewTag
servlet
- The servlet to set.public String getView()
public void setView(String view)
view
- The manager view value binding.public String getResizable()
public void setResizable(String resizable)
resizable
- The resizable to set.public String getAccessible()
public void setAccessible(String accessible)
accessible
- The accessible to set.public void setHotkeys(String hotkeys)
hotkeys
- The hotkeys to set.public String getHotkeys()
public String getTileSize()
By default the tile size is -1 which means that the tiled mode is disabled
public void setTileSize(String tileSize)
The tile size must be carefully chosen for performance reasons.
See the dedicated section of the user manual for more information.
tileSize
- The tile size to set.getTileSize()
public String getTileManager()
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.
public void setTileManager(String tileManager)
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.
tileManager
- The tile manager to set.public String getStaticLayersCount()
public void setStaticLayersCount(String layersCount)
layersCount
- The number of static layers.getStaticLayersCount()
public String getZoomLevels()
maxZoomLevel
property.public void setZoomLevels(String zoomLevels)
maxZoomLevel
property.zoomLevels
- The zoom levels to set, as a comma separated list.public String getMaxZoomLevel()
zoomLevels
property is not used.The default value is 10.
public void setMaxZoomLevel(String maxZoomLevel)
zoomLevels
property is not used.The default value is 10.
maxZoomLevel
- The max zoom level to set.public String getMinZoomLevel()
zoomLevels
property is not used.The default value is 1.
public void setMinZoomLevel(String minZoomLevel)
zoomLevels
property is not used.The default value is 1.
minZoomLevel
- The max zoom level to set.public String getVisibleLayers()
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.
public void setVisibleLayers(String visibleLayers)
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.
visibleLayers
- The visible layers to set as a comma separated list.public String getBeforeSessionExpirationHandler()
public void setBeforeSessionExpirationHandler(String handler)
handler
- The JavasScript code.public String getConstrainedOnContents()
true
.
Note that zoom levels (set by minZoomLevel
or zoomLevels
) lower than 1 will not be allowed if this property is set to true
.
public void setConstrainedOnContents(String constrainedOnContents)
true
.
Note that zoom levels (set by minZoomLevel
or zoomLevels
) lower than 1 will not be allowed if this property is set to true
.
constrainedOnContents
- Defines whether the view is constrained or not.public void setProgressiveZoom(String progressiveZoom)
progressiveZoom
- The progressive zoom.public String getProgressiveZoom()
public void setScrollBar(String scrollBarState)
public String getScrollBar()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.