Home
Documentation
Downloads
Wiki
About

MenuLayout Class

Show Source
Layout initially intended for mobile applications. Contains a header, body, and menu panel. The header includes a menu icon which is used to slide open/close a menu panel.

Constructors

MenuLayout( parent, config )
Show Source
Used to instantiate this class
parentDOM element in which to render this component
configConfiguration settings (optional). See config options for more information.

Config Options

animationSteps
Time to slide open the menu panel, in milliseconds.
Show Source
transitionEffect
Transition effect. A "linear" transition is applied by default. Additional options are available if an instance of a javaxt.dhtml.Effects class is provided in the "fx" config. See the javaxt.dhtml.Effects class for complete a list of options.
Show Source
fx
An instance of a javaxt.dhtml.Effects class used to animate transitions.
Show Source
menuWidth
Width of the menu panel, in pixels.
Show Source
menuPosition
Used to set which side to use for the menu panel and corresponding icon. Options are "left" or "right".
Show Source
title
Text or DOM object to appear in the header area.
Show Source
style
Style for individual elements within this component. Note that you can provide CSS class names instead of individual style definitions.
Show Source

Events

onShow( )
Called whenever the menu is made visible
Show Source
onHide( )
Called whenever the menu is hidden
Show Source
beforeShow( )
Called immediately before the menu is made visible
Show Source
beforeHide( )
Called immediately before the menu is hidden
Show Source
onResize( )
Function called whenever this component is resized
Show Source

Public Methods

getMenuIcon( )
Returns the DOM element used to render the menu icon.
Show Source
setTitle( obj )
Used to update the contents of the header area
objText or DOM object to appear in the header area
Show Source
getTitle( )
Returns the title (e.g. string or DOM object). See setTitle()
Show Source
isMenuVisible( )
Returns true if the menu is visible
Show Source
showMenu( )
Used to slide open the menu, if it is hidden from view
Show Source
hideMenu( )
Used to hide the menu, if it is visible
Show Source
resize( )
Used to update the layout of this component
Show Source
getMenu( )
Returns the menu panel
Show Source
getBody( )
Returns the body panel
Show Source
Copyright © 2024, Peter Borissow