ilog.views.faces.dhtml.component
Interface IlvDHTMLHelper

All Superinterfaces:

IlvDHTMLConstants, IlvFacesConstants, Serializable

All Known Subinterfaces:

IlvFacesDHTMLViewSupport

All Known Implementing Classes:

IlvDHTMLHelperImpl, IlvFacesDHTMLDashboardView, IlvFacesDHTMLDiagrammerView, IlvFacesDHTMLMapView, IlvFacesDHTMLView, IlvFacesDHTMLViewSupportImpl

public interface IlvDHTMLHelper
extends IlvFacesConstants, IlvDHTMLConstants, Serializable

This interface defines a view component with a set of DHTML specific properties.

Since:

JViews 6.0

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

String	getImageFormat() Returns the desired format of the image generated by the servlet.
String	getServlet() Returns the servlet that will generate the image displayed by the view.
String	getServletClass()
String	getServletURL()
String	getWaitingImage() Returns the path to the image displayed when the view loads the image.
void	restoreState(FacesContext context, Object state) Restores the state of this component from the state parameter.
Object	saveState(FacesContext context) Returns the state of this component.
void	setImageFormat(String imageFormat) Sets the desired format of the image generated by the servlet.
void	setServlet(String servlet) Sets the servlet that will generate the image displayed by the view.
void	setServletClass(String servletClass)
void	setServletURL(String servletURL)
void	setValue(Object value) Sets the servlet that will generate the image displayed by the view.
void	setWaitingImage(String waitingImage) Sets the path of the image displayed when the view loads the image.
void	updateModel(FacesContext context) Updates the referenced values with the local values of the component if these values were updated from the client.

Method Detail

setServlet

void setServlet(String servlet)

Sets the servlet that will generate the image displayed by the view. This method is an alias for setValue. The servlet parameter could be a URL to the servlet or a fully qualified servlet class that will be instantiated to generate the image.

Parameters:

servlet - The image generating servlet.

getServlet

String getServlet()

Returns the servlet that will generate the image displayed by the view. The returned value could be a URL or a fully qualified class.

Returns:

The image generating servlet.

setValue

void setValue(Object value)

Sets the servlet that will generate the image displayed by the view. The servlet parameter could be a URL to the servlet or a fully qualified servlet class that will be instantiated to generate the image.

Parameters:

value - The image generating servlet.

setServletClass

void setServletClass(String servletClass)

Internal method or field: do not use!

getServletClass

String getServletClass()

Internal method or field: do not use!

setServletURL

void setServletURL(String servletURL)

Internal method or field: do not use!

getServletURL

String getServletURL()

Internal method or field: do not use!

getImageFormat

String getImageFormat()

Returns the desired format of the image generated by the servlet.

Returns:

The desired format of the image generated by the servlet.

getWaitingImage

String getWaitingImage()

Returns the path to the image displayed when the view loads the image.

Returns:

The path to the image displayed when the view loads the image.

setImageFormat

void setImageFormat(String imageFormat)

Sets the desired format of the image generated by the servlet. Valid values are "JPEG" and "PNG"'.

Parameters:

imageFormat - The desired image format of the image displayed by the view.

setWaitingImage

void setWaitingImage(String waitingImage)

Sets the path of the image displayed when the view loads the image.

Parameters:

waitingImage - The path of the image displayed when the view loads the image.

updateModel

void updateModel(FacesContext context)

Updates the referenced values with the local values of the component if these values were updated from the client.

Parameters:

context - The current faces context.

saveState

Object saveState(FacesContext context)

Returns the state of this component.

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

void restoreState(FacesContext context,
                  Object state)

Restores the state of this component from the state parameter.

Parameters:

context - The current faces context.

state - The previously saved state of this component.