DocumentSelectFieldRenderer Class Reference

Inherits FieldRenderer.

Public Member Functions
	DocumentSelectFieldRenderer (&$form, $field, $label, $libraryIdentifier)
	writeDocumentList ($field)
	formatDocument ($document)
	formatDocumentLink ($document)
	renderScript ($field)
	renderSearchField ($field, $mode="")
	renderField ($field="")
	renderReadOnly ($field)

Public Attributes
	$library
	$emptyMessage = "No Document Selected"

Detailed Description

Definition at line 10 of file document_select_field_renderer.inc.

Member Function Documentation

DocumentSelectFieldRenderer()

DocumentSelectFieldRenderer::DocumentSelectFieldRenderer	(	&	$form,
			$field,
			$label,
			$libraryIdentifier
	)

Definition at line 15 of file document_select_field_renderer.inc.

     {
          $this->FieldRenderer($form);
          if ($form->data->hasField($field))
          {
               $form->override($field, $label, $this);
          }
          else
          {
               $form->add($this, $field);
               $form->overrides[$field]['label'] = $label;
          }
 
          $this->library = DocumentLibrary::findByIdentifier($libraryIdentifier);
     }

formatDocument()

DocumentSelectFieldRenderer::formatDocument

(

$document

)

Definition at line 43 of file document_select_field_renderer.inc.

     {
          $img = DocumentHandler::getDocIcon($document->file);
          return "<img src='$img' alt='' style='display: inline-block; vertical-align: middle'>&nbsp;{$document->title}";
     }

formatDocumentLink()

DocumentSelectFieldRenderer::formatDocumentLink

(

$document

)

Definition at line 49 of file document_select_field_renderer.inc.

     {
          $library = $document->DocumentLibrary();
          $size = $library->getFileSize($document);
          $img = DocumentHandler::getDocIcon($document->file);
     
          return "<img src='$img' alt='' style='display: inline-block; vertical-align: middle'>&nbsp;".
                  "<a href='/action/document/download?document_id={$document->document_id}'>{$document->title}</a>&nbsp;$size";
     }

renderField()

DocumentSelectFieldRenderer::renderField

(

$field = ""

)

Definition at line 115 of file document_select_field_renderer.inc.

     {
          if (!$field) $field = $this->field;
     
          $this->_startField($field);
     
          $autocomplete = (!$this->autocomplete) ? "autocomplete='off' " : "";
     
          $value = $this->parent->data->get($field);
          $text = "";
          if ($value)
          {
               $document = new Document($value);
               $text = $this->formatDocument($document);
          }
          else
          {
               $text = $this->emptyMessage;
          }
          
          echo "<input id='{$this->parent->id}_{$field}' type='hidden' name='$field' value='".htmlspecialchars($value, ENT_QUOTES, 'UTF-8')."'/>";
          echo "<span id='{$this->parent->id}_{$field}_text' class='document_select_text' onclick='{$this->parent->id}_{$field}_showList(event); return false;'>".$text."</span>";
          echo "&nbsp;<a class='button' href='#' onclick='{$this->parent->id}_{$field}_showList(event); return false;'>Browse</a><br/>";
          echo "<div id='{$this->parent->id}_{$field}_list_popup'  class='progressive_search' style='display: none;position:absolute; max-height: 150px; overflow-y: auto'>";
          $this->writeDocumentList($field);
          echo "</div>";
 
          $this->_endField($field);
     }

renderReadOnly()

DocumentSelectFieldRenderer::renderReadOnly

(

$field

)

Definition at line 145 of file document_select_field_renderer.inc.

     {
          $this->_startField($field);
          
          $value = $this->parent->data->get($field);
          $text = "";
          if ($value)
          {
               $document = new Document($value);
               $text = $this->formatDocumentLink($document);
          }
          else
          {
               $text = $this->emptyMessage;
          }
          
          if ($this->parent->readOnlyForm)
          {
               echo $text;
          }
          else
          {
               echo "<input id='{$this->parent->id}_{$field}' type='hidden' name='$field' value='".htmlspecialchars($value, ENT_QUOTES, 'UTF-8')."'/>";
               echo "<span id='{$this->parent->id}_{$field}_text' class='document_select_text'>".$text."</span>";
          }
          
          $this->_endField($field);
     }

renderScript()

DocumentSelectFieldRenderer::renderScript

(

$field

)

Definition at line 59 of file document_select_field_renderer.inc.

     {
          if ($this->parent->isReadOnly($field)) return;
          
          $script .= <<<ENDSCRIPT
<script type="text/javascript">
function {$this->parent->id}_{$field}_showList(e)
{
     new DOMEvent(e).stop();
     var popup = document.id('{$this->parent->id}_{$field}_list_popup');
     var txt = document.id('{$this->parent->id}_{$field}');
     var coords = txt.getCoordinates();
     popup.setStyles({'display': 'block'});
     var doc = document.id(document.body ? document.body : document.documentElement);
     doc.addEvent('click', {$this->parent->id}_{$field}_hideList);
}
     
function {$this->parent->id}_{$field}_hideList()
{
     var popup = document.id('{$this->parent->id}_{$field}_list_popup');
     popup.setStyles({'display': 'none'});
     var doc = document.id(document.body ? document.body : document.documentElement);
     doc.removeEvent('click', {$this->parent->id}_{$field}_hideList);
}
     
function {$this->parent->id}_{$field}_selectItem(elt, id)
{
     var hidden = document.id('{$this->parent->id}_{$field}');
     
     var txt = document.id('{$this->parent->id}_{$field}_text');
     hidden.set('value', id);
     
     if (id)
     {
          txt.set('html', elt.get('html'));
     }
     
     {$this->parent->id}_{$field}_hideList();
}
     
window.addEvent('domready', function()
{
     var popup = document.id('{$this->parent->id}_{$field}_list_popup');
     popup.addEvent('click', function(e) { new DOMEvent(e).stop(); });
});
</script>
ENDSCRIPT;
     
          echo $script;
     }

renderSearchField()

DocumentSelectFieldRenderer::renderSearchField	(		$field,
			$mode = ""
	)

Definition at line 110 of file document_select_field_renderer.inc.

     {
          $this->renderField($field);
     }

writeDocumentList()

DocumentSelectFieldRenderer::writeDocumentList

(

$field

)

Definition at line 31 of file document_select_field_renderer.inc.

     {
          $documents = $this->library->Documents("ORDER BY title");
          
          foreach($documents as $document)
          {
               echo "<a href='#' onclick='{$this->parent->id}_{$field}_selectItem(this, {$document->document_id}); return false;'>";
               echo $this->formatDocument($document);
               echo "</a>";
          }
     }

Member Data Documentation

$emptyMessage

DocumentSelectFieldRenderer::$emptyMessage = "No Document Selected"

Definition at line 13 of file document_select_field_renderer.inc.

$library

DocumentSelectFieldRenderer::$library

Definition at line 12 of file document_select_field_renderer.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/document/document_select_field_renderer.inc