Alpha Framework alpha--view--widgets
[ class tree: alpha--view--widgets ] [ index: alpha--view--widgets ] [ all elements ]

Class: DateBox

Source Location: /view/widgets/DateBox.inc

Class DateBox

Class Overview

A HTML widget for rendering a text box with calendar icon for Date/Timestamp types

Located in /view/widgets/DateBox.inc [line 50]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: DateBox.inc 1453 2011-12-04 15:12:54Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Since:  1.0
License:  The BSD License

Properties

Methods

[ Top ]
Property Summary
Date/Timestamp   $dateObject   The date or timestamp object for the widget.
string   $label   The data label for the object
string   $name   The name of the HTML input box

[ Top ]
Method Summary
DateBox   __construct()   The constructor
string   render()   Renders the text box and icon to open the calendar pop-up

[ Top ]
Properties
Date/Timestamp   $dateObject = null [line 57]

The date or timestamp object for the widget.

Information Tags:
Since:  1.0

[ Top ]
string   $label [line 65]

The data label for the object

Information Tags:
Since:  1.0

[ Top ]
string   $name [line 73]

The name of the HTML input box

Information Tags:
Since:  1.0

[ Top ]
Methods
Constructor __construct  [line 84]

  DateBox __construct( Date/Timestamp $object, [string $label = ""], [string $name = ""]  )

The constructor

Parameters:
Date/Timestamp   $object:  The date or timestamp object that will be edited by this widget.
string   $label:  The data label for the object.
string   $name:  The name of the HTML input box.

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
render  [line 104]

  string render( [boolean $tableTags = true]  )

Renders the text box and icon to open the calendar pop-up

Parameters:
boolean   $tableTags: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:26:38 +0000 by phpDocumentor 1.4.3