KoolCombobox Class [PHP]

alignTop

string align

Get or set the alignment of option panel in KoolCombobox

Default value : "right"

Allowed values :

• "left" : Align option panel to the left.
• "right" : Align option panel to the right.

Show/Hide Code

<?php
	$kcb->align="left";
	//Align option panel to the left 
?>

Supported from version: 1.0.0.0

boxHeightTop

string boxHeight

Get or set the height of option panel in KoolCombobox

Show/Hide Code

<?php
	$kcb->boxHeight="200px";
	//Set the fixed height for option panel 
	$kcb->boxHeight="auto";
	//The height of option panel will be auto between minBoxHeight and maxBoxHeight 
?>

Supported from version: 1.0.0.0

boxWidthTop

string boxWidth

Get or set the width of option panel in KoolCombobox

Show/Hide Code

<?php
	$kcb->boxWidth="200px";
	//Set the fixed width for option panel 
	$kcb->boxWidth="auto";
	//Width of option panel will be equal to width of KoolCombobox 
?>

Supported from version: 1.0.0.0

effectTop

string effect

Get or set the open effect of KoolCombobox's option panel. Note: More effects will be added in the future.

Allowed values :

• "none" : Combobox open option panel at bottom.

Show/Hide Code

<?php
	$kcb->effect="none";//No effect 
?>

Supported from version: 1.0.0.0

footerTemplateTop

string footerTemplate

Get or set the footer template of option panel

Show/Hide Code

<?php
	$kcb->footerTemplate="This is the footer"; 
?>

Supported from version: 1.0.0.0

headerTemplateTop

string headerTemplate

Get or set the header template of option panel

Show/Hide Code

<?php
	$kcb->headerTemplate="This is the header"; 
?>

Supported from version: 1.0.0.0

idTop

string id

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

Show/Hide Code

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

Supported from version: 1.0.0.0

inputValidateTop

string inputValidate

Get or set whether input inserted to combobox will be validated. If true the selected option must be one of items in option panel.

Default value : true

Show/Hide Code

<?php
	$kcb->inputValidate=true;//Keep only one node expand 
?>

Supported from version: 1.0.0.0

itemTemplateTop

string itemTemplate

Get or set the item template of option panel. The template contains marking to be replaced item's data. For example, {text} will be replaced by the text of each items.

Show/Hide Code

<?php 
	$kcb->itemTemplate="<img src='{image}'/>{text}";
	//Make item appears with an image and text 
?>

Supported from version: 1.0.0.0

maxBoxHeightTop

string maxBoxHeight

Get or set the max height of option panel in KoolCombobox

Show/Hide Code

<?php
	$kcb->maxBoxHeight="50px";
?>

Supported from version: 1.0.0.0

minBoxHeightTop

string minBoxHeight

Get or set the min height of option panel in KoolCombobox

Show/Hide Code

<?php
	$kcb->minBoxHeight="50px";
?>

Supported from version: 1.0.0.0

openDirectionTop

string openDirection

Get or set open direction of combobox

Default value : down

Allowed values :

• down : ComboBox open option panel at bottom.
• up : ComboBox open option panel at top.

Show/Hide Code

<?php
	$kcb->openDirection="up";//Set "up" as direction to open option panel 
?>

Supported from version: 1.0.0.0

serviceFunctionTop

string serviceFunction

Get or set the name of koolajax-enabled function that will be used to update item list from server The service function will will take a text agurment ( this is the text that user keys in at client-side and sent to server-side) and return an array contain item data.

Show/Hide Code

<?php
	function getdata($text)
	{
		$data = array(); 
		array_push($data,array("text"=>"Software","value"=>"software","image"=>"software.gif"));
		array_push($data,array("text"=>"Hardware","value"=>"hardware","image"=>"hardware.gif"));
		return $data; 
	} 
	$koolajax->enableFunction("getdata"); 
	$kcb->serviceFunction="getdata";
	//Set reference to service-function 
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for KoolCombobox

Show/Hide Code

<?php 
	$kcb->styleFolder="KoolCombobox/styles/default";//Use the "default" style 
?>

Supported from version: 1.0.0.0

superAboveTop

bool superAbove

Get or set whether whether "shim" technique is used. This is very useful if your application running in IE6 because it helps option panel to open above all other elements.

Default value : "true"

Show/Hide Code

<?php
	$kcb->superAbove=false;//Do not use "shim" technique 
?>

Supported from version: 1.0.0.0

widthTop

string width

Get or set the width for combobox

Show/Hide Code

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

Supported from version: 1.0.0.0

addItemTop

KoolComboboxItem addItem(string  $text, string  $value, [array  $data], [bool  $select], [bool  $enabled])

Add item to option list of KoolCombobox

Show/Hide Code

<?php
	$kcb->addItem("Software","software",array("image"=>"software.gif"),true,true);
    //The array contain custom data depended on the definition from user
?>

Supported from version: 1.0.0.0

LoadXMLTop

function  LoadXML(string xml)

Create KoolCombobox with XML content. The input value may be string or XmlDocument.

Show/Hide Code

<?php
	$thePanel->LoadXML("<koolcombobox id='thePanel'><items><item text='Software' value='soft'/></items></koolcombobox>");
?>

Supported from version: 1.2.0.0

RenderTop

void Render()

Render the KoolCombobox

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolCombobox.

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolCombobox

Show/Hide Code

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

Supported from version: 1.0.0.0

RenderComboboxTop

string RenderCombobox()

Return html content of KoolCombobox body

Show/Hide Code

<body>
    <?php echo $kcb->RenderCombobox();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate KoolCombobox

Show/Hide Code

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

Supported from version: 1.0.0.0