ilog.views.faces.dhtml.taglib
Class IlvImageButtonTag

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

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

public class IlvImageButtonTag
extends IlvBaseTag
implements IlvDHTMLConstants

This class defines the custom tag handler for the DHTML image button 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.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.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

IlvImageButtonTag()
Creates a new IlvImageButtonTag instance.

Method Summary

String	getAction() Returns the MethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.
String	getActionListener() Returns theMethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.
String	getButtonGroupId() Returns the identifier of the button group.
String	getComponentType() Returns the component type for the component that is or will be bound to this tag.
String	getCursor() Returns the cursor displayed when the mouse is on the button.
String	getDoActionOnBGDeselect() Returns whether the button should execute its action when it's deselected by its button group.
String	getEnabled() Returns the enabled state of this button.
String	getImage() Returns the URL of the image representing the button.
String	getImmediate() Returns a flag indicating that the default ActionListener provided by the JavaServer Faces implementation should be executed immediately (that is, during the Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase.
String	getMessage() Returns the message that can be displayed when the cursor is on the button.
String	getMessageBox() Returns the binding to a message box linked to this component.
String	getMessageBoxId() The identifier of the associated message box.
String	getOnclick() Returns the onclick action of the 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.
String	getRolloverImage() Returns the URL of the image representing the button when the cursor is over the button.
String	getSelected() Returns the selection state of this button.
String	getSelectedImage() Returns the URL of the image representing the button when this button is selected.
String	getStyle() Returns the inline client style of this component.
String	getStyleClass() Returns the client CSS class(es) of this component.
String	getTitle() Returns the title of the button.
String	getToggle() Returns the toggle state of this button.
String	getType() Returns the type of the button.
void	setAction(String action) Sets the MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.
void	setActionListener(String actionListener) Sets the MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.
void	setButtonGroupId(String buttonGroupId) Sets the identifier of the button group linked to this button.
void	setCursor(String cursor) Sets the cursor displayed when the mouse is on the button.
void	setDoActionOnBGDeselect(String doActionOnBGDeselect) Sets whether the button should execute its action when it's deselected by its button group.
void	setEnabled(String enabled) Sets whether this button is a enabled or not.
void	setImage(String image) Sets the URL of the image representing the button.
void	setImmediate(String immediate) Sets the "immediate execution" flag for this UIComponent.
void	setMessage(String message) Sets the message that can be displayed when the cursor is on the button.
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.
void	setOnclick(String onclick) Sets The onclick action of the button.
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.
void	setRolloverImage(String rolloverImage) Sets the URL of the image representing the button when the cursor is over the button.
void	setSelected(String selected) Sets the selection state of this button, if this button is a toggle button.
void	setSelectedImage(String selectedImage) Sets the URL of the image representing the button when this button is selected.
void	setStyle(String style) Sets the inline client style of this component.
void	setStyleClass(String styleClass) Sets the client CSS class(es) of this component.
void	setTitle(String title) Sets the title of the button.
void	setToggle(String toggle) Sets whether this button is a toggle button or not.
void	setType(String type) Sets the type of the button.

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

setProperty, setVBProperty, testSetProperties

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

IlvImageButtonTag

public IlvImageButtonTag()

Creates a new IlvImageButtonTag 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 IlvBaseTag

Parameters:

component - The component whose properties are to be overridden

getMessageBoxId

public String getMessageBoxId()

The identifier of the associated message box.

Returns:

The ID of the associated message box.

Since:

JViews 6.5

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.

Since:

JViews 6.5

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 to a message box.

Since:

JViews 6.5

getButtonGroupId

public String getButtonGroupId()

Returns the identifier of the button group.

Returns:

The identifier of the button group.

setButtonGroupId

public void setButtonGroupId(String buttonGroupId)

Sets the identifier of the button group linked to this button. One toggle button can be selected at a time in a button group.

Parameters:

buttonGroupId - The identifier of the button group.

getCursor

public String getCursor()

Returns the cursor displayed when the mouse is on the button.

Returns:

Returns the cursor displayed when the mouse is on the button.

setCursor

public void setCursor(String cursor)

Sets the cursor displayed when the mouse is on the button.

Parameters:

cursor - The cursor to be set.

getImage

public String getImage()

Returns the URL of the image representing the button.

Returns:

The URL of the image representing the button.

setImage

public void setImage(String image)

Sets the URL of the image representing the button.

Parameters:

image - The image URL to be set on this button.

getMessage

public String getMessage()

Returns the message that can be displayed when the cursor is on the button.

Returns:

The message that can be displayed when the cursor is on the button.

setMessage

public void setMessage(String message)

Sets the message that can be displayed when the cursor is on the button.

Parameters:

message - The message that can be displayed when the cursor is on the button.

getOnclick

public String getOnclick()

Returns the onclick action of the button. This JavaScript action will be executed when the button is clicked.

Returns:

The onclick action.

setOnclick

public void setOnclick(String onclick)

Sets The onclick action of the button. This JavaScript action will be executed when the button is clicked.

Parameters:

onclick - The onclick action to be to set on this button.

getRolloverImage

public String getRolloverImage()

Returns the URL of the image representing the button when the cursor is over the button.

Returns:

The URL of the rollover image of this button.

setRolloverImage

public void setRolloverImage(String rolloverImage)

Sets the URL of the image representing the button when the cursor is over the button.

Parameters:

rolloverImage - The URL of the rollover image to be set.

getSelected

public String getSelected()

Returns the selection state of this button. This state is significant if this button is a toggle button.

Returns:

The selection state of this button.

setSelected

public void setSelected(String selected)

Sets the selection state of this button, if this button is a toggle button.

Parameters:

selected - The selection state to be set to this button.

getSelectedImage

public String getSelectedImage()

Returns the URL of the image representing the button when this button is selected.

Returns:

The URL of the selected image of this button.

setSelectedImage

public void setSelectedImage(String selectedImage)

Sets the URL of the image representing the button when this button is selected.

Parameters:

selectedImage - The URL of the image to be set.

getStyle

public String getStyle()

Returns the inline client style of this component.

Returns:

The style.

setStyle

public void setStyle(String style)

Sets the inline client style of this component.

Parameters:

style - The style to set.

getStyleClass

public String getStyleClass()

Returns the client CSS class(es) of this component.

Returns:

The styleClass.

setStyleClass

public void setStyleClass(String styleClass)

Sets the client CSS class(es) of this component.

Parameters:

styleClass - The styleClass to set.

getTitle

public String getTitle()

Returns the title of the button.

Returns:

The title.

setTitle

public void setTitle(String title)

Sets the title of the button.

Parameters:

title - The title to set.

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

getToggle

public String getToggle()

Returns the toggle state of this button. If the button is a toggle button, it has two selection states (selected and not selected).

Returns:

The toggle state of this button.

setToggle

public void setToggle(String toggle)

Sets whether this button is a toggle button or not.

Parameters:

toggle - The toggle state to be set on this button.

getType

public String getType()

Returns the type of the button. Valid values are submit or button. A submit button will submit a new request to the server. A button set in button type will execute the onclick action without requesting the server.

Returns:

The button type.

setType

public void setType(String type)

Sets the type of the button. Valid values are submit or button. A submit button will submit a new request to the server. A button set in button type will execute the onclick action without requesting the server.

Parameters:

type - The button type to be set.

getAction

public String getAction()

Returns the MethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.

setAction

public void setAction(String action)

Sets the MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property. Any method referenced by such an expression must be public, with a return type ofString, and accept no parameters.

Parameters:

action - The method binding reference or a constant outcome.

getActionListener

public String getActionListener()

Returns theMethodBinding pointing at an action listener method to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending upon the value of the immediate property.

setActionListener

public void setActionListener(String actionListener)

Sets the MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property. Any method referenced by such an expression must be public, with a return type of String, and accept no parameters.

Parameters:

actionListener - The method binding reference.

getImmediate

public String getImmediate()

Returns a flag indicating that the default ActionListener provided by the JavaServer Faces implementation should be executed immediately (that is, during the Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase. The default value for this property must be false.

setImmediate

public void setImmediate(String immediate)

Sets the "immediate execution" flag for this UIComponent.

getDoActionOnBGDeselect

public String getDoActionOnBGDeselect()

Returns whether the button should execute its action when it's deselected by its button group. It's happening when another button of the button group is selected.

Returns:

"true" if the button should execute it's javascript action when i'ts deselected, "false" otherwise. Or a value binding expression to the boolean property.

Since:

JViews 7.5

setDoActionOnBGDeselect

public void setDoActionOnBGDeselect(String doActionOnBGDeselect)

Sets whether the button should execute its action when it's deselected by its button group. It's happening when another button of the button group is selected.

Parameters:

doActionOnBGDeselect - The string representation the boolean value or a value binding expression.

Since:

JViews 7.5