PREV CLASS    Documentation homepage     NEXT CLASS 

IlvImageButtonProxy

IlvObject
  |
  +--IlvPropertyStateManager
       |
       +--IlvFacesProxy
            |
            +--IlvSizedViewProxy
                 |
                 +--IlvImageButtonProxy
Category:
Framework JSF component
JavaScript File:
IlvImageButtonProxy.js
Description:
JavaScript proxy for the IlvDHTMLImageButton component.
If this button is grouped, the wrapped instance is an IlvGroupedButton or an IlvToggleButton otherwise.

Constructor Summary
IlvImageButtonProxy(clientId, refNodeId, grouped)

Method Summary
doClick()
Simulates a mouse click on the button.
This method can be useful when the button is in a button group.
getCursor()
Returns the mouse cursor that is displayed when the mouse is over this panel.
getDoActionOnBGDeselect()
Returns whether the button should execute its action when it's deselected by its button group.
getImage()
Returns the image that represents the button when the button is in normal state.
getMessage()
Returns the message displayed by the attached message box, if any, when the cursor is on this button.
getMessageBox()
Sets the message box of the button.
getOnclick()
Returns the onclick action of the button.
getRolloverImage()
Returns the image that represents the button when the cursor is on the button.
getSelectedImage()
Returns the image that represents the button when the button is in selected state.
getTitle()
Returns the title of the button.
isEnabled()
Returns the enabled state of this button.
isSelected()
Returns the selection state of this button.
isToggle()
Returns true if this button is a toggle button, false otherwise.
setCursor(cursor)
Sets the mouse cursor that is displayed when the mouse is over this button.
setDoActionOnBGDeselect(doActionOnBGDeselect)
Sets whether the button should execute its action when it's deselected by its button group.
setEnabled(enabled)
Sets the enable state.
setImage(image)
Sets the image that represents the button when the button is in normal state.
setMessage(message)
The message displayed by the attached message box, if any, when the cursor is on this button.
setMessageBox(messageBox)
Sets the message box of the button.
setOnclick(onclick)
Sets the onclick action of the button.
setRolloverImage(image)
Sets the image that represents the button when the cursor is on the button.
setSelected(selected)
Sets the selection state.
setSelectedImage(image)
Sets the image that represents the button when the button is in selected state.
setTitle(title)
The title of the button.
setToggle(toggle)
Defines whether this button is a toggle button.

Constructor Detail

IlvImageButtonProxy

IlvImageButtonProxy(clientId, refNodeId, grouped)
Creates an instance of IlvImageButtonProxy.

Method Detail

doClick

 
doClick()
Simulates a mouse click on the button.
This method can be useful when the button is in a button group.

Since:
JViews 7.5

getCursor

 
getCursor()
Returns the mouse cursor that is displayed when the mouse is over this panel.

getDoActionOnBGDeselect

 
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:
The doActionOnBGDeselect.

Since:
JViews 7.5

getImage

 
getImage()
Returns the image that represents the button when the button is in normal state.
Returns:
The image URL to set.

getMessage

 
getMessage()
Returns the message displayed by the attached message box, if any, when the cursor is on this button.
Returns:
The message to display.

getMessageBox

 
getMessageBox()
Sets the message box of the button. The messages of the button will be displayed in this message box.
Returns:
The message box.

getOnclick

 
getOnclick()
Returns the onclick action of the button. This JavaScript action will be executed when the button is clicked.
Returns:
The onclick action.

getRolloverImage

 
getRolloverImage()
Returns the image that represents the button when the cursor is on the button.
Returns:
The image URL to set.

getSelectedImage

 
getSelectedImage()
Returns the image that represents the button when the button is in selected state.
Returns:
The image URL to set.

getTitle

 
getTitle()
Returns the title of the button.
Returns:
The title.

isEnabled

 
isEnabled()
Returns the enabled state of this button.
Returns:
Whether this button is enabled or not.

isSelected

 
isSelected()
Returns the selection state of this button.
Returns:
The selection state of this button.

isToggle

 
isToggle()
Returns true if this button is a toggle button, false otherwise.
Returns:
true if this button is a toggle button, false otherwise.

setCursor

 
setCursor(cursor)
Sets the mouse cursor that is displayed when the mouse is over this button.
Parameters:
cursor - A string representing the cursor type according to the specifications of the Cascading Style Sheets (CSSs).

setDoActionOnBGDeselect

 
setDoActionOnBGDeselect(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 doActionOnBGDeselect to set.

Since:
JViews 7.5

setEnabled

 
setEnabled(enabled)
Sets the enable state.
Parameters:
enabled - Whether this button is enable or not

setImage

 
setImage(image)
Sets the image that represents the button when the button is in normal state.
Parameters:
image - The image URL to set.

setMessage

 
setMessage(message)
The message displayed by the attached message box, if any, when the cursor is on this button.
Parameters:
message - The message to display.

setMessageBox

 
setMessageBox(messageBox)
Sets the message box of the button. The messages of the button will be displayed in this message box.
Parameters:
messageBox - The message box.

setOnclick

 
setOnclick(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 set on this button.

setRolloverImage

 
setRolloverImage(image)
Sets the image that represents the button when the cursor is on the button.
Parameters:
image - The image URL to set.

setSelected

 
setSelected(selected)
Sets the selection state.
Parameters:
selected - The selection state of this button.

setSelectedImage

 
setSelectedImage(image)
Sets the image that represents the button when the button is in selected state.
Parameters:
image - The image URL to set.

setTitle

 
setTitle(title)
The title of the button.
Parameters:
title - The title to set.

setToggle

 
setToggle(toggle)
Defines whether this button is a toggle button.
Parameters:
toggle - true if this button is a toggle button, false otherwise.

Inherited Methods from IlvSizedViewProxy
afterLayoutHandler, getAbsoluteBounds, getBounds, getCreationSize, getHeight, getMinimumSize, getWidth, onResize, positionAfterLayout, registerResizeListener, resizeAfterLayout, setMinimumSize
Inherited Methods from IlvFacesProxy
getAbsoluteId, getJViewsDHTMLObject, getNodeCoords, getObject, getReferenceNode, setAbsoluteId, setJViewsDHTMLObject, setObject, setReferenceNode, toHTML
Inherited Methods from IlvPropertyStateManager
getClientId, notify
Inherited Methods from IlvObject
callDispose, dispose, getClassName, hashCode, inherits, instanceOf, invoke, registerDispose, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
 PREV CLASS    Documentation homepage     NEXT CLASS