Skip to main content
PREV CLASS NEXT CLASS FRAMES NO FRAMES

 

Class IlvChartLegendProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvSizedViewProxy
            |
            +--IlvBasicViewProxy
               |
               +--IlvChartLegendProxy

Category:
Charts JSF component
JavaScript File:
IlvChartLegendProxy.js
Description:
The IlvChartLegendProxy is the proxy to handle IlvChartLegend DHTML object.

Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvChartLegendProxy(clientId, refNodeId, width, height)
Method Summary
Method Attributes Method Name and Description
 
 
Returns the background color of the generated image, or null if not specified.
 
Returns the message displayed if an error occurs when the image is loading.
 
Returns the image map generator.
 
Returns the layout of this component.
 
Returns the class of the servlet that generates the image.
 
Returns the URL of the servlet that generates the image.
 
getView(view)
Gets the view of this component.
 
 
 
IlvChartLegendProxy. imageLoaded(legend)
 
Returns a Boolean indicating whether the component is generating an image map in addition to the image.
 
Returns the image map layer visibility.
 
isResizable(resizable)
Returns whether the managed view is resizable or not.
 
setBackgroundColor(color, updateImage)
Sets the background color of the generated image.
 
setEnableHitmap(enable, tolerance)
Sets the hitmap enable flag of the legend view component.
 
setErrorMessage(errMsg)
Sets the message displayed when an error occurs when the image is loading.
 
setGenerateImageMap(set, update)
Instructs the component to generate an image map in addition to the image.
 
setImageMapGenerator(imageMapGenerator)
Sets the image map generator.
 
Sets the image map layer visibility.
 
setLayout(layout, updateImage)
Sets the layout of the legend.
 
Sets the JavaScript code that will be executed when the capabilities are loaded.
 
setOnImageLoaded(evtListener)
Sets the JavaScript code that will be executed when the image is loaded.
 
setResizable(resizable)
Sets whether the managed view is resizable or not.
 
setServletClass(servletClass)
Sets the class of the servlet that generates the image.
 
setServletURL(servletURL)
Sets the URL of the servlet that generates the image.
 
setView(view)
Sets the view of this component.
 
Methods inherited from class IlvBasicViewProxy
getImageFormat, getMessageBox, getWaitingImage, init, setImageFormat, setMessageBox, setWaitingImage
Methods inherited from class IlvSizedViewProxy
afterLayoutHandler, getAbsoluteBounds, getBounds, getCreationSize, getHeight, getMinimumSize, getWidth, positionAfterLayout, registerResizeListener, resizeAfterLayout, setMinimumSize
Methods inherited from class IlvFacesProxy
dispose, getAbsoluteId, getJViewsDHTMLObject, getNodeCoords, getObject, getReferenceNode, setAbsoluteId, setJViewsDHTMLObject, setObject, setPageIdSupport, setReferenceNode, toHTML
Methods inherited from class IlvPropertyStateManager
getClientId, notify
Methods inherited from class IlvObject
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
Constructor Detail
IlvChartLegendProxy
IlvChartLegendProxy(clientId, refNodeId, width, height)
Parameters:
clientId
refNodeId
width
height
Method Detail
addRequestParameters
addRequestParameters()

getBackgroundColor
getBackgroundColor()
Returns the background color of the generated image, or null if not specified.

getErrorMessage
getErrorMessage()
Returns the message displayed if an error occurs when the image is loading.
Returns:
The message displayed if an error occurs when the image is loading.

getImageMapGenerator
getImageMapGenerator()
Returns the image map generator. If the generateImageMap property is true,
this generator will be invoked to dynamically create the image map. The result could be a class name or a value binding expression.
Returns:
The image map generator.

getLayout
getLayout()
Returns the layout of this component. The returned value could be 'vertical' or 'horizontal'.

getServletClass
getServletClass()
Returns the class of the servlet that generates the image. This class will be instantiated by the controller servlet, if needed.
Returns:
The class of the servlet that generates the image.

getServletURL
getServletURL()
Returns the URL of the servlet that generates the image.
Returns:
The URL of the servlet that generates the image.

getView
getView(view)
Gets the view of this component.
Parameters:
view - The view to link this component to.

getViewId
getViewId()

getViewInternal
getViewInternal()

imageLoaded
<static> IlvChartLegendProxy.imageLoaded(legend)
Parameters:
legend

isGenerateImageMap
isGenerateImageMap()
Returns a Boolean indicating whether the component is generating an image map in addition to the image.

isImageMapVisible
isImageMapVisible()
Returns the image map layer visibility.

isResizable
isResizable(resizable)
Returns whether the managed view is resizable or not.
Parameters:
resizable - The resizable flag.

setBackgroundColor
setBackgroundColor(color, updateImage)
Sets the background color of the generated image.
Parameters:
color - The background color expressed as a string like 'RRGGBB'.
updateImage

setEnableHitmap
setEnableHitmap(enable, tolerance)
Sets the hitmap enable flag of the legend view component.
Parameters:
enable
tolerance
Since:
JViews 8.7

setErrorMessage
setErrorMessage(errMsg)
Sets the message displayed when an error occurs when the image is loading.
Parameters:
errMsg

setGenerateImageMap
setGenerateImageMap(set, update)
Instructs the component to generate an image map in addition to the image.
Parameters:
set - Set whether to generate an image map
update - Set whether to update the image.

setImageMapGenerator
setImageMapGenerator(imageMapGenerator)
Sets the image map generator. If the generateImageMap property is true,
this generator will be invoked to dynamically create the image map. The parameter could be a class name or a value binding expression.
Parameters:
imageMapGenerator - The imageMapGenerator to set.

setImageMapVisible
setImageMapVisible(visible)
Sets the image map layer visibility.
Parameters:
visible

setLayout
setLayout(layout, updateImage)
Sets the layout of the legend. The valid values are 'vertical' and 'horizontal'.
Parameters:
layout - The new layout of the legend.
updateImage - The flag to determine whether a new image should be requested.

setOnCapabilitiesLoaded
setOnCapabilitiesLoaded(evtListener)
Sets the JavaScript code that will be executed when the capabilities are loaded.
Parameters:
evtListener

setOnImageLoaded
setOnImageLoaded(evtListener)
Sets the JavaScript code that will be executed when the image is loaded.
Parameters:
evtListener

setResizable
setResizable(resizable)
Sets whether the managed view is resizable or not.
Parameters:
resizable - The resizable flag.

setServletClass
setServletClass(servletClass)
Sets the class of the servlet that generates the image. This class will be instantiated by the controller servlet, if needed.
Parameters:
servletClass - The class of the servlet that generates the image.

setServletURL
setServletURL(servletURL)
Sets the URL of the servlet that generates the image.
Parameters:
servletURL - The URL of the servlet that generates the image.

setView
setView(view)
Sets the view of this component.
Parameters:
view - The view to link this component to.

setViewInternal
setViewInternal(view)
Parameters:
view - The view to set.

©Copyright Rogue Wave Software Inc. 1997, 2018. All Rights Reserved.