com.sencha.gxt.theme.base.client.panel

Class FramedPanelBaseAppearance

java.lang.Object

com.sencha.gxt.theme.base.client.panel.ContentPanelBaseAppearance

com.sencha.gxt.theme.base.client.panel.FramedPanelBaseAppearance

All Implemented Interfaces:

ContentPanel.ContentPanelAppearance, FramedPanel.FramedPanelAppearance

Direct Known Subclasses:

BlueFramedPanelAppearance, BlueWindowAppearance, GrayFramedPanelAppearance, GrayWindowAppearance

public abstract class FramedPanelBaseAppearance
extends ContentPanelBaseAppearance
implements FramedPanel.FramedPanelAppearance

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FramedPanelBaseAppearance.FramedPanelDivFrameResources
static interface	FramedPanelBaseAppearance.FramedPanelTemplate

Nested classes/interfaces inherited from class com.sencha.gxt.theme.base.client.panel.ContentPanelBaseAppearance

ContentPanelBaseAppearance.ContentPanelResources, ContentPanelBaseAppearance.ContentPanelStyle, ContentPanelBaseAppearance.ContentPanelTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected CollapsibleFrame	frame

Fields inherited from class com.sencha.gxt.theme.base.client.panel.ContentPanelBaseAppearance

resources, style, template

Constructor Summary

Constructors

Constructor and Description
FramedPanelBaseAppearance(ContentPanelBaseAppearance.ContentPanelResources resources, FramedPanelBaseAppearance.FramedPanelTemplate template, CollapsibleFrame frame)

Method Summary

Modifier and Type	Method and Description
XElement	getBodyWrap(XElement parent) Returns the element that wraps the content panel body.
XElement	getContentElem(XElement parent) Returns the content panel body element.
int	getFrameHeight(XElement parent) Returns the total height of the content panel frame elements.
int	getFrameWidth(XElement parent) Returns the total width of the content panel frame elements.
XElement	getHeaderElem(XElement parent) Returns the content panel header element.
void	onBodyBorder(XElement parent, boolean border) Handles a change in the visibility of the body border.
void	onHideHeader(XElement parent, boolean hide) Hides or shows the header.
void	render(SafeHtmlBuilder sb) Renders the appearance of a content panel as HTML into a SafeHtmlBuilder, suitable for passing to Element#setInnerSafeHtml(SafeHtml) on a container element.

Methods inherited from class com.sencha.gxt.theme.base.client.panel.ContentPanelBaseAppearance

collapseIcon, expandIcon, getFooterElem, getHeaderSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sencha.gxt.widget.core.client.ContentPanel.ContentPanelAppearance

collapseIcon, expandIcon, getFooterElem, getHeaderAppearance, getHeaderSize

Field Detail

frame

protected CollapsibleFrame frame

Constructor Detail

FramedPanelBaseAppearance

public FramedPanelBaseAppearance(ContentPanelBaseAppearance.ContentPanelResources resources,
                                 FramedPanelBaseAppearance.FramedPanelTemplate template,
                                 CollapsibleFrame frame)

Method Detail

getBodyWrap

public XElement getBodyWrap(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the element that wraps the content panel body. In the default implementation, this wraps the body widget and footer.

Specified by:

getBodyWrap in interface ContentPanel.ContentPanelAppearance

Overrides:

getBodyWrap in class ContentPanelBaseAppearance

Parameters:

parent - the content panel root element

Returns:

the element that wraps the body

getContentElem

public XElement getContentElem(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the content panel body element.

Specified by:

getContentElem in interface ContentPanel.ContentPanelAppearance

Overrides:

getContentElem in class ContentPanelBaseAppearance

Parameters:

parent - the content panel root element

Returns:

the body element

getFrameHeight

public int getFrameHeight(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the total height of the content panel frame elements.

Specified by:

getFrameHeight in interface ContentPanel.ContentPanelAppearance

Overrides:

getFrameHeight in class ContentPanelBaseAppearance

Parameters:

parent - the content panel root element

Returns:

the total height of the frame elements

getFrameWidth

public int getFrameWidth(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the total width of the content panel frame elements.

Specified by:

getFrameWidth in interface ContentPanel.ContentPanelAppearance

Overrides:

getFrameWidth in class ContentPanelBaseAppearance

Parameters:

parent - the content panel root element

Returns:

the total width of the frame elements

getHeaderElem

public XElement getHeaderElem(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the content panel header element.

Specified by:

getHeaderElem in interface ContentPanel.ContentPanelAppearance

Overrides:

getHeaderElem in class ContentPanelBaseAppearance

Parameters:

parent - the content panel root element

Returns:

the content panel header element

onBodyBorder

public void onBodyBorder(XElement parent,
                         boolean border)

Description copied from interface: ContentPanel.ContentPanelAppearance

Handles a change in the visibility of the body border.

Specified by:

onBodyBorder in interface ContentPanel.ContentPanelAppearance

Overrides:

onBodyBorder in class ContentPanelBaseAppearance

Parameters:

parent - content panel root element

border - true to display the border

onHideHeader

public void onHideHeader(XElement parent,
                         boolean hide)

Description copied from interface: ContentPanel.ContentPanelAppearance

Hides or shows the header.

Specified by:

onHideHeader in interface ContentPanel.ContentPanelAppearance

Overrides:

onHideHeader in class ContentPanelBaseAppearance

Parameters:

parent - content panel root element

hide - true to hide the header

render

public void render(SafeHtmlBuilder sb)

Description copied from interface: ContentPanel.ContentPanelAppearance

Renders the appearance of a content panel as HTML into a SafeHtmlBuilder, suitable for passing to Element#setInnerSafeHtml(SafeHtml) on a container element.

Specified by:

render in interface ContentPanel.ContentPanelAppearance

Overrides:

render in class ContentPanelBaseAppearance

Parameters:

sb - receives the rendered appearance