Graphical Menu Manager  1.6.0

BLOBkit Javascript Library > menu > TVB.menu
Search:
 
Filters

Class TVB.menu

Constructor for the Menu Widget

Constructor

TVB.menu ( config )
Parameters:
config <Object> Configuration object, see user manual for specifications

Methods

changeElementNumber

void changeElementNumber ( newElementNumber )
Changes the number of elements and redraw current page
Parameters:
newElementNumber <Integer>
Returns: void

deactivate

void deactivate ( )
Deactivate the remote and other important stuffs for the menu
Returns: void

get

Object get ( )
Returns current menu div, it is usefult for appending to a DOM element
Returns: Object
the child

getCurrentLine

Integer getCurrentLine ( )
Returns current element
Returns: Integer

getCurrentPage

Integer getCurrentPage ( )
Returns current page number (starting from 0)
Returns: Integer

getTotalPages

Integer getTotalPages ( )
Returns the number of pages
Returns: Integer

updateLine

Boolean updateLine ( lineNumber )
Update a line if it is visible or prefetched
Parameters:
lineNumber <Integer>
Returns: Boolean

Configuration Attributes

disableChannelDown - Boolean

Default Value: false

disableChannelUp - Boolean

Default Value: false

disableLeftRight - Boolean

Default Value: false

disableOk - Boolean

Default Value: false

disableUpDown - Boolean

Default Value: false

drawSingleLineCB - Function


menuName - String


menuType - String

Default Value: paged

numElements - Integer


onBlurCB - Function


onFocusCB - Function


onRemoteUpdateCB - Function

This callback is called when the menu reaches the very first element or the last one. It should do anything the programmer wants to do, like loading more data or updating the menu. It must return false if the update fail.

onSelectCB - Function


onUpdateCB - Function


updateMode - String

Default Value: redraw

visibleElements - Integer

Default Value: 4


Copyright © 2010 TVBLOB S.r.l. All rights reserved. The BLOBkit library is a resource ofBLOBforge.