KoolSlideMenu

KoolSlideMenu Class [PHP]

	Properties	Description
	boxHeight	Get or set the fixed height of slidemenu's childboxes
	scrollEnable	Get or set whether scrollbar is displayed when needed.
	selectedId	Get or set selected child of slidemenu.
	selectEnable	Get or set whether slidemenu allow selection
	singleExpand	Get or set whether slidemenu keeps single node expand
	slidingSpeed	Get or set the sliding speed of slidemenu.
	styleFolder	Get or set folder which contain css style for slidemenu.
	width	Get or set the width for slidemenu

	Methods	Description
	addParent	Create another parent and add it to a existed slidemenu parent.
	addChild	Create a child and add it to a slidemenu parent.
	addPanel	Create a panel and add it to a slidemenu parent.
	loadXML	Build slidemenu from xml string.
	getItem	Get the menu item object.
	Render	Render the Slidememu
	RegisterScript	Return html to register js library for autocomplete.
	RegisterCSS	Return html to register CSS for autocomplete
	RenderSlideMenu	Return html content of KoolSlideMenu body
	StartupScript	Return js code to inititate autocomplete

boxHeightTop

int boxHeight

Get or set the fixed height of slidemenu's childboxes

<?php
	$ksm->boxHeight=100;//Set height for childbox
?>

Supported from version: 1.0.0.0

scrollEnableTop

bool scrollEnable

Get or set whether scrollbar is displayed when needed.

<?php
	$ksm->scrollEnable=true;// Enable scrolling
?>

Supported from version: 1.0.0.0

selectedIdTop

string selectedId

Get or set selected child of slidemenu.

<?php
	$ksm->selectedId="child1";
	//Make child1 selected 
?>

Supported from version: 1.0.0.0

selectEnableTop

bool selectEnable

Get or set whether slidemenu allow selection

<?php
	$ksm->selectEnable=false;
	//Disable select node feature 
?>

Supported from version: 1.0.0.0

singleExpandTop

bool singleExpand

Get or set whether slidemenu keeps single node expand

<?php
	$ksm->singleExpand=true;
	//Keep only one node expand 
?>

Supported from version: 1.0.0.0

slidingSpeedTop

slidingSpeed

Get or set the sliding speed of slidemenu. This is the number of pixel that slidemenu move in a 15ms time frame.

<?php
	$ksm->slidingSpeed=10;//Set speed of sliding for SlideMenu 
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for slidemenu.

<?php
...
	$ksm->styleFolder="koolslidemenu/styles/default";//Use the "default" style
...
?>

Supported from version: 1.0.0.0

widthTop

string width

Get or set the width for slidemenu

<?php
 
	$ksm->width="100px";//Specify width by pixels
	$ksm->width="100%";//Specify width by percent 
?>

Supported from version: 1.0.0.0

addParentTop

SlideMenuParent addParent(string $parentid, string $id, string $text, [string $link], [bool $expand])

Create another parent and add it to a existed slidemenu parent.

<?php
	$ksm->addParent("root","parent1","Parent 1","parent1.php",true);
	//Add parent to the root node. The parent has text="Parent 1" and link to "parent1.php" page 
	//The parent expands at his initial state 
?>

Supported from version: 1.0.0.0

addChildTop

SlideMenuChild addChild(string $parentid, string $id, string $text, [string $link])

Create a child and add it to a slidemenu parent.

<?php
    //Add a chil to a parent. The child has text="The Child" and link to "childpage.php" page 
    $ksm->addChild("parent","child","The Child","childpage.php");	
?>

Supported from version: 1.0.0.0

addPanelTop

SlideMenuPanel addPanel(string $parentid, string $id, string $text)

Create a panel and add it to a slidemenu parent.

<?php
     //Add a panel to a parent. The panel can contain any html content. 
    $ksm->addPanel("parent","panel","Any html content");
?>

Supported from version: 1.0.0.0

loadXMLTop

void loadXML(string $xml)

Build slidemenu from xml string.

<?php
	$xmlDoc = new DOMDocument();
	$xmlDoc->load("SlideMenu.xml");	
	$ksm = new KoolSlideMenu("ksm");
	$ksm->loadXML($xmlDoc->saveXML());
	echo $ksm->Render();
?>

Supported from version: 1.0.0.0

getItemTop

[SlideMenuParent], [SlideMenuChild], [SlideMenuPanel] getItem(string $id)

Get the menu item object. The return object can be SlideMenuParant, SlideMenuChild or SlideMenuPanel.

<?php
	$_intro = $ksm->getItem("intro");
	$_intro->link = "intro.php";
?>

Supported from version: 1.0.0.0

RenderTop

string Render()

Render the Slidememu

<body>
    <?php echo $ksm->Render();?>
</body>

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for autocomplete.

<head>
    <?php echo $ksm->RegisterScript();?>
</head>

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for autocomplete

<head>
    <?php echo $ksm->RegisterCSS();?>
</head>

Supported from version: 1.0.0.0

RenderSlideMenuTop

string RenderSlideMenu()

Return html content of KoolSlideMenu body

<body>
    <?php echo $ksm->RenderSlideMenu();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate autocomplete

<script type="text/javascript">
    <?php echo $ksm->StartupScript();?>
</script>

Supported from version: 1.0.0.0