KoolMenu Class [PHP]

	Properties	Description
	ClickToOpen	Get or set whether KoolMenu require user to click to open.
	CollapseAnimation	Get or set the settings of collapse animation.
	CollapseDelay	Get or set delay time before menu start to collapse.
	ExpandAnimation	Get or set the settings of expand animation.
	ExpandDelay	Get or set delay time before menu start to expand.
	ExpandDirection	Get or set expand direction of menu.
	Flow	Get or set the flow direction of menu.
	GroupSettings_ExpandDirection	Get or set common expand direction of menu.
	GroupSettings_Flow	Get or set the common flow direction of menu.
	GroupSettings_Height	Get or set common height for child menu panel.
	GroupSettings_OffsetX	Get or set the common offset left of child menu's panel.
	GroupSettings_OffsetY	Get or set the common offset top of child menu's panel.
	GroupSettings_Width	Get or set common width for child menu panel.
	Height	Get or set the height of KoolMenu.
	id	Get or set id of KoolMenu
	PostBackOnSelect	Get or set whether KoolMenu will postback on user's selection.
	scriptFolder	Get or set the path to folder which contains KoolMenu script.
	SelectedId	Get the id of selected menu item.
	styleFolder	Get or set folder which contain css style for KoolMenu
	Target	Get or set the common target for links of menu items.
	Width	Get or set the width of KoolMenu.

	Methods	Description
	Add	Add menu item.
	AddSeparator	Add a separator to a menuitem.
	GetItem	Get the menu item object.
	Render	Render the KoolMenu
	RegisterScript	Return html to register js library for KoolMenu.
	RegisterCSS	Return html to register CSS for KoolMenu
	RenderMenu	Return html content of KoolMenu body
	StartupScript	Return js code to inititate KoolMenu

ClickToOpenTop

bool ClickToOpen

Get or set whether KoolMenu require user to click to open.

Default value : false

Show/Hide Code

<?php
...
	$km->ClickToOpen=true;
...
?>

Supported from version: 1.0.0.0

CollapseAnimationTop

Animation CollapseAnimation

Get or set the settings of collapse animation.

Show/Hide Code

<?php
...
	$km->CollapseAnimation->Type="Linear";// Linear animation.
	$km->CollapseAnimation->Duration=200;// 200ms
...
?>

Supported from version: 1.0.0.0

CollapseDelayTop

int CollapseDelay

Get or set delay time before menu start to collapse.

Default value : 200

Show/Hide Code

<?php
...
	$km->CollapseDelay=500;
...
?>

Supported from version: 1.0.0.0

ExpandAnimationTop

Animation ExpandAnimation

Get or set the settings of expand animation.

Show/Hide Code

<?php
...
	$km->ExpandAnimation->Type="Linear";// Linear animation.
	$km->ExpandAnimation->Duration=200;// 200ms
...
?>

Supported from version: 1.0.0.0

ExpandDelayTop

int ExpandDelay

Get or set delay time before menu start to expand.

Default value : 200

Show/Hide Code

<?php
...
	$km->ExpandDelay=500;
...
?>

Supported from version: 1.0.0.0

ExpandDirectionTop

string ExpandDirection

Get or set expand direction of menu.

Default value : "Auto"

Allowed values :

"Auto" : Auto expansion.
"Left" : Left expansion.
"Right" : Right expansion.
"Up" : Up expansion.
"Down" : Down expansion.

Show/Hide Code

<?php
...
	$km->ExpandDirection="Up";
...
?>

Supported from version: 1.0.0.0

FlowTop

string Flow

Get or set the flow direction of menu.

Allowed values :

"Horizontal" : Flow horizontally.
"Vertical" : Flow vertically.

Show/Hide Code

<?php
...
	$km->Flow="Vertical";
...
?>

Supported from version: 1.0.0.0

GroupSettings_ExpandDirectionTop

string GroupSettings_ExpandDirection

Get or set common expand direction of menu.

Default value : "Auto"

Allowed values :

"Auto" : Auto expansion.
"Left" : Left expansion.
"Right" : Right expansion.
"Up" : Up expansion.
"Down" : Down expansion.

Show/Hide Code

<?php
...
	$km->GroupSettings_ExpandDirection="Up";
...
?>

Supported from version: 1.0.0.0

GroupSettings_FlowTop

string GroupSettings_Flow

Get or set the common flow direction of menu.

Allowed values :

"Horizontal" : Flow horizontally.
"Vertical" : Flow vertically.

Show/Hide Code

<?php
...
	$km->GroupSettings_Flow="Vertical";
...
?>

Supported from version: 1.0.0.0

GroupSettings_HeightTop

string GroupSettings_Height

Get or set common height for child menu panel.

Show/Hide Code

<?php
...
	$km->GroupSettings_Height="300px";
...
?>

Supported from version: 1.0.0.0

GroupSettings_OffsetXTop

int GroupSettings_OffsetX

Get or set the common offset left of child menu's panel.

Default value : 0

Show/Hide Code

<?php
...
	$km->GroupSettings_OffsetX=20; // 20px
...
?>

Supported from version: 1.0.0.0

GroupSettings_OffsetYTop

int GroupSettings_OffsetY

Get or set the common offset top of child menu's panel.

Default value : 0

Show/Hide Code

<?php
...
	$km->GroupSettings_OffsetY=20; // 20px
...
?>

Supported from version: 1.0.0.0

GroupSettings_WidthTop

string GroupSettings_Width

Get or set common width for child menu panel.

Show/Hide Code

<?php
...
	$km->GroupSettings_Width="300px";
...
?>

Supported from version: 1.0.0.0

HeightTop

string Height

Get or set the height of KoolMenu.

Show/Hide Code

<?php
...
	$km->Height="300px";
...
?>

Supported from version: 1.0.0.0

idTop

string id

Get or set the id for KoolMenu. This id will be use as variable name of KoolMenu at client-side.

Show/Hide Code

<?php		
	$km->id="km";//We usuall use the same id name with server-side for better reference. 
?>

Supported from version: 1.0.0.0

PostBackOnSelectTop

bool PostBackOnSelect

Get or set whether KoolMenu will postback on user's selection.

Default value : false

Show/Hide Code

<?php
...
	$km->PostBackOnSelect=true;
...
?>

Supported from version: 1.0.0.0

scriptFolderTop

string scriptFolder

Get or set the path to folder which contains KoolMenu script.

Show/Hide Code

<?php				
	$km = new KoolMenu("km");
	$km->scriptFolder = "KoolControls/KoolMenu";
?>

Supported from version: 1.0.0.0

SelectedIdTop

string SelectedId

Get the id of selected menu item.

Show/Hide Code

<?php
...
	if($km->SelectedId!=null)
	{
		echo $km->SelectedId;
	}
...
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for KoolMenu

Show/Hide Code

<?php 
	$km->styleFolder="KoolControls/KoolMenu/styles/default";//Use the "default" style 
?>

Supported from version: 1.0.0.0

TargetTop

string Target

Get or set the common target for links of menu items. The target would be "_blank" or any frame name that you create on your page.

Show/Hide Code

<?php
...
	$km->Target="my_sub_frame"; 
...
?>

Supported from version: 1.0.0.0

WidthTop

string Width

Get or set the width of KoolMenu.

Show/Hide Code

<?php
...
	$km->Width="300px";
...
?>

Supported from version: 1.0.0.0

AddTop

KoolMenuItem Add(string $parentid, string $id, string $text, [string $link], [bool $image_url])

Add menu item. Note: The "root" is pre-built parent node id.

Show/Hide Code

<?php
...
	$km->Add("root","my_first_node","My First Node","first.php","node.gif");
...
?>

Supported from version: 1.0.0.0

AddSeparatorTop

AddSeparator(string $parentid)

Add a separator to a menuitem.

Show/Hide Code

<?php
...
	$km->AddSeparator("open"); // Add a seperator to the "open" menu item.
...
?>

Supported from version: 1.0.0.0

GetItemTop

KoolMenuItem GetItem(string $id)

Get the menu item object.

Show/Hide Code

<?php
	$_intro = $km->GetItem("intro");
	$_intro->Link = "intro.php";
?>

Supported from version: 1.0.0.0

RenderTop

void Render()

Render the KoolMenu

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolMenu.

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolMenu

Show/Hide Code

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

Supported from version: 1.0.0.0

RenderMenuTop

string RenderMenu()

Return html content of KoolMenu body

Show/Hide Code

<body>
    <?php echo $km->RenderMenu();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate KoolMenu

Show/Hide Code

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

Supported from version: 1.0.0.0

KoolMenu Class [PHP]

Summary

Properties Detail

Methods Detail