ilog.views.diagrammer.faces.dhtml.taglib
Class IlvFacesDashboardViewTag

java.lang.Object
  javax.faces.webapp.UIComponentTagBase
      javax.faces.webapp.UIComponentClassicTagBase
          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
                                  ilog.views.faces.dhtml.taglib.IlvFacesViewTag
                                      ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDashboardViewTag

All Implemented Interfaces:

IlvFacesDiagrammerConstants, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class IlvFacesDashboardViewTag
extends IlvFacesViewTag
implements IlvFacesDiagrammerConstants

This class defines the JSP custom tag handler for the DHTML IlvFacesDHTMLDashboardView.

Since:

JViews 8.0

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.webapp.UIComponentTagBase

log

Fields inherited from interface ilog.views.diagrammer.faces.IlvFacesDiagrammerConstants

DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLFrameworkConstants

SESSION_ID_PREFIX, STATE_URL, STATIC_LAYERS_COUNT_PARAM, TILE_MANAGER, UPDATE_INTERVAL

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

ACTION_NAME, AUTO_REFRESH, BOUNDING_BOX, CONSTRAINED_ON_CONTENTS, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TILE_SIZE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

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

Constructor Summary

IlvFacesDashboardViewTag()
Creates a new IlvFacesDashboardViewTag instance.

Method Summary

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.
String	getDashboardDiagram() Returns the binding expression to an IlvDashboardDiagram to display.
String	getData() Returns the data to be displayed by this component.
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.
void	setDashboardDiagram(String dashboard) Sets the binding expression to an IlvDashboardDiagram to display.
void	setData(String data) Sets the data to be displayed by this 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); } }

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

getBackgroundColor, getBeforeSessionExpirationHandler, getBoundingBox, getConstrainedOnContents, getErrorMessage, getGenerateImageMap, getImageFormat, getImageMapGenerator, getImageMapGeneratorClass, getImageMapVisible, getInteractor, getInteractorId, getMaxZoomLevel, getMinZoomLevel, getOnCapabilitiesLoaded, getOnImageLoaded, getPanFactor, getResizable, getServlet, getStaticLayersCount, getTileManager, getTileSize, getUpdateInterval, getView, getVisibleLayers, getWaitingImage, getZoomFactor, getZoomLevels, setBackgroundColor, setBeforeSessionExpirationHandler, setBoundingBox, setConstrainedOnContents, setErrorMessage, setGenerateImageMap, setImageFormat, setImageMapGenerator, setImageMapGeneratorClass, setImageMapVisible, setInteractor, setInteractorId, setMaxZoomLevel, setMinZoomLevel, setOnCapabilitiesLoaded, setOnImageLoaded, setPanFactor, setResizable, setServlet, setStaticLayersCount, setTileManager, setTileSize, setUpdateInterval, setView, setVisibleLayers, setWaitingImage, setZoomFactor, setZoomLevels

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

getDoStartValue, getMessageBox, getMessageBoxId, setMessageBox, setMessageBoxId

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

setProperty, setVBProperty, testSetProperties

Methods inherited from class javax.faces.webapp.UIComponentTag

createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class javax.faces.webapp.UIComponentTagBase

getELContext

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

IlvFacesDashboardViewTag

public IlvFacesDashboardViewTag()

Creates a new IlvFacesDashboardViewTag instance.

Method Detail

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.

Overrides:

getRendererType in class IlvFacesViewTag

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.

Overrides:

getComponentType in class IlvFacesViewTag

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 IlvFacesViewTag

Parameters:

component - The component whose properties are to be overridden

getDashboardDiagram

public String getDashboardDiagram()

Returns the binding expression to an IlvDashboardDiagram to display.

setDashboardDiagram

public void setDashboardDiagram(String dashboard)

Sets the binding expression to an IlvDashboardDiagram to display.

Parameters:

dashboard - The binding expression.

getData

public String getData()

Returns the data to be displayed by this component.

Overrides:

getData in class IlvDHTMLViewTag

Returns:

Returns the data.

setData

public void setData(String data)

Sets the data to be displayed by this component.

Overrides:

setData in class IlvDHTMLViewTag

Parameters:

data - The data to be displayed.