# Class RecordSelector

Record selection HTML widget.

Package: alpha::view::widgets
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: RecordSelector.inc 1548 2012-07-29 17:07:07Z alphadevx $
Since: 1.0
Located at view/widgets/RecordSelector.inc

Methods summary
`public` | # `__construct( `Relation` $relation, string $label = '', string $name = '', string $accessingClassName = '' )` The constructor. The constructor. #### Parameters $relation ``Relation`` $relation $label `string` $label $name `string` $name $accessingClassName `string` $accessingClassName #### Throws ``IllegalArguementException`` #### Since 1.0
`public string` | # `render( boolean $tableTags = true, boolean $expanded = false, boolean $buttons = true )` Renders the text boxes and buttons for the widget, that will appear in user forms. Renders the text boxes and buttons for the widget, that will appear in user forms. #### Parameters $tableTags `boolean` $tableTags Include table tags and label (optional) $expanded `boolean` $expanded Render the related fields in expanded format or not (optional) $buttons `boolean` $buttons Render buttons for expanding/contacting the related fields (optional) #### Returns `string` #### Since 1.0
`public string` | # `renderSelector( array $lookupOIDs = array() )` Returns the HTML for the record selector that will appear in a pop-up window. Returns the HTML for the record selector that will appear in a pop-up window. #### Parameters $lookupOIDs `array` $lookupOIDs An optional array of related look-up OIDs, only required for rendering MANY-TO-MANY rels #### Returns `string` #### Since 1.0
`private string` | # `displayPageHead( )` Renders the header HTML and JS for the record selector pop-up page. Renders the header HTML and JS for the record selector pop-up page. #### Returns `string` #### Since 1.0
`private string` | # `displayPageFoot( )` Renders the footer HTML and JS for the record selector pop-up page. Renders the footer HTML and JS for the record selector pop-up page. #### Returns `string` #### Since 1.0

Properties summary
`private `Relation`` | $relationObject | `null` | # The relation object that we are going to render a view for. The relation object that we are going to render a view for. #### Since 1.0
`private string` | $label | `` | # The label text to use where required. The label text to use where required. #### Since 1.0
`private string` | $accessingClassName | `` | # Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types). Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types). #### Since 1.0
`private string` | $onloadJS | `''` | # Javascript to run when the widget opens in a new window. Javascript to run when the widget opens in a new window. #### Since 1.0
`private string` | $name | `` | # The name of the HTML input box for storing the hidden and display values. The name of the HTML input box for storing the hidden and display values. #### Since 1.0
`private static `Logger`` | $logger | `null` | # Trace logger Trace logger #### Since 1.0