API documentation: button cfe.module.image (Custom Form Elements for mootools)

Class cfe.module.image extends cfe.generic

Provides replacement for input[type=image]
This module dynamically appends the current state (hover, press) to the image filename given in the src attribute

Constructor

cfe.module.image


                                    (
                                    )

Properties

selector - `string`

CSS Selector to fetch "original" HTMLElements for replacement with this module

type - `string`

Describes the type of this element

Properties inherited from cfe.generic:

Methods

createOriginal


                                        
                                        
                                        
                                        HTMLElement
                                            createOriginal
                                           (
                                            )

Method to programmatically create an "original" HTMLElement

Returns: HTMLElement: an input field of type "image"

disable

wrapper method for event onDisable

Returns: void

enable

wrapper method for event onEnable

Returns: void

hover

wrapper method for event onMouseOver
sets the "hover" state of the image button

Returns: void

initializeAdv


                                         protected 
                                        
                                        
                                        void
                                            initializeAdv
                                           (
                                            )

wraps the decorator around the original element cretaes a regual expression with the given statePrefix to set/clear the different states

Returns: void

press

wrapper method for event onPress
sets the "pressed" state of the image button

Returns: void

release

wrapper method for event onRelease
clears the "pressed" state of the image button

Returns: void

removeFocus


                                         protected 
                                        
                                        
                                        void
                                            removeFocus
                                           (
                                            )

wrapper method for event onBlur
clears the "focus" state of the image button

Returns: void

setFocus

wrapper method for event onFocus
sets the "focus" state of the image button

Returns: void

unhover

wrapper method for event onMouseOut
clears the "hover" state of the image button

Returns: void

Methods inherited from cfe.generic:


                                                                                    
                                            build,
                                            
                                                                                    
                                            buildWrapper,
                                            
                                                                                    
                                            clicked,
                                            
                                                                                    
                                            createOriginal,
                                            
                                                                                    
                                            disable,
                                            
                                                                                    
                                            enable,
                                            
                                                                                    
                                            getLabel,
                                            
                                                                                    
                                            hideOriginal,
                                            
                                                                                    
                                            initialize,
                                            
                                                                                    
                                            initializeAdv,
                                            
                                                                                    
                                            isDisabled,
                                            
                                                                                    
                                            onMouseOver,
                                            
                                                                                    
                                            press,
                                            
                                                                                    
                                            release,
                                            
                                                                                    
                                            removeFocus,
                                            
                                                                                    
                                            setFocus,
                                            
                                                                                    
                                            setupOriginal,
                                            
                                                                                    
                                            setupWrapper,
                                            
                                                                                    
                                            toElement,
                                            
                                                                                    
                                            toElements,
                                            
                                                                                    
                                            unhover,
                                            
                                                                                    
                                            update

Events inherited from cfe.generic:


                                        
                                        onBlur,
                                        
                                                                            
                                        onClick,
                                        
                                                                            
                                        onDisable,
                                        
                                                                            
                                        onEnable,
                                        
                                                                            
                                        onFocus,
                                        
                                                                            
                                        onMouseOut,
                                        
                                                                            
                                        onMouseOver,
                                        
                                                                            
                                        onPress,
                                        
                                                                            
                                        onRelease,
                                        
                                                                            
                                        onUpdate,

Configuration (Option Attributes)

the prefix which will get appended to the name of the image, just before the state suffix
e.g. if the name of the image is 'cfeSubmit.gif' the resulting name of the hovered state will be cfeSubmit-cfeState-H.gif (when using default value)

Default Value: -cfeState-

Configuration attributes inherited from cfe.generic:

Custom Form Elements for mootools

button

Class cfe.module.image extends cfe.generic

Constructor

Properties

selector - `string`

type - `string`

Properties inherited from cfe.generic:

Methods

clearState

createOriginal

disable

enable

hover

initializeAdv

press

release

removeFocus

setFocus

setState

unhover

Methods inherited from cfe.generic:

Events inherited from cfe.generic:

Configuration (Option Attributes)

statePrefix `- string`

Configuration attributes inherited from cfe.generic:

Properties

Methods

Configuration (Option Attributes)

Modules

Classes

Files

button

Class cfe.module.image extends cfe.generic

Constructor

Properties

selector - string

type - string

Properties inherited from cfe.generic:

Methods

Methods inherited from cfe.generic:

Events inherited from cfe.generic:

Configuration (Option Attributes)

statePrefix - string

Configuration attributes inherited from cfe.generic:

Properties

Methods

Configuration (Option Attributes)

Modules

Classes

Files

selector - `string`

type - `string`

statePrefix `- string`