Inherits StringFieldRenderer.

Public Member Functions
	ProgressiveSearchFieldRenderer (&$parent, $field, $label="", $handler)

	allowBrowse ($text="", $css="")

	renderScript ($field)

Public Attributes
	$handler = ""
	path to the action handler that retrieves and displays results More...

	$minimumLength = 4
	minimum number of characters user must enter before search is called More...

	$cssClass = "scrollbox"
	class for the progressive search results More...

	$scrollBoxWidth = "300px"
	width of progressive search results More...

	$size = 20
	size of the input field for entering search string More...

	$browse = false

	$browseLabel = "Browse"

	$browseCss = "button"

Detailed Description

Definition at line 42 of file progressive_search_field_renderer.inc.

Member Function Documentation

◆ allowBrowse()

ProgressiveSearchFieldRenderer::allowBrowse	(	$text = `""`,
		$css = `""`
	)

Definition at line 80 of file progressive_search_field_renderer.inc.

      {
           $this->browse = true;
           if ($text) $this->browseText = jsSafe($text);
           if ($css) $this->browseCss = jsSafe($css);
           return $this;
      }

◆ ProgressiveSearchFieldRenderer()

ProgressiveSearchFieldRenderer::ProgressiveSearchFieldRenderer	(	&	$parent,
			$field,
			$label = `""`,
			$handler
	)

Parameters

$parent
$field
$label
$handler	- the path to the action handler that retrieves the results and displays them in the scrollbox (e.g., '/action/task/task_search_handler'

Definition at line 63 of file progressive_search_field_renderer.inc.

      {
           $this->FieldRenderer($parent);
           if ($field && !$parent->data->hasField($field))
           {
                $parent->add($this, $field);
                $parent->overrides[$field]['label'] = $label;
           }
           else if($label)
           {
                $parent->override($field, $label, $this);    
           }
           
           $this->handler = $handler;
           $this->autocomplete = false;
      }

◆ renderScript()

ProgressiveSearchFieldRenderer::renderScript ( $field )

Definition at line 88 of file progressive_search_field_renderer.inc.

      {    
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field)
                || array_key_exists($field, $this->parent->hidden)) return "";
           
           $browse = $this->browse ? "true": "false";
           
           $searchOptions = "{'search': '{$this->handler}', minimumLength: {$this->minimumLength}, 'cssClass': '{$this->cssClass}', 'width': '{$this->scrollBoxWidth}', 'parameter': '{$field}', 'browse': {$browse}, 'browseText': '{$this->browseText}', 'browseCssClass': '{$this->browseCss}'}";
           
           echo "<script type='text/javascript'>\n";
           echo "var {$field}_progressiveSearch;\n";
           echo "window.addEvent('domready', function()\n";
           echo "{\n";
           echo "\t{$field}_progressiveSearch = new ProgressiveSearch('{$this->parent->id}_{$field}', {$searchOptions});\n";
           echo "});\n";
           echo "</script>\n";
      }