KoolAutoComplete Class [PHP]

alignTop

string align

Get or set the alignment of option panel in autocomplete

Default value : "right"

Allowed values :

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

Show/Hide Code

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

Supported from version: 1.0.0.0

attachToTop

string attachTo

Get or set the id of textbox that KoolAutoComplete attaches to

Default value : "down"

Allowed values :

• "down" : Combobox open option panel at bottom.
• "up" : Combobox open option panel at top.

Show/Hide Code

<?php
	$kac->attachTo="txtTextbox";//Attach autocomplete to "txtTextbox" 
?>

Supported from version: 1.0.0.0

boxHeightTop

string boxHeight

Get or set the height of option panel in autocomplete

Show/Hide Code

<?php
	$kac->boxHeight="200px";
	//Set the fixed height for option panel 
	$kac->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 autocomplete

Show/Hide Code

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

Supported from version: 1.0.0.0

delayTimeTop

int delayTime

Get or set the number of millisecond autocomplete will wait before bringing out suggestion

Show/Hide Code

<?php
	$kac->delayTime = 1000;
	//Set delay to 1 second 
?>

Supported from version: 1.0.0.0

effectTop

string effect

Get or set the open effect of autocomplete'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
	$kac->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
	$kac->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
	$kac->headerTemplate="This is the header"; 
?>

Supported from version: 1.0.0.0

idTop

string id

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

Show/Hide Code

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

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 
	$kac->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 autocomplete

Show/Hide Code

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

Supported from version: 1.0.0.0

minBoxHeightTop

string minBoxHeight

Get or set the min height of option panel in autocomplete

Show/Hide Code

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

Supported from version: 1.0.0.0

openDirectionTop

string openDirection

Get or set open direction of autocomplete

Default value : down

Allowed values :

• down : AutoComplete open option panel at bottom.
• up : AutoComplete 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

searchFilterTop

string searchFilter

Get or set the searching method of autocomplete.

Default value : "startwith"

Allowed values :

• "startwith" : The autocomplete will look for option text that starts same characters with typed text.
• "contain" : The autocomplete will look for option text that contains the typed text.

Show/Hide Code

<?php
	$kac->searchFilter="contain";//Use the contain filter 
?>

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"); 
	$kac->serviceFunction="getdata";
	//Set reference to service-function 
?>

Supported from version: 1.0.0.0

servicePageTop

string servicePage

Get or set the url that autocomplete will post the typed text to get appropriate item list

Show/Hide Code

<?php
	$kac->servicePage="myservicepage.php"; 
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for autocomplete

Show/Hide Code

<?php 
	$kac->styleFolder="koolautocomplete/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
	$kac->superAbove=false;//Do not use "shim" technique 
?>

Supported from version: 1.0.0.0

addItemTop

KoolAutoCompleteItem addItem(string  $text, [array  $data])

Add item to option list of autocomplete

Show/Hide Code

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

Supported from version: 1.0.0.0

LoadXMLTop

function  LoadXML(string xml)

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

Show/Hide Code

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

Supported from version: 1.2.0.0

RenderTop

void Render()

Render the KoolAutoComplete

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for autocomplete.

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for autocomplete

Show/Hide Code

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

Supported from version: 1.0.0.0

RenderAutoCompleteTop

string RenderAutoComplete()

Return html content of KoolAutoComplete body

Show/Hide Code

<body>
    <?php echo $kac->RenderAutoComplete();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate autocomplete

Show/Hide Code

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

Supported from version: 1.0.0.0