silverorange Code


Swat.SwatControl
/Swat/SwatControl.php at line 16

Class SwatControl

SwatObject
└─SwatUIObject
└─SwatWidget
└─SwatControl

public abstract class SwatControl
extends SwatWidget

Abstract base class for control widgets (non-container)

Copyright:
2004-2006 silverorange
License:
http://www.gnu.org/copyleft/lesser.html LGPL License 2.1

Fields inherited from Swat.SwatWidget
displayed, id, initialized, messages, processed, requires_id, sensitive, stylesheet
Fields inherited from Swat.SwatUIObject
classes, html_head_entry_set, parent, visible
Method Summary
void

addMessage(SwatMessage message)

Adds a message to this control.

SwatMessage

getNote()

Gets an informative note of how to use this control.

void

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

Method Detail

/Swat/SwatControl.php at line 31

addMessage

public void addMessage(SwatMessage message)

Adds a message to this control

Before the message is added, the content is updated with the name of this controls's parent title field if the parent implements the SwatTitleable interface.

Parameters:
message - the message to add.
See Also:
SwatWidget::addMessage()

/Swat/SwatControl.php at line 76

getNote

public SwatMessage getNote()

Gets an informative note of how to use this control

By default, controls return null, meaning no note.

Returns:
an informative note of how to use this control or null if this control has no note.

/Swat/SwatControl.php at line 60

printWidgetTree

public void printWidgetTree()

Todo:
document me

silverorange Code