Rogue Wave JViews Framework JavaScript Reference: Class IlvInteractorButton

Class IlvInteractorButton

IlvObject
   |
   +--IlvEmptyView
      |
      +--IlvButton
         |
         +--IlvInteractorButton

Category:: Common component

JavaScript File:: IlvInteractorButton.js

Description:: This class implements a button that sets an interactor on a view each time it is pressed. This button is automatically deselected when a new interactor is set on the view.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvInteractorButton(left, top, width, height, image, interactor, view)

Method Summary
Method Attributes	Method Name and Description
	doInstall() This method is invoked when the button is pressed.
	getInteractor(interactor) Returns the interactor set on the view each time this button is pressed.
	getView(view) Returns the view associated with this button.
	mouseDown(e) This method is invoked when the mouse is pressed.
	mouseUp(e) This method is invoked when the mouse is released.
	setInteractor(interactor) Sets the interactor to be set on the view each time this button is pressed.
	setView(view) Sets the view associated with this button.

Methods inherited from class IlvButton
childrenToHTML, dispose, doClick, getAction, getBaseTextDirection, getCursor, getHeight, getImage, getMessage, getMessagePanel, getRolloverImage, getSelectedImage, getToolTipText, getWidth, isEnabled, isSelected, isToggleButton, mouseOut, mouseOver, setAction, setBaseTextDirection, setChildrenBounds, setCursor, setEnabled, setImage, setMessage, setMessagePanel, setRolloverImage, setSelected, setSelectedImage, setToggleButton, setToolTipText

Methods inherited from class IlvEmptyView
addSizeListener, getBounds, getLeft, getLocation, getSize, getTop, isStateInCookie, removeSizeListener, restoreState, saveState, setBounds, setLocation, setSize, setStateInCookie, toHTML

Methods inherited from class IlvObject
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility

Constructor Detail

IlvInteractorButton

IlvInteractorButton(left, top, width, height, image, interactor, view)

Parameters:: left - The absolute x position of the button on the page.; top - The absolute y position of the button on the page.; width - The width of the button.; height - The height of the button.; image - The URL of an image representing the button.; interactor - The interactor to be set on the view.; view - The view on which the interactor should be set. The view class must have the set/getInteractor(interactor) methods and the add/removeInteractorListener(listener) methods like the IlvView class or the IlvGanttComponentView class.

Method Detail

doInstall

doInstall()

This method is invoked when the button is pressed. It can be called directly to simulate a user's click on the button. Note: This implementation sets the interactor on the view.

getInteractor

getInteractor(interactor)

Returns the interactor set on the view each time this button is pressed.

Parameters:: interactor

getView

getView(view)

Returns the view associated with this button.

Parameters:: view

mouseDown

mouseDown(e)

This method is invoked when the mouse is pressed.

Parameters:: e

mouseUp

mouseUp(e)

This method is invoked when the mouse is released.

Parameters:: e

setInteractor

setInteractor(interactor)

Sets the interactor to be set on the view each time this button is pressed.

Parameters:: interactor

setView

setView(view)

Sets the view associated with this button.

Parameters:: view