Class: BitBtn

Source Location: /buttons.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control
            |
            --FocusControl
               |
               --QWidget
                  |
                  --BitBtn

BitBtn is a push button control that can include a bitmap on its face.

Author(s):

Child classes:

SpeedButton: SpeedButton is a button that is used to execute commands or set modes.

Inherited Variables

Inherited Methods

Class: QWidget

QWidget::__construct()
QWidget::addOtherChildren(): Override this method to add more childrens to a qwidget parent, useful if your component is built by more than one component
QWidget::dumpChildrenControls(): Code to dump when the Widget accepts children controls.
QWidget::dumpCommonContentsBottom(): Dump common qooxdoo finalization code
QWidget::dumpCommonContentsTop(): Dump the common qooxdoo initialization code
QWidget::dumpCommonQWidgetJSEvents(): This function uses PrepareQWJSEvent to dump the attachment for common javascript events
QWidget::dumpCommonQWidgetProperties(): Dumps to the output the code to set common properties, like enabled, font, color, etc.
QWidget::dumpHeaderCode()
QWidget::getHidden()
QWidget::PrepareQWJSEvent(): Dumps code to add an event for the widget
QWidget::setHidden()

Class: FocusControl

FocusControl::__construct()
FocusControl::dumpChildren(): Dumps all children iterating through the Controls property and calls the show method of each one.
FocusControl::readControlCount(): Returns the number of controls for which this control is the Parent.
FocusControl::readLayout(): Specifies the Layout this control uses to render its controls to the browser.
FocusControl::updateChildrenColors(): Updates the colors for all the children if parentcolor is set.
FocusControl::updateChildrenFonts(): If this control has any children that have ParentFont==true, then this function will assign the same Font property to all children Font properties.
FocusControl::updateChildrenParentProperties(): Updates all necessary properties for any children that use property values from their parent.
FocusControl::updateChildrenShowHints(): Updates the ShowHints properties for all children controls.
FocusControl::writeLayout()

Class: Control

Control::__construct(): Constructor for the class
Control::addJSWrapperToEvents(): Adds or replaces the JS event attribute with the wrapper.
Control::beginCache()
Control::canShow(): Determines whether a control can be shown or not.
Control::defaultAdjustToLayout()
Control::defaultAlign()
Control::defaultAlignment()
Control::defaultAttributes()
Control::defaultAutosize()
Control::defaultCached()
Control::defaultCaption()
Control::defaultColor()
Control::defaultCursor()
Control::defaultDesignColor()
Control::defaultDivWrap()
Control::defaultEnabled()
Control::defaultHeight()
Control::defaultHidden()
Control::defaultHint()
Control::defaultIsLayer()
Control::defaultjsOnActivate()
Control::defaultjsOnBeforeCopy()
Control::defaultjsOnBeforeCut()
Control::defaultjsOnBeforeDeactivate()
Control::defaultjsOnBeforeEditfocus()
Control::defaultjsOnBeforePaste()
Control::defaultjsOnBlur()
Control::defaultjsOnChange()
Control::defaultjsOnClick()
Control::defaultjsOnContextMenu()
Control::defaultjsOnControlSelect()
Control::defaultjsOnCopy()
Control::defaultjsOnCut()
Control::defaultjsOnDblClick()
Control::defaultjsOnDeActivate()
Control::defaultjsOnDrag()
Control::defaultjsOnDragEnter()
Control::defaultjsOnDragLeave()
Control::defaultjsOnDragOver()
Control::defaultjsOnDragStart()
Control::defaultjsOnDrop()
Control::defaultjsOnFilterChange()
Control::defaultjsOnFocus()
Control::defaultjsOnHelp()
Control::defaultjsOnKeyDown()
Control::defaultjsOnKeyPress()
Control::defaultjsOnKeyUp()
Control::defaultjsOnLoseCapture()
Control::defaultjsOnMouseDown()
Control::defaultjsOnMouseEnter()
Control::defaultjsOnMouseLeave()
Control::defaultjsOnMouseMove()
Control::defaultjsOnMouseOut()
Control::defaultjsOnMouseOver()
Control::defaultjsOnMouseUp()
Control::defaultjsOnPaste()
Control::defaultjsOnPropertyChange()
Control::defaultjsOnReadyStateChange()
Control::defaultjsOnResize()
Control::defaultjsOnResizeEnd()
Control::defaultjsOnResizeStart()
Control::defaultjsOnSelectStart()
Control::defaultLayer()
Control::defaultLeft()
Control::defaultOnAfterShow()
Control::defaultOnBeforeShow()
Control::defaultOnShow()
Control::defaultParentColor()
Control::defaultParentFont()
Control::defaultParentShowHint()
Control::defaultPopupmenu()
Control::defaultShowHint()
Control::defaultStyle()
Control::defaultTop()
Control::defaultVisible()
Control::defaultWidth()
Control::dumpChildren(): Dumps all children components.
Control::dumpContents(): Dumps the control contents.
Control::dumpHeaderCode(): Dumps the component header code.
Control::dumpJavascript(): Dumps all required javascript code for the component.
Control::dumpJsEvents(): Dumps all assigned javascript events code.
Control::endCache()
Control::getCached()
Control::getCursor(): Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control.
Control::getHeight(): Specifies the vertical size of the control or form in pixels.
Control::getHint(): Specifies the text to show in a tooltip when the mouse is over the control for some time.
Control::getHintAttribute(): If control has any Hint, then returns the hint in attribute format for the tag.
Control::getJSWrapperFunction(): JS wrapper function that forwards a JS event to the PHP script by submitting the HTML form.
Control::getJSWrapperFunctionName(): Gets the function name of a JS event wrapper.
Control::getLayer(): Determines the layer in which this control is going to be rendered.
Control::getLeft(): Uses the Left property to determine where the left side of the control begins, or to reposition the left side of the control.
Control::getOnAfterShow(): Fires the Event after showing the control.
Control::getOnBeforeShow(): Fires the Event before showing the control.
Control::getOnShow(): Fires the Event at the same moment the control is shown. Some controls can prevent the control from being shown when this event is attached.
Control::getTop(): Uses Top to locate the top of the control, or reposition the control to a different Y coordinate.
Control::getWidth(): Specifies the horizontal size of the control or form in pixels.
Control::init()
Control::loaded()
Control::readAdjustToLayout(): A helper property for Layouts to know if the component should adjust to the layout or not
Control::readAlign(): Determines how the control aligns within its container (parent control).
Control::readAlignment(): Specifies the alignment to be used by the control, it depends on the control on how to use this property to show information.
Control::readAttributes(): A property for tag based controls to allow component user to add attributes to the tag
Control::readAutosize(): Determines if the control is going to adjust itself to the parent size
Control::readCaption(): Specifies a text string that identifies the control to the user.
Control::readColor(): Specifies the main color of the control.
Control::readControlStyle(): An array which holds the control style, with settings for the IDE.
Control::readDesignColor(): Specifies a color to use by the control at design time.
Control::readDivWrap(): Specifies if the control must be wrapped by a div or not
Control::readDoParentReset(): Performs a parent reset if true.
Control::readEnabled(): Controls whether the control responds to mouse, keyboard, and timer events.
Control::readFont(): Determines the Font to be used when generating this control.
Control::readHidden(): This property, when true, allows controls to generate all code, but don't show the control on the browser.
Control::readIsLayer(): Specifies if this control is a Layer instead of being integrated into the document.
Control::readJsEvents(): Returns a string with all assigned javascript events, ready to be added to a control tag.
Control::readjsOnActivate(): Fires when the object is set as the active element.
Control::readjsOnBeforeCopy(): Fires on the source object before the selection is copied to the system clipboard.
Control::readjsOnBeforeCut(): Fires on the source object before the selection is deleted from the document.
Control::readjsOnBeforeDeactivate(): Fires immediately before the activeElement is changed from the current object to another object in the parent document.
Control::readjsOnBeforeEditfocus(): Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.
Control::readjsOnBeforePaste(): Fires on the target object before the selection is pasted from the system clipboard to the document.
Control::readjsOnBlur(): Fires when the object loses the input focus.
Control::readjsOnChange(): Fires when the contents of the object or selection have changed.
Control::readjsOnClick(): Fires when the user clicks the left mouse button on the object.
Control::readjsOnContextMenu(): Fires when the user clicks the right mouse button in the client area, opening the context menu.
Control::readjsOnControlSelect(): Fires when the user is about to make a control selection of the object.
Control::readjsOnCopy(): Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
Control::readjsOnCut(): Fires on the source element when the object or selection is removed from the document and added to the system clipboard.
Control::readjsOnDblClick(): Fires when the user double-clicks the object.
Control::readjsOnDeActivate(): Fires when the activeElement is changed from the current object to another object in the parent document.
Control::readjsOnDrag(): Fires on the source object continuously during a drag operation.
Control::readjsOnDragEnter(): Fires on the target element when the user drags the object to a valid drop target.
Control::readjsOnDragLeave(): Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Control::readjsOnDragOver(): Fires on the target element continuously while the user drags the object over a valid drop target.
Control::readjsOnDragStart(): Fires on the source object when the user starts to drag a text selection or selected object.
Control::readjsOnDrop(): Fires on the target object when the mouse button is released during a drag-and-drop operation.
Control::readjsOnFilterChange(): Fires when a visual filter changes state or completes a transition.
Control::readjsOnFocus(): Fires when the object receives focus.
Control::readjsOnHelp(): Fires when the user presses the F1 key while the browser is the active window.
Control::readjsOnKeyDown(): Fires when the user presses a key.
Control::readjsOnKeyPress(): Fires when the user presses an alphanumeric key.
Control::readjsOnKeyUp(): Fires when the user releases a key.
Control::readjsOnLoseCapture(): Fires when the object loses the mouse capture.
Control::readjsOnMouseDown(): Fires when the user clicks the object with either mouse button.
Control::readjsOnMouseEnter(): Fires when the user moves the mouse pointer into the object.
Control::readjsOnMouseLeave(): Fires when the user moves the mouse pointer outside the boundaries of the object.
Control::readjsOnMouseMove(): Fires when the user moves the mouse over the object.
Control::readjsOnMouseOut(): Fires when the user moves the mouse pointer outside the boundaries of the object.
Control::readjsOnMouseOver(): Fires when the user moves the mouse pointer into the object.
Control::readjsOnMouseUp(): Fires when the user releases a mouse button while the mouse is over the object.
Control::readjsOnPaste(): Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.
Control::readjsOnPropertyChange(): Fires when a property changes on the object.
Control::readjsOnReadyStateChange(): Fires when the state of the object has changed.
Control::readjsOnResize(): Fires when the size of the object is about to change.
Control::readjsOnResizeEnd(): Fires when the user finishes changing the dimensions of the object in a control selection.
Control::readjsOnResizeStart(): Fires when the user begins to change the dimensions of the object in a control selection
Control::readjsOnSelectStart(): Fires when the object is being selected
Control::readJSWrapperHiddenFieldName(): Gets the name of the hidden field used to submit the value for the event that was fired.
Control::readJSWrapperSubmitEventValue(): Sets the value to the hidden field when the specific JS event was fired and the wrapper function was called.
Control::readParent(): Indicates the parent of the control.
Control::readParentColor(): Determines where a control looks for its color information.
Control::readParentFont(): Determines where a control looks for its font information.
Control::readParentShowHint(): Determines where a control looks to find out if its Help Hint should be shown.
Control::readPopupMenu(): Identifies the pop-up menu associated with the control.
Control::readShowHint(): Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
Control::readStyle(): Use this property to attach a css style to the control.
Control::readStyleClass(): Normalizes the css style class name
Control::readVisible(): Determines whether the component appears on the browser.
Control::setCached()
Control::setCursor()
Control::setHeight()
Control::setHint()
Control::setLayer()
Control::setLeft()
Control::setOnAfterShow()
Control::setOnBeforeShow()
Control::setOnShow()
Control::setTop()
Control::setWidth()
Control::show(): Dumps the code for the control to the output.
Control::updateParentColor(): If ParentColor == true the parent's color is assigned to this control.
Control::updateParentFont(): If ParentFont == true the parent's font is assigned to this control.
Control::updateParentProperties(): Updates all properties that use the parent property as source.
Control::updateParentShowHint(): If ParentShowHint == true the parent's showhint is assigned to this control.
Control::writeAdjustToLayout()
Control::writeAlign()
Control::writeAlignment()
Control::writeAttributes()
Control::writeAutosize()
Control::writeCaption()
Control::writeColor()
Control::writeControlStyle()
Control::writeDesignColor()
Control::writeDivWrap()
Control::writeEnabled()
Control::writeFont()
Control::writeHidden()
Control::writeIsLayer()
Control::writejsOnActivate()
Control::writejsOnBeforeCopy()
Control::writejsOnBeforeCut()
Control::writejsOnBeforeDeactivate()
Control::writejsOnBeforeEditfocus()
Control::writejsOnBeforePaste()
Control::writejsOnBlur()
Control::writejsOnChange()
Control::writejsOnClick()
Control::writejsOnContextMenu()
Control::writejsOnControlSelect()
Control::writejsOnCopy()
Control::writejsOnCut()
Control::writejsOnDblClick()
Control::writejsOnDeActivate()
Control::writejsOnDrag()
Control::writejsOnDragEnter()
Control::writejsOnDragLeave()
Control::writejsOnDragOver()
Control::writejsOnDragStart()
Control::writejsOnDrop()
Control::writejsOnFilterChange()
Control::writejsOnFocus()
Control::writejsOnHelp()
Control::writejsOnKeyDown()
Control::writejsOnKeyPress()
Control::writejsOnKeyUp()
Control::writejsOnLoseCapture()
Control::writejsOnMouseDown()
Control::writejsOnMouseEnter()
Control::writejsOnMouseLeave()
Control::writejsOnMouseMove()
Control::writejsOnMouseOut()
Control::writejsOnMouseOver()
Control::writejsOnMouseUp()
Control::writejsOnPaste()
Control::writejsOnPropertyChange()
Control::writejsOnReadyStateChange()
Control::writejsOnResize()
Control::writejsOnResizeEnd()
Control::writejsOnResizeStart()
Control::writejsOnSelectStart()
Control::writeParent()
Control::writeParentColor()
Control::writeParentFont()
Control::writeParentShowHint()
Control::writePopupMenu()
Control::writeShowHint()
Control::writeStyle()
Control::writeVisible()

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::unserialize(): This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 65]
BitBtn is a push button control that can include a bitmap on its face.

Bitmap buttons exhibit the same behavior as button controls. Use them to initiate actions from forms or pages.

Bitmap buttons implement properties that specify the bitmap images, along with their appearance and placement on the button. You can use your own customized bitmap for the button. The button can be associated with only one bitmap throught the ImageSource property.

You can specify the button�s response by writing an OnClick event handler.

Tags:

see:

Button, SpeedButton, QWidget

[ Top ]

Class Variables

$_action =

[line 78]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_buttonlayout = blImageLeft

[line 72]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_buttontype = btSubmit

[line 74]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_cancel =

[line 77]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_default =

[line 76]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_imageclicked = ""

[line 71]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_imagedisabled = ""

[line 70]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_imagesource = ""

[line 69]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_kind = bkCustom

[line 73]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_onclick = null

[line 67]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_spacing = 4

[line 75]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 80]

BitBtn __construct(
[
$aowner = null])

Overridden in child classes as:

SpeedButton::__construct()

Overrides QWidget::__construct() (parent method not documented)

Parameters:

$aowner

[ Top ]

method CommonScript [line 367]

void CommonScript(
)

This is an internal method you don't need to call directly

It dumps the common javascript code to update the control if used inside an Ajax call

Tags:

see:

BitBtn::dumpForAjax()

[ Top ]

method defaultAction [line 495]

void defaultAction(
)

[ Top ]

method defaultButtonLayout [line 551]

void defaultButtonLayout(
)

[ Top ]

method defaultButtonType [line 644]

void defaultButtonType(
)

[ Top ]

method defaultImageClicked [line 579]

void defaultImageClicked(
)

[ Top ]

method defaultImageDisabled [line 572]

void defaultImageDisabled(
)

[ Top ]

method defaultImageSource [line 525]

void defaultImageSource(
)

[ Top ]

method defaultKind [line 565]

void defaultKind(
)

[ Top ]

method defaultOnClick [line 434]

void defaultOnClick(
)

[ Top ]

method defaultSpacing [line 599]

void defaultSpacing(
)

[ Top ]

method dumpContents [line 184]

void dumpContents(
)

Overridden in child classes as:

SpeedButton::dumpContents()

Overrides Control::dumpContents() (Dumps the control contents.)

[ Top ]

method dumpForAjax [line 179]

void dumpForAjax(
)

This is an internal method you don't need to call directly

This method is called by the Ajax engine to get the code to update the component after an ajax call

Tags:

see:

commonScript()

[ Top ]

method dumpJavascript [line 125]

void dumpJavascript(
)

Overrides Control::dumpJavascript() (Dumps all required javascript code for the component.)

[ Top ]

method getAction [line 493]

string getAction(
)

Reserved for future use

The goal of this property is to link ActionList components with visual components to provide an easy way to execute actions.

[ Top ]

method getButtonLayout [line 549]

enum getButtonLayout(
)

Specifies the position where the image appears on the bitmap button.

ButtonLayout indicates whether the text appears on the left of the button (blImageLeft), the right of the button (blImageRight), the top (blImageTop) or the bottom (blImageBottom). To specify the image will be shown, check ImageSource property.

Possible values for this property are:

blImageBottom - Image will be placed at the bottom

blImageLeft - Image will be placed at the left

blImageRight - Image will be placed at the right

blImageTop - Image will be placed at the top

Tags:

see:

BitBtn::getImageSource()

[ Top ]

method getButtonType [line 642]

enum getButtonType(
)

Determines the type of button you want to create, this type determines also some built-in functions for buttons inside HTML forms.

A BitBtn can have 3 different types:

btSubmit - submits the HTML form

btReset - resets the HTML form back to the initial values

btNormal - is a regular button, the browser does not submit the form if no OnClick event has been assigned

Tags:

return:

(btSubmit, btReset, btNormal)

[ Top ]

method getCaption [line 472]

void getCaption(
)

[ Top ]

method getColor [line 475]

void getColor(
)

[ Top ]

method getEnabled [line 481]

void getEnabled(
)

[ Top ]

method getFont [line 478]

void getFont(
)

[ Top ]

method getImageClicked [line 577]

void getImageClicked(
)

This image appears when the button is clicked. The Up image reappears when the user releases the mouse button.

[ Top ]

method getImageDisabled [line 570]

void getImageDisabled(
)

This image usually appears dimmed to indicate that the button can't be selected.

[ Top ]

method getImageSource [line 523]

string getImageSource(
)

Specifies the image that appears on the bitmap button.

This property determines the URL where to find the image to be used as bitmap for this button. If empty no image is rendered on the button and you have to be sure the image is accesible to the web server. The image will be placed according to the setting of ButtonLayout property.

<?php
function Button1Click($sender, $params)
{
//Assigns an image to be shown on the bitbtn
$this->BitBtn1->ImageSource="images/btnok.gif";
}
?>

Tags:

see:

BitBtn::getButtonLayout()

[ Top ]

method getjsOnBlur [line 436]

void getjsOnBlur(
)

[ Top ]

method getjsOnClick [line 439]

void getjsOnClick(
)

[ Top ]

method getjsOnDblClick [line 442]

void getjsOnDblClick(
)

[ Top ]

method getjsOnFocus [line 445]

void getjsOnFocus(
)

[ Top ]

method getjsOnKeyDown [line 466]

void getjsOnKeyDown(
)

[ Top ]

method getjsOnKeyPress [line 463]

void getjsOnKeyPress(
)

[ Top ]

method getjsOnKeyUp [line 469]

void getjsOnKeyUp(
)

[ Top ]

method getjsOnMouseDown [line 448]

void getjsOnMouseDown(
)

[ Top ]

method getjsOnMouseMove [line 457]

void getjsOnMouseMove(
)

[ Top ]

method getjsOnMouseOut [line 460]

void getjsOnMouseOut(
)

[ Top ]

method getjsOnMouseOver [line 454]

void getjsOnMouseOver(
)

[ Top ]

method getjsOnMouseUp [line 451]

void getjsOnMouseUp(
)

[ Top ]

method getKind [line 563]

enum(bkCustom, getKind(
)

Specifies the kind of bitmap button.

Use Kind to specify the appearance of the BitBtn control.

The images (such as the green check mark on the OK button) appear on the button when using this version of BitBtn.

Tags:

return:

bkOK, bkCancel, bkYes, bkNo, bkHelp, bkClose, bkAbort, bkRetry, bkIgnore, bkAll)

[ Top ]

method getOnClick [line 432]

mixed getOnClick(
)

Occurs when the user clicks the control.

Use the OnClick event handler to respond when the user clicks the control.

Usually OnClick occurs when the user presses and releases the left mouse button with the mouse pointer over the control. This event can also occur when:

The user selects an item in a grid, outline, list, or combo box by pressing an arrow key.

The user presses Spacebar while a button or check box has focus.

The user presses Enter when the active form has a default button (specified by the Default property).

The user presses Esc when the active form has a cancel button (specified by the Cancel property).

[ Top ]

method getParentColor [line 601]

void getParentColor(
)

[ Top ]

method getParentFont [line 605]

void getParentFont(
)

[ Top ]

method getParentShowHint [line 608]

void getParentShowHint(
)

[ Top ]

method getPopupMenu [line 611]

void getPopupMenu(
)

[ Top ]

method getShowHint [line 614]

void getShowHint(
)

[ Top ]

method getSpacing [line 597]

integer getSpacing(
)

Determines where the image and text appear on a bitmap button.

Spacing determines the number of pixels between the image (specified in the Image properties) and the text (specified in the Caption property). The default value is 4 pixels.

If Spacing is a positive number, its value is the number of pixels between the image and text. If Spacing is 0, no pixels will be between the image and text. If Spacing is -1, the text appears centered between the image and the button edge. The number of pixels between the image and text is equal to the number of pixels between the text and the button edge opposite the glyph.

[ Top ]

method getVisible [line 617]

void getVisible(
)

[ Top ]

method init [line 109]

void init(
)

Overrides Control::init() (parent method not documented)

[ Top ]

method setAction [line 494]

void setAction(

$value)

Parameters:

$value

[ Top ]

method setButtonLayout [line 550]

void setButtonLayout(

$value)

Parameters:

$value

[ Top ]

method setButtonType [line 643]

void setButtonType(

$value)

Parameters:

$value

[ Top ]

method setCaption [line 473]

void setCaption(

$value)

Parameters:

$value

[ Top ]

method setColor [line 476]

void setColor(

$value)

Parameters:

$value

[ Top ]

method setEnabled [line 482]

void setEnabled(

$value)

Parameters:

$value

[ Top ]

method setFont [line 479]

void setFont(

$value)

Parameters:

$value

[ Top ]

method setImageClicked [line 578]

void setImageClicked(

$value)

Parameters:

$value

[ Top ]

method setImageDisabled [line 571]

void setImageDisabled(

$value)

Parameters:

$value

[ Top ]

method setImageSource [line 524]

void setImageSource(

$value)

Parameters:

$value

[ Top ]

method setjsOnBlur [line 437]

void setjsOnBlur(

$value)

Parameters:

$value

[ Top ]

method setjsOnClick [line 440]

void setjsOnClick(

$value)

Parameters:

$value

[ Top ]

method setjsOnDblClick [line 443]

void setjsOnDblClick(

$value)

Parameters:

$value

[ Top ]

method setjsOnFocus [line 446]

void setjsOnFocus(

$value)

Parameters:

$value

[ Top ]

method setjsOnKeyDown [line 467]

void setjsOnKeyDown(

$value)

Parameters:

$value

[ Top ]

method setjsOnKeyPress [line 464]

void setjsOnKeyPress(

$value)

Parameters:

$value

[ Top ]

method setjsOnKeyUp [line 470]

void setjsOnKeyUp(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseDown [line 449]

void setjsOnMouseDown(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseMove [line 458]

void setjsOnMouseMove(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseOut [line 461]

void setjsOnMouseOut(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseOver [line 455]

void setjsOnMouseOver(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseUp [line 452]

void setjsOnMouseUp(

$value)

Parameters:

$value

[ Top ]

method setKind [line 564]

void setKind(

$value)

Parameters:

$value

[ Top ]

method setOnClick [line 433]

void setOnClick(

$value)

Parameters:

$value

[ Top ]

method setParentColor [line 602]

void setParentColor(

$value)

Parameters:

$value

[ Top ]

method setParentFont [line 606]

void setParentFont(

$value)

Parameters:

$value

[ Top ]

method setParentShowHint [line 609]

void setParentShowHint(

$value)

Parameters:

$value

[ Top ]

method setPopupMenu [line 612]

void setPopupMenu(

$value)

Parameters:

$value

[ Top ]

method setShowHint [line 615]

void setShowHint(

$value)

Parameters:

$value

[ Top ]

method setSpacing [line 598]

void setSpacing(

$value)

Parameters:

$value

[ Top ]

method setVisible [line 618]

void setVisible(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:50:55 -0700 by phpDocumentor 1.4.1