Class DwtButton

Object
   |
   +--DwtControl
         |
         +--DwtComposite
               |
               +--DwtLabel
                     |
                     +--DwtButton

Direct Known Subclasses:

DwtSelect

class DwtButton

extends DwtLabel

This class represents a button, which is basically a smart label that can handle various UI events. It knows when it has been activated (the mouse is over it), when it has been triggered (mouse down), and when it has been pressed (mouse up). In addition to a label's image and/or text, a button may have a dropdown menu.
Defined in DwtButton.js

Author: Ross Dargahi , Conrad Damon

Field Detail

_actionTiming

Object _actionTiming

_activatedClassName

Object _activatedClassName

_dropDownEvtMgr

Object _dropDownEvtMgr

_mouseDownListener

Object _mouseDownListener

_mouseOutListener

Object _mouseOutListener

_mouseOverListener

Object _mouseOverListener

_mouseUpListener

Object _mouseUpListener

_origClassName

Object _origClassName

_toggled

Object _toggled

_toggledClassName

Object _toggledClassName

_triggeredClassName

Object _triggeredClassName

ACTION_MOUSEDOWN

<static> Object ACTION_MOUSEDOWN

ACTION_MOUSEUP

<static> Object ACTION_MOUSEUP

TOGGLE_STYLE

<static> Object TOGGLE_STYLE

DwtButton

DwtButton(parent, style, className, posStyle, actionTiming)

Creates a button.

Parameters:
parent - the parent widget
style - the label style (see DwtLabel)
className - a CSS class
posStyle - positioning style

Author: Ross Dargahi , Conrad Damon

_addMouseListeners

void _addMouseListeners()

_removeDropDownCellMouseHandlers

void _removeDropDownCellMouseHandlers()

_removeMouseListeners

void _removeMouseListeners()

_setMouseOutClassName

void _setMouseOutClassName()

_setupDropDownCellMouseHandlers

void _setupDropDownCellMouseHandlers()

_toggleMenu

void _toggleMenu()

addDropDownSelectionListener

Object addDropDownSelectionListener(listener)

Adds a listener to be notified when the dropdown arrow is pressed.

Parameters:
listener - a listener

addSelectionListener

void addSelectionListener(listener)

Adds a listener to be notified when the button is pressed.

Parameters:
listener - a listener

deactivate

void deactivate()

getMenu

Object getMenu()

Returns the button's menu

isToggled

Object isToggled()

popup

void popup()

removeDropDownSelectionListener

void removeDropDownSelectionListener(listener)

Removes a dropdown selection listener.

Parameters:
listener - the listener to remove

removeSelectionListener

void removeSelectionListener(listener)

Removes a selection listener.

Parameters:
listener - the listener to remove

removeSelectionListeners

void removeSelectionListeners()

Removes all the selection listeners.

resetClassName

void resetClassName()

Returns the button display to normal (not activated or triggered).

setActionTiming

void setActionTiming(actionTiming)

setActivated

void setActivated(activated)

Activates/inactivates the button. A button is activated when the mouse is over it.

Parameters:
activated - whether the button is activated

setDepressedImage

void setDepressedImage(imageInfo)

setDropDownImages

void setDropDownImages(enabledImg, disImg, hovImg, depImg)

setEnabled

void setEnabled(enabled)

Sets the enabled/disabled state of the button. A disabled button may have a different image, and greyed out text. The button (and its menu) will only have listeners if it is enabled.

Parameters:
enabled - whether to enable the button

setEnabledImage

void setEnabledImage(imageInfo)

setHoverImage

void setHoverImage(hoverImageInfo)

setMenu

void setMenu(menuOrCallback, shouldToggle, followIconStyle)

Adds a dropdown menu to the button, available through a small down-arrow.

Parameters:
menuOrCallback - The dropdown menu or an AjxCallback object. If a callback is given, it is called the first time the menu is requested. The callback must return a valid DwtMenu object.
shouldToggle -
followIconStyle - style of menu item (should be checked or radio style) for which the button icon should reflect the menu item icon

setToggled

void setToggled(toggled)

toString

Object toString()

trigger

void trigger()

_dropDownCellMouseDownHdlr

<static> Object _dropDownCellMouseDownHdlr(ev)

_dropDownCellMouseUpHdlr

<static> Object _dropDownCellMouseUpHdlr(ev)