com.sencha.gxt.widget.core.client

Interface ContentPanel.ContentPanelAppearance

All Known Subinterfaces:

AccordionLayoutContainer.AccordionLayoutAppearance, FramedPanel.FramedPanelAppearance, Window.WindowAppearance

All Known Implementing Classes:

AccordionLayoutBaseAppearance, BlueAccordionLayoutAppearance, BlueContentPanelAppearance, BlueFramedPanelAppearance, BlueMessageBoxAppearance, BlueWindowAppearance, ContentPanelBaseAppearance, FramedPanelBaseAppearance, GrayAccordionLayoutAppearance, GrayContentPanelAppearance, GrayFramedPanelAppearance, GrayMessageBoxAppearance, GrayWindowAppearance

Enclosing class:

ContentPanel

public static interface ContentPanel.ContentPanelAppearance

The appearance of a content panel. A content panel has a header, body and footer. The header includes a button that can be used to collapse or expand the body. The button has an icon that changes to indicate whether a collapse or expand is possible. The body contains a single widget, added using SimpleContainer.add(Widget). The widget is resized to match the size of the container. The footer contains a button bar with optional buttons.

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.
Header.HeaderAppearance	getHeaderAppearance() Returns the content panel header's appearance
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.

Method Detail

collapseIcon

IconButton.IconConfig collapseIcon()

Returns the button icon that indicates a collapse is possible.

Returns:

the collapse icon

expandIcon

IconButton.IconConfig expandIcon()

Returns the button icon that indicates an expand is possible.

Returns:

the expand icon

getBodyWrap

XElement getBodyWrap(XElement parent)

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

Parameters:

parent - the content panel root element

Returns:

the element that wraps the body

getContentElem

XElement getContentElem(XElement parent)

Returns the content panel body element.

Parameters:

parent - the content panel root element

Returns:

the body element

getFooterElem

XElement getFooterElem(XElement parent)

Returns the content panel footer element.

Parameters:

parent - the content panel root element

Returns:

the body element

getFrameHeight

int getFrameHeight(XElement parent)

Returns the total height of the content panel frame elements.

Parameters:

parent - the content panel root element

Returns:

the total height of the frame elements

getFrameWidth

int getFrameWidth(XElement parent)

Returns the total width of the content panel frame elements.

Parameters:

parent - the content panel root element

Returns:

the total width of the frame elements

getHeaderAppearance

Header.HeaderAppearance getHeaderAppearance()

Returns the content panel header's appearance

Returns:

the header appearance

getHeaderElem

XElement getHeaderElem(XElement parent)

Returns the content panel header element.

Parameters:

parent - the content panel root element

Returns:

the content panel header element

getHeaderSize

Size getHeaderSize(XElement parent)

Returns the header size excluding any framing.

Parameters:

parent - the content panel root element

Returns:

the header size

onBodyBorder

void onBodyBorder(XElement parent,
                  boolean border)

Handles a change in the visibility of the body border.

Parameters:

parent - content panel root element

border - true to display the border

onHideHeader

void onHideHeader(XElement parent,
                  boolean hide)

Hides or shows the header.

Parameters:

parent - content panel root element

hide - true to hide the header

render

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.

Parameters:

sb - receives the rendered appearance