ilog.views.faces.dhtml.component
Class IlvDHTMLHelperImpl

java.lang.Object
  ilog.views.faces.dhtml.component.IlvDHTMLHelperImpl

All Implemented Interfaces:

IlvDHTMLHelper, IlvDHTMLConstants, IlvFacesConstants, Serializable

Direct Known Subclasses:

IlvFacesDHTMLViewSupportImpl

public class IlvDHTMLHelperImpl
extends Object
implements IlvDHTMLHelper

This class implements the IlvDHTMLHelper interface that defines a view component with a set of DHTML specific properties. This class is designed to be used as a support for classes that want to implement the IlvDHTMLHelper interface.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

protected IlvBasicView

helped The helped view that supported by this instance.

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

Constructor Summary

IlvDHTMLHelperImpl(IlvBasicView helped)
Builds a new IlvDHTMLHelperImpl instance that handles the implementation of the IlvDHTMLHelper interface.

Method Summary

IlvBasicView	getHelped() Returns the helped view that is supported by this instance.
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	setHelped(IlvBasicView helped) Sets the helped view that is supported by this utility instance.
void	setImageFormat(String imageFormat) Sets the desired format of the generated image 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 ctx) Updates the referenced values with the local values of the component if these values were updated from the client.

Methods inherited from class java.lang.Object

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

Field Detail

helped

protected IlvBasicView helped

The helped view that supported by this instance.

Since:

JViews 6.5

Constructor Detail

IlvDHTMLHelperImpl

public IlvDHTMLHelperImpl(IlvBasicView helped)

Builds a new IlvDHTMLHelperImpl instance that handles the implementation of the IlvDHTMLHelper interface.

Parameters:

helped - The helped component.

Method Detail

setServlet

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

Specified by:

setServlet in interface IlvDHTMLHelper

Parameters:

servlet - The image generating servlet.

getServlet

public 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. This is an alias for the code>getValue method.

Specified by:

getServlet in interface IlvDHTMLHelper

Returns:

The servlet generating the image.

setValue

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

Specified by:

setValue in interface IlvDHTMLHelper

Parameters:

value - The servlet generating the image.

setServletClass

public void setServletClass(String servletClass)

Specified by:

setServletClass in interface IlvDHTMLHelper

getServletClass

public String getServletClass()

Specified by:

getServletClass in interface IlvDHTMLHelper

setServletURL

public void setServletURL(String servletURL)

Specified by:

setServletURL in interface IlvDHTMLHelper

getServletURL

public String getServletURL()

Specified by:

getServletURL in interface IlvDHTMLHelper

getImageFormat

public String getImageFormat()

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

Specified by:

getImageFormat in interface IlvDHTMLHelper

Returns:

The desired format of the image generated by the servlet.

getWaitingImage

public String getWaitingImage()

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

Specified by:

getWaitingImage in interface IlvDHTMLHelper

Returns:

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

setImageFormat

public void setImageFormat(String imageFormat)

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

Specified by:

setImageFormat in interface IlvDHTMLHelper

Parameters:

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

setWaitingImage

public void setWaitingImage(String waitingImage)

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

Specified by:

setWaitingImage in interface IlvDHTMLHelper

Parameters:

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

getHelped

public IlvBasicView getHelped()

Returns the helped view that is supported by this instance.

Returns:

The helped IlvBasicView instance.

Since:

JViews 6.5

setHelped

public void setHelped(IlvBasicView helped)

Sets the helped view that is supported by this utility instance.

Parameters:

helped - The helped IlvBasicView instance.

Since:

JViews 6.5

updateModel

public void updateModel(FacesContext ctx)

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

Specified by:

updateModel in interface IlvDHTMLHelper

Parameters:

ctx - The current faces context.

saveState

public Object saveState(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvDHTMLHelper

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(FacesContext context,
                         Object state)

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvDHTMLHelper

Parameters:

context - The current faces context.

state - The previously saved state of this component.