ilog.views.faces.dhtml.taglib
Class IlvDHTMLViewTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      javax.faces.webapp.UIComponentBodyTag
          ilog.views.faces.taglib.IlvBaseTag
              ilog.views.faces.taglib.IlvSizedTag
                  ilog.views.faces.dhtml.taglib.IlvDHTMLSizedTag
                      ilog.views.faces.dhtml.taglib.IlvDHTMLViewTag

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

IlvDHTMLViewHelperTag, IlvFacesViewTag

public abstract class IlvDHTMLViewTag
extends IlvDHTMLSizedTag

This class defines the custom tag handler for a DHTML view component.

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentBodyTag

bodyContent

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

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

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

IlvDHTMLViewTag()
Creates a new IlvDHTMLViewTag instance.

Method Summary

String	getData() Returns the data to be displayed by this component
protected int	getDoStartValue() Returns the value used by doStartTag This implemetation returns EVAL_BODY_INCLUDE.
String	getImageFormat() Returns the desired format of the generated image by the servlet.
String	getMessageBox() Returns the binding to a message box linked to this component.
String	getMessageBoxId() Returns the identifier of the associated message box.
String	getServlet() Returns the servlet that will generate the image displayed by the view.
String	getWaitingImage() Returns the path to the image displayed when the view loads the image.
void	setData(String data) Sets the data to be displayed by this component.
void	setImageFormat(String imageFormat) Sets the desired format of the generated image by the servlet.
void	setMessageBox(String messageBox) Sets the binding to a message box linked to this component.
void	setMessageBoxId(String messageBoxId) Sets a message box identifier to this view component.
protected void	setProperties(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); } }
void	setServlet(String servlet) 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.

Methods inherited from class ilog.views.faces.dhtml.taglib.IlvDHTMLSizedTag

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class ilog.views.faces.taglib.IlvSizedTag

getHeight, getWidth, setHeight, setWidth

Methods inherited from class ilog.views.faces.taglib.IlvBaseTag

getComponentType, getRendererType, setProperty, setVBProperty, testSetProperties

Methods inherited from class javax.faces.webapp.UIComponentBodyTag

doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getPreviousOut, release, setBodyContent

Methods inherited from class javax.faces.webapp.UIComponentTag

doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

IlvDHTMLViewTag

public IlvDHTMLViewTag()

Creates a new IlvDHTMLViewTag instance.

Method Detail

setProperties

protected void setProperties(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);
   }
 }
 

Overrides:

setProperties in class IlvDHTMLSizedTag

Parameters:

component - The component whose properties are to be overridden

getImageFormat

public String getImageFormat()

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

Returns:

The desired format of the generated image by the servlet.

getMessageBoxId

public String getMessageBoxId()

Returns the identifier of the associated message box.

Returns:

The ID of the associated message box.

getWaitingImage

public 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

public void setImageFormat(String imageFormat)

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

Parameters:

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

setMessageBoxId

public void setMessageBoxId(String messageBoxId)

Sets a message box identifier to this view component. A message box is a component that will display messages from the interactors.

Parameters:

messageBoxId - The ID of the message box to set to the view.

setWaitingImage

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

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.

Parameters:

servlet - The image generating the 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.

Returns:

The image generating the servlet.

getMessageBox

public String getMessageBox()

Returns the binding to a message box linked to this component.

Returns:

The binding to a message box linked to this component.

Since:

JViews 6.5

setMessageBox

public void setMessageBox(String messageBox)

Sets the binding to a message box linked to this component.

Parameters:

messageBox - The binding expression to a message box.

Since:

JViews 6.5

getDoStartValue

protected int getDoStartValue()
                       throws javax.servlet.jsp.JspException

Returns the value used by doStartTag

This implemetation returns EVAL_BODY_INCLUDE.

Overrides:

getDoStartValue in class UIComponentBodyTag

Returns:

EVAL_BODY_INCLUDE.

Throws:

javax.servlet.jsp.JspException

getData

public String getData()

Returns the data to be displayed by this component

Returns:

Returns the data.

Since:

JViews 8.0

setData

public void setData(String data)

Sets the data to be displayed by this component.

Parameters:

data - The data to displayed.

Since:

JViews 8.0