IconButton

Overview

File

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class IconButton

Object
   |
   +--Button
         |
         +--IconButton

class IconButton
extends Button

Defined in example.lfo.jsui.js

Field Summary
`<final> String`	`className` Name of the class: "IconButton"
`Array(4)`	`color` R,G,B,A color of this Button's base (will tint image).
`String`	`iconFile` File name of an image file for this Button's icon.

Fields inherited from class Button


   data, className, handler, mouseWasOver, clicked, screenLocation, worldLocation, size, scale, color, hitmask, overmask, inactivemask, debug, clickedHoldMax, clickedCount, active, hidden, toggle

Constructor Summary
`IconButton (name, sketcher, iconFile)` Simple GUI Button subclass with picture icon.

Method Summary
`void`	`drawBase()` Overloaded drawBase function from Button that draws only the icon image.
`Boolean`	`loadIcon(iconFile)` Loads an icon image file, returns true if success, false otherwise.
`Object`	`parent(<String> name, <Object> sketcher)` Simple Button classes for GUI events.

Methods inherited from class Button



setActive, getActive, setHidden, getHidden, setScale, getScale, setSize, getSize, setWorldLocation, getWorldLocation, setScreenLocation, getScreenLocation, onclick, push, onidle, ondblclick, ondrag, onidleout, onresize, hitTest, setHandler, getHandler, setClicked, draw, drawClickedOverlay, drawOverOverlay, drawInactiveOverlay, toString, clone

Field Detail

className

<final> String className

See Also:: Constant Field Values

color

Array(4) color

R,G,B,A color of this Button's base (will tint image). Base color is by default all white [1,1,1,1].

iconFile

String iconFile

File name of an image file for this Button's icon.

Constructor Detail

IconButton

IconButton(name, sketcher, iconFile)

Simple GUI Button subclass with picture icon. Inherits from button parent class. Square by default.

Method Detail

drawBase

void drawBase()

Overloaded drawBase function from Button that draws only the icon image.

loadIcon

Boolean loadIcon(iconFile)

Loads an icon image file, returns true if success, false otherwise.

Returns:

true if success, false otherwise.

parent

Object parent(<String> name, <Object> sketcher)

Simple Button classes for GUI events. Reports it's data to a listener object with the functions clicked, mouseOver, mouseOut defined. Buttons are drawn around a center point (location).

Parameters:

name

sketcher