Summary: Field | Method | Constr Detail: Field | Method | Constr

Swat.SwatSearchEntry

/Swat/SwatSearchEntry.php at line 14

Class SwatSearchEntry

SwatObject
 └─SwatUIObject
    └─SwatWidget
       └─SwatControl
          └─SwatInputControl
             └─SwatEntry
                └─SwatSearchEntry

public class SwatSearchEntry
extends SwatEntry

A single line search entry widget

Copyright:: 2007 silverorange
License:: http://www.gnu.org/copyleft/lesser.html LGPL License 2.1

Field Summary
string	$name An XHTML name for this search entry widget.

Field Summary

string

$name

An XHTML name for this search entry widget.

Fields inherited from Swat.SwatEntry
access_key, autocomplete, maxlength, minlength, nonce, read_only, size, tab_index, value

Fields inherited from Swat.SwatInputControl
required

Constructor Summary
SwatSearchEntry(mixed id)

Method Summary
void	display() Displays this search entry.
protected array	getCSSClassNames() Gets the array of CSS classes that are applied to this entry.
protected srting	getInlineJavaScript() Gets the inline JavaScript for this entry to function.
protected SwatHtmlTag	getInputTag() Get the input tag to display.

Methods inherited from Swat.SwatEntry
display, getCSSClassNames, getDisplayValue, getFocusableHtmlId, getInputTag, getNonce, getRawValue, getState, getValidationMessage, hasRawValue, process, setState

Methods inherited from Swat.SwatInputControl
getForm, init

Methods inherited from Swat.SwatControl
addMessage, getNote, printWidgetTree

Methods inherited from Swat.SwatWidget
addCompositeWidget, addMessage, confirmCompositeWidgets, copy, createCompositeWidgets, display, displayHtmlHeadEntries, getCSSClassNames, getCompositeWidget, getCompositeWidgets, getFocusableHtmlId, getHtmlHeadEntrySet, getMessages, hasMessage, init, isDisplayed, isInitialized, isProcessed, isSensitive, printWidgetTree, process, replaceWithContainer

Methods inherited from Swat.SwatUIObject
addComment, addJavaScript, addStyleSheet, addTangoAttribution, copy, getCSSClassNames, getCSSClassString, getFirstAncestor, getHtmlHeadEntrySet, getInlineJavaScript, getUniqueId, isVisible

Field Detail

/Swat/SwatSearchEntry.php at line 27

name

public string $name

An XHTML name for this search entry widget

The name is used as the XHTML form element name. This is useful for HTTP GET forms where the input name is displayed in the request URI. If the name is not specified, the widget id is used as the name.

Constructor Detail

/Swat/SwatSearchEntry.php at line 32

SwatSearchEntry

public SwatSearchEntry(mixed id)

Method Detail

/Swat/SwatSearchEntry.php at line 55

display

public void display()

Displays this search entry

Outputs an appropriate XHTML tag and JavaScript.

/Swat/SwatSearchEntry.php at line 104

getCSSClassNames

protected array getCSSClassNames()

Gets the array of CSS classes that are applied to this entry

Returns:: the array of CSS classes that are applied to this entry.
See Also:: SwatUIObject::getCSSClassString()

/Swat/SwatSearchEntry.php at line 77

getInlineJavaScript

protected srting getInlineJavaScript()

Gets the inline JavaScript for this entry to function

The inline JavaScript creates an instance of the SwatSearchEntry widget with the name $this->id_'obj'.

Returns:: the inline JavaScript required for this control to function

/Swat/SwatSearchEntry.php at line 85

getInputTag

protected SwatHtmlTag getInputTag()

Get the input tag to display

Can be used by sub-classes to change the setup of the input tag.

Returns:: Input tag to display.

Frames No frames