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

Class ContentPanelBaseAppearance

java.lang.Object

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

All Implemented Interfaces:

ContentPanel.ContentPanelAppearance

Direct Known Subclasses:

AccordionLayoutBaseAppearance, BlueContentPanelAppearance, FramedPanelBaseAppearance, GrayContentPanelAppearance

public abstract class ContentPanelBaseAppearance
extends Object
implements ContentPanel.ContentPanelAppearance

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContentPanelBaseAppearance.ContentPanelResources
static interface	ContentPanelBaseAppearance.ContentPanelStyle
static interface	ContentPanelBaseAppearance.ContentPanelTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentPanelBaseAppearance.ContentPanelResources	resources
protected ContentPanelBaseAppearance.ContentPanelStyle	style
protected ContentPanelBaseAppearance.ContentPanelTemplate	template

Constructor Summary

Constructors

Constructor and Description
ContentPanelBaseAppearance()
ContentPanelBaseAppearance(ContentPanelBaseAppearance.ContentPanelResources resources)
ContentPanelBaseAppearance(ContentPanelBaseAppearance.ContentPanelResources resources, ContentPanelBaseAppearance.ContentPanelTemplate template)

Method Summary

Modifier and Type	Method and Description
IconButton.IconConfig	collapseIcon() Returns the button icon that indicates a collapse is possible.
IconButton.IconConfig	expandIcon() Returns the button icon that indicates an expand is possible.
XElement	getBodyWrap(XElement parent) Returns the element that wraps the content panel body.
XElement	getContentElem(XElement parent) Returns the content panel body element.
XElement	getFooterElem(XElement parent) Returns the content panel footer 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.
Size	getHeaderSize(XElement parent) Returns the header size excluding any framing.
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 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

getHeaderAppearance

Field Detail

template

protected ContentPanelBaseAppearance.ContentPanelTemplate template

style

protected final ContentPanelBaseAppearance.ContentPanelStyle style

resources

protected final ContentPanelBaseAppearance.ContentPanelResources resources

Constructor Detail

ContentPanelBaseAppearance

public ContentPanelBaseAppearance()

ContentPanelBaseAppearance

public ContentPanelBaseAppearance(ContentPanelBaseAppearance.ContentPanelResources resources)

ContentPanelBaseAppearance

public ContentPanelBaseAppearance(ContentPanelBaseAppearance.ContentPanelResources resources,
                                  ContentPanelBaseAppearance.ContentPanelTemplate template)

Method Detail

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

Parameters:

parent - content panel root element

hide - true to hide the header

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

Parameters:

parent - content panel root element

border - true to display the border

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

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

Parameters:

parent - the content panel root element

Returns:

the body element

getFooterElem

public XElement getFooterElem(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the content panel footer element.

Specified by:

getFooterElem in interface ContentPanel.ContentPanelAppearance

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

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

Parameters:

parent - the content panel root element

Returns:

the total width of the frame elements

getHeaderSize

public Size getHeaderSize(XElement parent)

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the header size excluding any framing.

Specified by:

getHeaderSize in interface ContentPanel.ContentPanelAppearance

Parameters:

parent - the content panel root element

Returns:

the header size

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

Parameters:

parent - the content panel root element

Returns:

the content panel header element

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

Parameters:

sb - receives the rendered appearance

collapseIcon

public IconButton.IconConfig collapseIcon()

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the button icon that indicates a collapse is possible.

Specified by:

collapseIcon in interface ContentPanel.ContentPanelAppearance

Returns:

the collapse icon

expandIcon

public IconButton.IconConfig expandIcon()

Description copied from interface: ContentPanel.ContentPanelAppearance

Returns the button icon that indicates an expand is possible.

Specified by:

expandIcon in interface ContentPanel.ContentPanelAppearance

Returns:

the expand icon