silverorange Code


Swat.SwatFrame
/Swat/SwatFrame.php at line 16

Class SwatFrame

SwatObject
└─SwatUIObject
└─SwatWidget
└─SwatContainer
└─SwatDisplayableContainer
└─SwatFrame

public class SwatFrame
extends SwatDisplayableContainer

A container with a decorative frame and optional title

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

Field Summary
string

$subtitle

An optional visible subtitle for this frame, or null.

string

$title

A visible title for this frame, or null.

string

$title_separator

An optional string to separate subtitle from the title.

Method Summary
void

display()

Displays this frame.

protected array

getCSSClassNames()

Gets the array of CSS classes that are applied to this frame.

string

getTitle()

Gets the title of this frame.

Methods inherited from Swat.SwatDisplayableContainer
display, getCSSClassNames
Methods inherited from Swat.SwatContainer
add, addChild, copy, display, displayChildren, getChild, getChildren, getDescendantStates, getDescendants, getFirst, getFirstDescendant, getFocusableHtmlId, getHtmlHeadEntrySet, getMessages, hasMessage, init, notifyOfAdd, packEnd, packStart, printWidgetTree, process, remove, replace, sendAddNotifySignal, setDescendantStates
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/SwatFrame.php at line 32

subtitle

public string $subtitle = null

An optional visible subtitle for this frame, or null


/Swat/SwatFrame.php at line 25

title

public string $title = null

A visible title for this frame, or null


/Swat/SwatFrame.php at line 39

title_separator

public string $title_separator = ': '

An optional string to separate subtitle from the title


Method Detail

/Swat/SwatFrame.php at line 68

display

public void display()

Displays this frame


/Swat/SwatFrame.php at line 131

getCSSClassNames

protected array getCSSClassNames()

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

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

/Swat/SwatFrame.php at line 51

getTitle

public string getTitle()

Gets the title of this frame

Implements the SwatTitleable::getTitle() interface.

Returns:
the title of this frame.

silverorange Code