ilog.views.faces.dhtml.taglib
Class IlvFacesPanToolTag

java.lang.Object
  extended by javax.faces.webapp.UIComponentTag
      extended by javax.faces.webapp.UIComponentBodyTag
          extended by ilog.views.faces.taglib.IlvBaseTag
              extended by ilog.views.faces.taglib.IlvSizedTag
                  extended by ilog.views.faces.dhtml.taglib.IlvDHTMLSizedTag
                      extended by ilog.views.faces.dhtml.taglib.IlvDHTMLViewTag
                          extended by ilog.views.faces.dhtml.taglib.IlvDHTMLViewHelperTag
                              extended by ilog.views.faces.dhtml.taglib.IlvFacesPanToolTag
All Implemented Interfaces:
IlvDHTMLConstants, IlvFacesConstants, IlvFrameworkConstants, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class IlvFacesPanToolTag
extends IlvDHTMLViewHelperTag
implements IlvFrameworkConstants

This class defines the JSP custom tag handler for the IlvFacesPanTool component and its DHTML renderer.

Since:
JViews 6.5

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.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 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
IlvFacesPanToolTag()
          Creates a new IlvFacesPanToolTag instance.
 
Method Summary
 String getComponentType()
          

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

 String getEnabled()
          Returns the enabled state of this button.
 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.

 void setEnabled(String enabled)
          Sets whether this button is a enabled or not.
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.IlvDHTMLViewHelperTag
getView, getViewId, setView, setViewId
 
Methods inherited from class ilog.views.faces.dhtml.taglib.IlvDHTMLViewTag
getData, getDoStartValue, getImageFormat, getMessageBox, getMessageBoxId, getServlet, getWaitingImage, setData, setImageFormat, setMessageBox, setMessageBoxId, setServlet, setWaitingImage
 
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.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

IlvFacesPanToolTag

public IlvFacesPanToolTag()
Creates a new IlvFacesPanToolTag 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.

Overrides:
getComponentType in class IlvBaseTag

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 IlvBaseTag

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 IlvDHTMLViewHelperTag
Parameters:
component - The component whose properties are to be overridden

getEnabled

public String getEnabled()
Returns the enabled state of this button.

Returns:
The enabled state of this button.
Since:
JViews 8.0

setEnabled

public void setEnabled(String enabled)
Sets whether this button is a enabled or not.

Parameters:
enabled - The enabled state to be set on this button.
Since:
JViews 8.0


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.