KoolUIControl

KoolTreeGrid Properties [PHP]

	Methods	Description
	Constructor	Create a KoolUI object.
	newUI	Public static method to create a new KoolUI object.
	getSetting	Return the setting array of a KoolUI object.
	set	Add setting to a KoolUI object.
	process	Let KoolUI process its setting before rendering.
	render	Render KoolUI javascript functions and html output.
	getBasedHtml	Return the html string based on which KoolUI would be built.
	getStartupJS	Return the javascript function name that would build KoolUI.

ConstructorTop

KoolUI Constructor()

Create a KoolUI object.

<?php	               
    $ui = new KoolUI();
?>

Supported from version: 1.0.0.0

newUITop

KoolUI newUI(array $setting)

Public static method to create a new KoolUI object.

<?php	               
    $info = array(
        'KoolUIPath' => $KoolUIPath,
        'width' => '300px',
        'height' => '100px',
        'templateSelector' => 'KBarcode t0',
        'showChecksum' => true,
    );
    $ui = KoolUI::newUI($info);
?>

Supported from version: 1.0.0.0

getSettingTop

array getSetting()

Return the setting array of a KoolUI object.

<?php
    $s = $ui->getSetting();
?>

Supported from version: 1.0.0.0

setTop

void set(array $setting)

Add setting to a KoolUI object.

<?php	               
    $info = array(
        'KoolUIPath' => $KoolUIPath,
        'width' => '300px',
        'height' => '100px',
        'templateSelector' => 'KBarcode t0',
        'showChecksum' => true,
    );
    $ui = KoolUI::newUI($info);
    $setting = array(
        'type' => 'ean8',
        'value' => '9638507',
    ),
    $ui->set($setting);
?>

Supported from version: 1.0.0.0

processTop

void process()

Let KoolUI process its setting before rendering.

<?php
    $ui->process();
?>

Supported from version: 1.0.0.0

renderTop

void render()

Render KoolUI javascript functions and html output.

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

Supported from version: 1.0.0.0

getBasedHtmlTop

String getBasedHtml()

Return the html string element based on which KoolUI would be built.

<body>
    <?php 
        $html = $ui->getBasedHtml();
    ?>
</body>

Supported from version: 1.0.0.0

getStartupJSTop

String getStartupJS()

Return the javascript function name that would build KoolUI. Based html must be rendered before this javascript function could be called.

<body>
    <?php 
        $html = $ui->getBasedHtml();
        echo $html;
        $startupJS = $ui->getStartupJS();
        echo "<script type='text/javascript'> window[ '" . $startupJS . "' ](); </script>"; 
    ?>
</body>

Supported from version: 1.0.0.0