public class IlvImageButtonTag extends IlvBaseTag implements IlvDHTMLConstants
bodyContent, pageContext, UNIQUE_ID_PREFIX
ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, 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, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE
AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_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, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH
Constructor and Description |
---|
IlvImageButtonTag()
Creates a new
IlvImageButtonTag instance. |
Modifier and Type | Method and Description |
---|---|
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 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 |
getBaseTextDirection()
Returns the baseTextDirection.
|
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 |
setBaseTextDirection(String baseTextDirection)
Sets the baseTextDirection.
|
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 is deselected by its button group.
|
void |
setEnabled(String enabled)
Sets whether this button is 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(javax.faces.component.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. |
getPartialTriggers, getStringArray, setPartialTriggers, setProperty, setVBProperty, testSetProperties
createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setRendered
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
public IlvImageButtonTag()
IlvImageButtonTag
instance.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.
getComponentType
in class IlvBaseTag
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.
getRendererType
in class IlvBaseTag
protected void setProperties(javax.faces.component.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); } }
setProperties
in class IlvBaseTag
component
- The component whose properties are to be
overriddenpublic String getMessageBoxId()
public void setMessageBoxId(String messageBoxId)
messageBoxId
- The ID of the message box to set to the view.public String getMessageBox()
public void setMessageBox(String messageBox)
messageBox
- The binding to a message box.public String getButtonGroupId()
public void setButtonGroupId(String buttonGroupId)
buttonGroupId
- The identifier of the button group.public String getCursor()
public void setCursor(String cursor)
cursor
- The cursor to be set.public String getImage()
public void setImage(String image)
image
- The image URL to be set on this button.public String getMessage()
public void setMessage(String message)
message
- The message that can be displayed when the cursor is on the
button.public String getOnclick()
onclick
action of the button. This JavaScript action will be
executed when the button is clicked.onclick
action.public void setOnclick(String onclick)
onclick
action of the button. This JavaScript action will be
executed when the button is clicked.onclick
- The onclick
action to be to set on this button.public String getRolloverImage()
public void setRolloverImage(String rolloverImage)
rolloverImage
- The URL of the rollover image to be set.public String getSelected()
public void setSelected(String selected)
selected
- The selection state to be set to this button.public String getSelectedImage()
public void setSelectedImage(String selectedImage)
selectedImage
- The URL of the image to be set.public String getStyle()
style
of this component.style
.public void setStyle(String style)
style
of this component.style
- The style
to set.public String getStyleClass()
styleClass
.public void setStyleClass(String styleClass)
styleClass
- The styleClass
to set.public String getTitle()
title
of the button.title
.public void setTitle(String title)
title
of the button.title
- The title
to set.public String getEnabled()
enabled
state of this button.enabled
state of this button.public void setEnabled(String enabled)
enabled
- The enabled
state to be set on this button.public String getToggle()
toggle
state of this button. If the button is a toggle button,
it has two selection states (selected and not selected).toggle
state of this button.public void setToggle(String toggle)
toggle
- The toggle
state to be set on this button.public String getType()
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.public void setType(String type)
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.type
- The button type to be set.public String getAction()
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.public void setAction(String action)
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.action
- The method binding reference or a constant outcome.public String getActionListener()
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.public void setActionListener(String actionListener)
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.actionListener
- The method binding reference.public String getImmediate()
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
.public void setImmediate(String immediate)
UIComponent
.public String getDoActionOnBGDeselect()
"true"
if the button executes its JavaScript action when it is deselected,
"false"
otherwise. Or a value binding expression to the boolean property.public void setDoActionOnBGDeselect(String doActionOnBGDeselect)
doActionOnBGDeselect
- The string representation the boolean value or a value binding expression.public String getBaseTextDirection()
public void setBaseTextDirection(String baseTextDirection)
baseTextDirection
- The base Text Direction to set.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.