ilog.views.faces.taglib
Class IlvBaseTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      javax.faces.webapp.UIComponentBodyTag
          ilog.views.faces.taglib.IlvBaseTag

All Implemented Interfaces:

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

Direct Known Subclasses:

IlvFacesDiagrammerDataSourceTag, IlvFacesLayerVisibilityToolTag, IlvFacesSelectionManagerTag, IlvImageButtonTag, IlvInteractorTag, IlvMenuTag, IlvSizedTag

public abstract class IlvBaseTag
extends UIComponentBodyTag
implements IlvFacesConstants

The IlvBaseTag is the base class for the tag handlers of JViews faces components. The methods provide an easy way to set properties on the component.

Since:

JViews 6.0

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

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

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

protected

IlvBaseTag() Creates a new IlvBaseTag instance.

Method Summary

String	getComponentType() Returns the component type for the component that is or will be bound to this tag.
String	getRendererType() Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly.
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.
protected void	setProperty(UIComponent component, String propertyId, String propertyValue) Sets a property on the component.
protected boolean	setVBProperty(UIComponent component, String propertyId, String propertyValue) Sets the property on the component if the property value is a referenced value.
void	testSetProperties(UIComponent component)

Methods inherited from class javax.faces.webapp.UIComponentBodyTag

doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getDoStartValue, 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

IlvBaseTag

protected IlvBaseTag()

Creates a new IlvBaseTag instance.

Method Detail

getComponentType

public String getComponentType()

Returns the component type for the component that is or will be bound to this tag.

This implementation returns null, subclasses must override this method to return the appropriate value.

Specified by:

getComponentType in class UIComponentTag

getRendererType

public String getRendererType()

Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. This implementation return null, subclasses must override this method to return the appropriate value.

Specified by:

getRendererType in class UIComponentTag

setVBProperty

protected boolean setVBProperty(UIComponent component,
                                String propertyId,
                                String propertyValue)

Sets the property on the component if the property value is a referenced value. This method is used when the property is a simple type.

Parameters:

component - The component to customize.

propertyId - The name of the property to set.

propertyValue - The value of the property.

Returns:

true If the property is a referenced value and was set, false otherwise.

setProperty

protected void setProperty(UIComponent component,
                           String propertyId,
                           String propertyValue)

Sets a property on the component. If the property value is a referenced value, creates a value binding and adds it to the component. Otherwise sets directly the property on the component.

Parameters:

component - The component to customize.

propertyId - The name of the property to set.

propertyValue - The value of the property.

testSetProperties

public void testSetProperties(UIComponent component)

Parameters:

component - The component to test.

Since:

JViews 6.5

Internal method or field: do not use!

Used for unit testing.

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 UIComponentTag

Parameters:

component - The component whose properties are to be overridden