KoolTimeView Class [PHP]

	Properties	Description
	ClientEvents	Get or set the client-side event handle.
	EndTime	Get or set the end time.
	HeaderText	Get or set the header text of TimeView.
	id	Get or set id of KoolTimeView
	Interval	Get or set the time interval.
	NumberOfColumns	Get or set number of columns for TimeView.
	Orientation	Get or set the rendering orientation of month.
	scriptFolder	Get or set the path to folder which contains KoolCalendar script.
	StartTime	Get or set the start time.
	styleFolder	Get or set folder which contain css style for KoolTimeView
	TimeFormat	Get or set the time format.

	Methods	Description
	Init	Initiate datetime picker.
	Render	Render the KoolTimeView
	RegisterScript	Return html to register js library for KoolTimeView.
	RegisterCSS	Return html to register CSS for KoolTimeView
	RenderCalendar	Return html content of KoolTimeView body
	StartupScript	Return js code to inititate KoolTimeView.

ClientEventsTop

array ClientEvents

Get or set the client-side event handle.

Show/Hide Code

<?php
...
	$timeview->ClientEvents["OnSelect"]="Handle_OnSelect";
...
?>
 
<script type="text/javascript">
function Handle_OnSelect(sender,arg)
{
	alert(arg["Time"]);
}
</script>

Supported from version: 1.0.0.0

EndTimeTop

int EndTime

Get or set the end time.

Show/Hide Code

<?php
...
	$timeview->StartTime=mktime(1,0,0); // Start at 00:00
	$timeview->EndTime=mktime(10,0,0); // End at 10:00
	$timeview->Interval=mktime(2,0,0); // Every 2 hours.		
...
?>

Supported from version: 1.0.0.0

HeaderTextTop

string HeaderText

Get or set the header text of TimeView.

Show/Hide Code

<?php
...
	$timeview->HeaderText = "Time View";
...
?>

Supported from version: 1.0.0.0

idTop

string id

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

Show/Hide Code

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

Supported from version: 1.0.0.0

IntervalTop

int Interval

Get or set the time interval.

Show/Hide Code

<?php
...
	$timeview->StartTime=mktime(1,0,0); // Start at 00:00
	$timeview->StartTime=mktime(10,0,0); // Start at 10:00
	$timeview->Interval=mktime(2,0,0); // Every 2 hours.		
...
?>

Supported from version: 1.0.0.0

NumberOfColumnsTop

int NumberOfColumns

Get or set number of columns for TimeView.

Default value : 4

Show/Hide Code

<?php
...
	$timeview->NumberOfColumns=5;
...
?>

Supported from version: 1.0.0.0

OrientationTop

string Orientation

Get or set the rendering orientation of month.

Allowed values :

"Horizontal" : Render month days horizontally.
"Vertical" : Render month days vertically.

Show/Hide Code

<?php
...
	$timeview->Orientation="Vertical";
...
?>

Supported from version: 1.0.0.0

scriptFolderTop

string scriptFolder

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

Show/Hide Code

<?php				
	$timeview = new KoolTimeView("timepicker");
	$timeview->scriptFolder = "KoolControls/KoolCalendar";
?>

Supported from version: 1.0.0.0

StartTimeTop

int StartTime

Get or set the start time.

Show/Hide Code

<?php
...
	$timeview->StartTime=mktime(1,0,0); // Start at 00:00
	$timeview->EndTime=mktime(10,0,0); // End at 10:00
	$timeview->Interval=mktime(2,0,0); // Every 2 hours.		
...
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for KoolTimeView

Show/Hide Code

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

Supported from version: 1.0.0.0

TimeFormatTop

string TimeFormat

Get or set the time format.

Default value : "g:i A"

Show/Hide Code

<?php
...
	$timeview->TimeFormat="g:i A";
...
?>

Supported from version: 1.0.0.0

InitTop

void Init()

Initiate datetime picker. This function should be called before datetime picker's Render() function.

Show/Hide Code

<?php
	$timeview = new KoolTimeView("cal");
	...
	$timeview->Init();
	...
	echo $timeview->Render(); 
?>

Supported from version: 1.0.0.0

RenderTop

void Render()

Render the KoolTimeView

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolTimeView.

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolTimeView

Show/Hide Code

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

Supported from version: 1.0.0.0

RenderCalendarTop

string RenderCalendar()

Return html content of KoolTimeView body

Show/Hide Code

<body>
    <?php echo $timeview->RenderDateTimePicker();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate KoolTimeView.

Show/Hide Code

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

Supported from version: 1.0.0.0

KoolTimeView Class [PHP]

Summary

Properties Detail

Methods Detail