Rogue Wave JViews Maps for Defense JavaScript Reference: Class IlvBasicViewProxy

Class IlvBasicViewProxy

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

Category:: Framework JSF component

JavaScript File:: IlvBasicViewProxy.js

Description:: The IlvBasicViewProxy class is the base proxy class for the DHTML components that have a view.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvBasicViewProxy(clientId)

Method Summary
Method Attributes	Method Name and Description
	getImageFormat(imageFormat) Returns the image format that will be emitted by the servlet that generates the image.
	getMessageBox(messageBox) Returns the message box of the view.
	getServletClass() Returns the class of the servlet that generates the image that will be instantiated, if needed, by the controller servlet.
	getServletURL() Returns the URL of the servlet that generates the image.
	getWaitingImage(waitingImage) Returns the image path to the waiting image.
	init() Calls the `init` method of the underlying JViews DHTML object.
	setImageFormat(imageFormat) Sets the format of the image that will be emitted by the image generation servlet.
	setMessageBox(messageBox) Sets the message box of the view.
	setServletClass(servletClass) Sets the class of the servlet that generates the image that will be instantiated, if needed, by the controller servlet.
	setServletURL(servletURL) Sets the URL of the servlet that generates the image.
	setWaitingImage(waitingImage) Sets the path to the image that will be displayed while the component is in the loading state.

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

IlvBasicViewProxy

IlvBasicViewProxy(clientId)

Parameters:: clientId - The id used to identify the proxy.

Method Detail

getImageFormat

getImageFormat(imageFormat)

Returns the image format that will be emitted by the servlet that generates the image.

Parameters:: imageFormat - Not actually used.

Returns:: The image format.

getMessageBox

getMessageBox(messageBox)

Returns the message box of the view.

Parameters:: messageBox - Not actually used.

Returns:: The message box.

getServletClass

getServletClass()

Returns the class of the servlet that generates the image that will be instantiated, if needed, by the controller servlet.

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.

getWaitingImage

getWaitingImage(waitingImage)

Returns the image path to the waiting image.

Parameters:: waitingImage - Not actually used.

Returns:: The URL of the waiting image.

init

init()

Calls the init method of the underlying JViews DHTML object.

setImageFormat

setImageFormat(imageFormat)

Sets the format of the image that will be emitted by the image generation servlet. Valid values are JPEG and PNG.

Parameters:: imageFormat - The image format to query.

setMessageBox

setMessageBox(messageBox)

Sets the message box of the view. The messages of the view will be displayed in this message box.

Parameters:: messageBox - The message box to set.

setServletClass

setServletClass(servletClass)

Sets the class of the servlet that generates the image that will be instantiated, if needed, by the controller servlet.

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.

setWaitingImage

setWaitingImage(waitingImage)

Sets the path to the image that will be displayed while the component is in the loading state.

Parameters:: waitingImage - The waiting image URL.