| com.gwtext.client.widgets.Component
 com.gwtext.client.widgets.BoxComponent
com.gwtext.client.widgets.Container
com.gwtext.client.widgets.Panel
All known Subclasses: com.gwtext.client.widgets.Tip, com.gwtext.client.widgets.Window, com.gwtext.sample.showcase2.client.ShowcaseView, com.gwtext.client.widgets.form.FieldSet, com.gwtext.client.widgets.HTMLPanel, com.gwtext.client.widgets.TabPanel, com.gwtext.client.widgets.tree.TreePanel, com.gwtext.client.widgets.form.MultiFieldPanel, com.gwtext.sample.showcase2.client.ShowcasePanel, com.gwtext.client.widgets.grid.GridPanel, com.gwtext.client.widgets.form.FormPanel, com.gwtext.client.widgets.PaddedPanel,
| Panel | | public class Panel extends Container (Code) | | Panel is a container that has specific functionality and structural components that make it the perfect building
block for application-oriented user interfaces. The Panel contains bottom and top toolbars, along with separate header,
footer and body sections. It also provides built-in expandable and collapsible behavior, along with a variety of prebuilt
tool buttons that can be wired up to provide other customized behavior. Panels can be easily dropped into any Container or
layout, and the layout and rendering pipeline is completely managed by the framework.
|
| Constructor Summary | |
| public | Panel()
Create a new Panel. | | public | Panel(String title)
Construct a new Panel with the given title. | | public | Panel(String title, String html)
| | public | Panel(String title, int width, int height)
| | protected | Panel(JavaScriptObject jsObj)
| | public | Panel(Element element)
Applys the Panel to an existing element. |
| Method Summary | |
| public void | addButton(Button button)
Adds a button to this panel. | | native public void | addListener(PanelListener listener)
Add a Panel listener. | | public void | addTool(Tool tool)
The tool to be added to the header tool area. | | public void | collapse()
Collapses the panel body so that it becomes hidden. | | public void | collapse(boolean animate)
Collapses the panel body so that it becomes hidden. | | native protected JavaScriptObject | create(JavaScriptObject config)
| | public void | expand()
Expands the panel body so that it becomes visible. | | public void | expand(boolean animate)
Expands the panel body so that it becomes visible. | | public String | getBaseCls()
The base CSS class to apply to this panel's element.
the base CSS class to apply to this panel's element. | | native public ExtElement | getBody()
The Panel's body Element which may be used to contain HTML content. | | public String | getBodyStyle()
| | native public ExtElement | getBodyWrap()
The wrapper element for the body of the Panel. | | native public Toolbar | getBottomToolbar()
Returns the toolbar from the bottom section of the panel. | | public boolean | getCollapseFirst()
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar,
false to render it last. | | public String | getCollapsedCls()
A CSS class to add to the panel's element after it has been collapsed. | | protected JavaScriptObject | getConfigPrototype()
| | public boolean | getFloating()
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered. | | native public ExtElement | getFooter()
The Panel's footer Element. | | native public int | getFrameHeight()
Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and header
and footer elements, but not including the body height). | | native public int | getFrameWidth()
Returns the width in pixels of the framing elements of this panel (not including the body width). | | native public ExtElement | getHeader()
The Panel's header Element. | | public String | getHtml()
An HTML fragment, or a DomHelper specification to use as the panel's body content. | | public String | getIconCls()
| | native public int | getInnerHeight()
Returns the height in pixels of the body element (not including the height of any framing elements). | | native public int | getInnerWidth()
Returns the width in pixels of the body element (not including the width of any framing elements). | | public int | getMinButtonWidth()
Minimum width in pixels of all buttons in this panel. | | public int | getShadowOffset()
The number of pixels to offset the shadow if displayed. | | public String | getTitle()
The title text to display in the panel header. | | native public Toolbar | getTopToolbar()
Returns the toolbar from the top section of the panel. | | native public UpdateManager | getUpdateManager()
Get the UpdateManager for this panel. | | public String | getXType()
| | public boolean | isAnimCollapse()
True to animate the transition when the panel is collapsed, false to skip the animation. | | public boolean | isAutoScroll()
True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary,
false to clip any overflowing content. | | public boolean | isBodyBorder()
| | public boolean | isBorder()
True to display the borders of the panel's body element, false to hide them. | | public boolean | isClosable()
Whether the Panel is closable. | | public boolean | isCollapsed()
True if panel collapsed, false if expanded. | | public boolean | isCollapsible()
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area,
false to keep the panel statically sized with no button. | | public boolean | isFrame()
| | public boolean | isHeader()
True to create the header element explicitly, false to skip creating it. | | public boolean | isHeaderAsText()
| | public boolean | isHideCollapseTool()
True to hide the expand/collapse toggle button when collapsible = true, false to display it. | | public boolean | isMaskDisabled()
| | public boolean | isShadow()
True to display a shadow behind the panel, false to display no shadow (defaults to 'sides'). | | public boolean | isShim()
False to disable the iframe shim in browsers which need one. | | public boolean | isTitleCollapse()
| | public void | load(String url)
Loads this content panel immediately with content returned from an XHR call. | | public void | load(String url, UrlParam[] params, UrlLoadCallback callback, boolean loadScripts)
Loads this content panel immediately with content returned from an XHR call. | | public void | setAnimCollapse(boolean animCollapse)
True to animate the transition when the panel is collapsed, false to skip the animation. | | public void | setAutoLoad(String url)
If set, the panel will attempt to load its contents from the specified URL immediately upon
render. | | public void | setAutoLoad(String url, UrlLoadConfig loadConfig)
If set, the panel will attempt to load its contents from the specified URL immediately upon render. | | public void | setAutoScroll(boolean autoScroll)
True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary,
false to clip any overflowing content. | | public void | setBaseCls(String baseCls)
The base CSS class to apply to this panel's element. | | public void | setBodyBorder(boolean bodyBorder)
True to display an interior border on the body element of the panel, false to hide it.
This only applies when border == true. | | public void | setBodyStyle(String bodyStyle)
| | public void | setBorder(boolean border)
True to display the borders of the panel's body element, false to hide them. | | public void | setBottomToolbar(Toolbar toolbar)
The bottom toolbar of the panel. | | public void | setBottomToolbar(Button button)
The bottom toolbar of the panel. | | public void | setBottomToolbar(Button[] buttons)
The bottom toolbar of the panel. | | public void | setButtonAlign(Position buttonAlign)
The alignment of any buttons added to this panel. | | public void | setButtons(Button[] buttons)
Used to add buttons to the footer of this panel. | | public void | setClosable(boolean closable)
Whether the Panel is closable. | | public void | setCollapseFirst(boolean collapseFirst)
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar,
false to render it last. | | public void | setCollapsed(boolean collapsed)
| | public void | setCollapsedCls(String collapsedCls)
A CSS class to add to the panel's element after it has been collapsed. | | public void | setCollapsible(boolean collapsible)
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area,
false to keep the panel statically sized with no button. | | public void | setContentEl(Element contentEl)
| | public void | setDraggable(boolean draggable)
True to enable dragging of this Panel (defaults to false). | | public void | setFloating(boolean floating)
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered. | | public void | setFooter(boolean footer)
True to create the footer element explicitly, false to skip creating it. | | public void | setFrame(boolean frame)
True to render the panel with custom rounded borders, false to render with plain 1px square borders. | | public void | setHeader(boolean header)
True to create the header element explicitly, false to skip creating it. | | public void | setHeaderAsText(boolean headerAsText)
True to display the panel title in the header, false to hide it
Note: This property cannot be changed after the Component has been rendered. | | public void | setHideCollapseTool(boolean hideCollapseTool)
True to hide the expand/collapse toggle button when collapsible = true, false to display it. | | public void | setHtml(String html)
An HTML fragment, or a DomHelper specification to use as the panel's body content. | | public void | setIconCls(String iconCls)
| | public void | setMargins(int margin)
Set padding on all sides. | | public void | setMargins(int top, int left, int right, int bottom)
Set paddings to Panel. | | public void | setMaskDisabled(boolean maskDisabled)
True to mask the panel when it is disabled, false to not mask it. | | public void | setMinButtonWidth(int minButtonWidth)
Minimum width in pixels of all buttons in this panel. | | public void | setPaddings(int padding)
Set padding on all sides. | | public void | setPaddings(int top, int left, int right, int bottom)
Set paddings to Panel. | | public void | setShadow(boolean shadow)
True to display a shadow behind the panel, false to display no shadow (defaults to 'sides'). | | public void | setShadow(Shadow.Type shadow)
Set the shadow behind the Panel. | | public void | setShadowOffset(int shadowOffset)
The number of pixels to offset the shadow if displayed. | | public void | setShim(boolean shim)
False to disable the iframe shim in browsers which need one. | | public void | setStyleName(String style)
| | public void | setTitle(String title, String iconCls)
Sets the title text for the panel and optioanlly the icon class. | | public void | setTitle(String title)
The title text to display in the panel header. | | public void | setTitleCollapse(boolean titleCollapse)
| | public void | setTools(Tool[] tools)
The tools to be added to the header tool area. | | public void | setTopToolbar(Toolbar toolbar)
The top toolbar of the panel. | | public void | setTopToolbar(Button button)
The top toolbar of the panel. | | public void | setTopToolbar(Button[] buttons)
The top toolbar of the panel. | | native public void | toggleCollapse()
Shortcut for performing an expand or collapse based on the current state of the panel. | | native public void | toggleCollapse(boolean animate)
Shortcut for performing an expand or collapse based on the current state of the panel. |
| Panel | | public Panel()(Code) | | Create a new Panel.
|
| Panel | | public Panel(String title)(Code) | | Construct a new Panel with the given title.
Parameters:
title - the title |
| Panel | | public Panel(String title, int width, int height)(Code) | | |
| Panel | | protected Panel(JavaScriptObject jsObj)(Code) | | |
| Panel | | public Panel(Element element)(Code) | | Applys the Panel to an existing element.
Parameters:
element - the element |
| addButton | | public void addButton(Button button)(Code) | | Adds a button to this panel. Note that this method must be called prior to rendering. The preferred approach is to
add buttons via the buttons config.
Parameters:
button - the button to add |
| addListener | | native public void addListener(PanelListener listener)(Code) | | Add a Panel listener.
Parameters:
listener - the listener |
| collapse | | public void collapse()(Code) | | Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will cancel the collapse
action if it returns false.
|
| collapse | | public void collapse(boolean animate)(Code) | | Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will cancel the collapse
action if it returns false.
Parameters:
animate - True to animate the transition, else false (defaults to the value of the animCollapse panel config) |
| create | | native protected JavaScriptObject create(JavaScriptObject config)(Code) | | |
| expand | | public void expand()(Code) | | Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
cancel the expand action if it returns false.
|
| expand | | public void expand(boolean animate)(Code) | | Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
cancel the expand action if it returns false.
Parameters:
animate - True to animate the transition, else false (defaults to the value of the animCollapse panel config) |
| getBaseCls | | public String getBaseCls()(Code) | | The base CSS class to apply to this panel's element.
the base CSS class to apply to this panel's element. Defaults to 'x-panel' |
| getBody | | native public ExtElement getBody()(Code) | | The Panel's body Element which may be used to contain HTML content. The content may be specified in the html config,
or it may be loaded using the autoLoad config, or through the Panel's Updater.
If this is used to load visible HTML elements in either way, then the Panel may not be used as a Layout for hosting nested Panels.
If this Panel is intended to be used as the host of a Layout (See layout then the body Element must not be loaded or changed -
it is under the control of the Panel's Layout.
the body element |
| getBodyStyle | | public String getBodyStyle()(Code) | | Custom CSS styles to be applied to the body element in the format expected by
ExtElement.applyStyles(String) the custom CSS styles to be applied to the body element |
| getBodyWrap | | native public ExtElement getBodyWrap()(Code) | | The wrapper element for the body of the Panel.
the wrapper element for the body of the Panel |
| getBottomToolbar | | native public Toolbar getBottomToolbar()(Code) | | Returns the toolbar from the bottom section of the panel.
the bottom toolbar |
| getCollapseFirst | | public boolean getCollapseFirst()(Code) | | True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar,
false to render it last.
true to make sure the collapse/expand toggle button always renders first |
| getCollapsedCls | | public String getCollapsedCls()(Code) | | A CSS class to add to the panel's element after it has been collapsed.
the CSS class to add to the panel's element after it has been collapsed. |
| getConfigPrototype | | protected JavaScriptObject getConfigPrototype()(Code) | | |
| getFloating | | public boolean getFloating()(Code) | | True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered.
Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because
the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);).
Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the
right edge of the viewport.
true to float panel, false to display it inline where it is rendered |
| getFooter | | native public ExtElement getFooter()(Code) | | The Panel's footer Element. This Element is used to house the Panel's
buttons.
the footer element |
| getFrameHeight | | native public int getFrameHeight()(Code) | | Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and header
and footer elements, but not including the body height). To retrieve the body height see
Panel.getInnerHeight() .
the frame hieght |
| getFrameWidth | | native public int getFrameWidth()(Code) | | Returns the width in pixels of the framing elements of this panel (not including the body width). To retrieve
the body width see
Panel.getInnerWidth() .
the frame width |
| getHeader | | native public ExtElement getHeader()(Code) | | The Panel's header Element. This Element is used to house the title and tools
the header element |
| getHtml | | public String getHtml()(Code) | | An HTML fragment, or a DomHelper specification to use as the panel's body content.
the HTML fragment, or a DomHelper specification to use as the panel's body content. |
| getIconCls | | public String getIconCls()(Code) | | the CSS class that will provide a background image to be used as the panel header icon |
| getInnerHeight | | native public int getInnerHeight()(Code) | | Returns the height in pixels of the body element (not including the height of any framing elements).
For the frame height see
Panel.getFrameHeight() .
the inner height |
| getInnerWidth | | native public int getInnerWidth()(Code) | | Returns the width in pixels of the body element (not including the width of any framing elements).
For the frame width see
Panel.getFrameWidth() .
the inner width |
| getMinButtonWidth | | public int getMinButtonWidth() throws IllegalStateException(Code) | | Minimum width in pixels of all buttons in this panel.
the minimum width in pixels of all buttons in this panel.
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| getShadowOffset | | public int getShadowOffset()(Code) | | The number of pixels to offset the shadow if displayed. Note that this option only applies when floating = true.
the number of pixels to offset the shadow if displayed. Note that this option only applies when floating = true. |
| getTitle | | public String getTitle()(Code) | | The title text to display in the panel header.
the title text to display in the panel header. |
| getTopToolbar | | native public Toolbar getTopToolbar()(Code) | | Returns the toolbar from the top section of the panel.
the top toolbar |
| getUpdateManager | | native public UpdateManager getUpdateManager()(Code) | | Get the UpdateManager for this panel. Enables you to perform Ajax updates of this panel's body.
the UpdateManager |
| isAnimCollapse | | public boolean isAnimCollapse()(Code) | | True to animate the transition when the panel is collapsed, false to skip the animation.
true to animate the transition when the panel is collapsed, false to skip the animation |
| isAutoScroll | | public boolean isAutoScroll()(Code) | | True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary,
false to clip any overflowing content.
true to autoscroll |
| isBodyBorder | | public boolean isBodyBorder()(Code) | | true to display an interior border on the body element of the panel, false to hide it. |
| isBorder | | public boolean isBorder()(Code) | | True to display the borders of the panel's body element, false to hide them.
By default, the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.
true to display the borders of the panel's body element, false to hide them. |
| isClosable | | public boolean isClosable()(Code) | | Whether the Panel is closable. This is applicable when a Panel is added to a TabPanel.
true if the Panel is closable |
| isCollapsed | | public boolean isCollapsed()(Code) | | True if panel collapsed, false if expanded.
true to render the panel expanded, false to render it collapsed |
| isCollapsible | | public boolean isCollapsible()(Code) | | True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area,
false to keep the panel statically sized with no button.
true to make the panel collapsible and have the expand/collapse toggle button automatically rendered intothe header tool button area, false to keep the panel statically sized with no button |
| isFrame | | public boolean isFrame()(Code) | | true to render the panel with custom rounded borders |
| isHeader | | public boolean isHeader()(Code) | | True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is
set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the
header will not be rendered.
true to create header |
| isHeaderAsText | | public boolean isHeaderAsText()(Code) | | true to display the panel title in the header, false to hide it |
| isHideCollapseTool | | public boolean isHideCollapseTool()(Code) | | True to hide the expand/collapse toggle button when collapsible = true, false to display it.
true to hide the expand/collapse toggle button when collapsible = true, false to display it. |
| isMaskDisabled | | public boolean isMaskDisabled()(Code) | | true to mask the panel when it is disabled, false to not mask it. |
| isShadow | | public boolean isShadow()(Code) | | True to display a shadow behind the panel, false to display no shadow (defaults to 'sides').
true to display a shadow behind the panel, false to display no shadow (defaults to 'sides'). |
| isShim | | public boolean isShim()(Code) | | False to disable the iframe shim in browsers which need one. Note that this option only applies when floating = true.
false to disable the iframe shim in browsers which need one. |
| isTitleCollapse | | public boolean isTitleCollapse()(Code) | | true to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar,false to allow it only by clicking to tool button |
| load | | public void load(String url)(Code) | | Loads this content panel immediately with content returned from an XHR call.
Parameters:
url - the url to load the content from |
| load | | public void load(String url, UrlParam[] params, UrlLoadCallback callback, boolean loadScripts)(Code) | | Loads this content panel immediately with content returned from an XHR call.
Parameters:
url - the url to load the content from
Parameters:
params - the request URL params
Parameters:
callback - callback function
Parameters:
loadScripts - whether to execute scripts from the laoded content. |
| setAnimCollapse | | public void setAnimCollapse(boolean animCollapse)(Code) | | True to animate the transition when the panel is collapsed, false to skip the animation.
Parameters:
animCollapse - Defaults to true if the Fx class is available, otherwise false |
| setAutoLoad | | public void setAutoLoad(String url)(Code) | | If set, the panel will attempt to load its contents from the specified URL immediately upon
render.
The URL will become the default URL for this panel's body element, so it may be refreshed at any time.
Parameters:
url - the URL to load the panel's content |
| setAutoLoad | | public void setAutoLoad(String url, UrlLoadConfig loadConfig) throws IllegalStateException(Code) | | If set, the panel will attempt to load its contents from the specified URL immediately upon render.
The URL will become the default URL for this panel's body element, so it may be refreshed at any time.
Parameters:
url - the URL to load the panel's content
Parameters:
loadConfig - the URL load configuration
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setAutoScroll | | public void setAutoScroll(boolean autoScroll) throws IllegalStateException(Code) | | True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary,
false to clip any overflowing content.
Parameters:
autoScroll - Defaults to false
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setBaseCls | | public void setBaseCls(String baseCls) throws IllegalStateException(Code) | | The base CSS class to apply to this panel's element.
Parameters:
baseCls - Defaults to 'x-panel'
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setBodyBorder | | public void setBodyBorder(boolean bodyBorder) throws IllegalStateException(Code) | | True to display an interior border on the body element of the panel, false to hide it.
This only applies when border == true. If border == true and bodyBorder == false, the border will display as a
1px wide inset border, giving the entire body element an inset appearance.
Parameters:
bodyBorder - Defaults to true
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setBorder | | public void setBorder(boolean border) throws IllegalStateException(Code) | | True to display the borders of the panel's body element, false to hide them.
By default, the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.
Parameters:
border - Defaults to true
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setBottomToolbar | | public void setBottomToolbar(Toolbar toolbar)(Code) | | The bottom toolbar of the panel. Note that this is not available as a property after render.
To access the bottom toolbar after render, use @link #getBottomToolbar.
Parameters:
toolbar - the toolbar |
| setBottomToolbar | | public void setBottomToolbar(Button button) throws IllegalStateException(Code) | | The bottom toolbar of the panel. Note that this is not available as a property after render.
To access the bottom toolbar after render, use @link #getBottomToolbar.
Note: This property cannot be changed after the Component has been rendered. To add buttons after the Panel has been
rendered, call
Panel.getBottomToolbar() and then add Bottons directly to the toolbar.
Parameters:
button - the button
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setBottomToolbar | | public void setBottomToolbar(Button[] buttons) throws IllegalStateException(Code) | | The bottom toolbar of the panel. Note that this is not available as a property after render.
To access the bottom toolbar after render, use @link #getBottomToolbar.
Note: This property cannot be changed after the Component has been rendered. To add buttons after the Panel has been
rendered, call
Panel.getBottomToolbar() and then add Bottons directly to the toolbar.
Parameters:
buttons - the buttons
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setClosable | | public void setClosable(boolean closable) throws IllegalStateException(Code) | | Whether the Panel is closable. This is applicable when a Panel is added to a TabPanel.
Parameters:
closable - true if closable
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setCollapseFirst | | public void setCollapseFirst(boolean collapseFirst) throws IllegalStateException(Code) | | True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar,
false to render it last.
Parameters:
collapseFirst - Defaults to true
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setCollapsed | | public void setCollapsed(boolean collapsed)(Code) | | True if panel collapsed, false if expanded
Parameters:
collapsed - Defaults to false |
| setCollapsedCls | | public void setCollapsedCls(String collapsedCls) throws IllegalStateException(Code) | | A CSS class to add to the panel's element after it has been collapsed.
Parameters:
collapsedCls - Defaults to 'x-panel-collapsed'
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setCollapsible | | public void setCollapsible(boolean collapsible) throws IllegalStateException(Code) | | True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area,
false to keep the panel statically sized with no button.
Parameters:
collapsible - Defaults to false
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setContentEl | | public void setContentEl(Element contentEl) throws IllegalStateException(Code) | | The id of an existing HTML node to use as the panel's body content
Parameters:
contentEl - Defaults to null
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setDraggable | | public void setDraggable(boolean draggable) throws IllegalStateException(Code) | | True to enable dragging of this Panel (defaults to false).
Parameters:
draggable - true to enable dragging of this panel
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setFloating | | public void setFloating(boolean floating) throws IllegalStateException(Code) | | True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered.
Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because
the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);).
Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the
right edge of the viewport.
Parameters:
floating - Defaults to false
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setFooter | | public void setFooter(boolean footer) throws IllegalStateException(Code) | | True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more
buttons have been added to the panel the footer will be created automatically, otherwise it will not.
Parameters:
footer - true to create footer
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setFrame | | public void setFrame(boolean frame) throws IllegalStateException(Code) | | True to render the panel with custom rounded borders, false to render with plain 1px square borders.
Parameters:
frame - Defaults to false
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setHeader | | public void setHeader(boolean header) throws IllegalStateException(Code) | | True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is
set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the
header will not be rendered.
Parameters:
header - true to create header
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setHeaderAsText | | public void setHeaderAsText(boolean headerAsText)(Code) | | True to display the panel title in the header, false to hide it
Note: This property cannot be changed after the Component has been rendered.
Parameters:
headerAsText - Defaults to true |
| setHideCollapseTool | | public void setHideCollapseTool(boolean hideCollapseTool) throws IllegalStateException(Code) | | True to hide the expand/collapse toggle button when collapsible = true, false to display it.
Parameters:
hideCollapseTool - Defaults to false
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setHtml | | public void setHtml(String html)(Code) | | An HTML fragment, or a DomHelper specification to use as the panel's body content.
Parameters:
html - Defaults to "" |
| setIconCls | | public void setIconCls(String iconCls)(Code) | | A CSS class that will provide a background image to be used as the panel header icon
Parameters:
iconCls - Defaults to "" |
| setMargins | | public void setMargins(int margin) throws IllegalStateException(Code) | | Set padding on all sides.
Parameters:
margin - the padding value in pixels
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setMargins | | public void setMargins(int top, int left, int right, int bottom) throws IllegalStateException(Code) | | Set paddings to Panel.
Parameters:
top - the top padding
Parameters:
left - left padding
Parameters:
right - right padding
Parameters:
bottom - bottom padding
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setMaskDisabled | | public void setMaskDisabled(boolean maskDisabled) throws IllegalStateException(Code) | | True to mask the panel when it is disabled, false to not mask it. Either way, the panel will
always tell its contained elements to disable themselves when it is disabled, but masking the
panel can provide an additional visual cue that the panel is disabled.
Parameters:
maskDisabled - Defaults to true
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setMinButtonWidth | | public void setMinButtonWidth(int minButtonWidth) throws IllegalStateException(Code) | | Minimum width in pixels of all buttons in this panel.
Parameters:
minButtonWidth - Defaults to 75
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setPaddings | | public void setPaddings(int padding) throws IllegalStateException(Code) | | Set padding on all sides.
Parameters:
padding - the padding value in pixels
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setPaddings | | public void setPaddings(int top, int left, int right, int bottom) throws IllegalStateException(Code) | | Set paddings to Panel.
Parameters:
top - the top padding
Parameters:
left - left padding
Parameters:
right - right padding
Parameters:
bottom - bottom padding
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setShadow | | public void setShadow(boolean shadow)(Code) | | True to display a shadow behind the panel, false to display no shadow (defaults to 'sides').
Note that this option only applies when floating = true.
Parameters:
shadow - true to display shadow |
| setShadowOffset | | public void setShadowOffset(int shadowOffset) throws IllegalStateException(Code) | | The number of pixels to offset the shadow if displayed. Note that this option only applies when floating = true.
Parameters:
shadowOffset - Defaults to 4
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setShim | | public void setShim(boolean shim) throws IllegalStateException(Code) | | False to disable the iframe shim in browsers which need one. Note that this option only applies when floating = true.
Parameters:
shim - Defaults to true
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setTitle | | public void setTitle(String title, String iconCls)(Code) | | Sets the title text for the panel and optioanlly the icon class.
Parameters:
title - the title
Parameters:
iconCls - A CSS class that provides the icon image for this panel |
| setTitle | | public void setTitle(String title)(Code) | | The title text to display in the panel header. When a title is specified the header
element will automatically be created and displayed unless header is explicitly set to false. If you don't
want to specify a title at config time, but you may want one later, you must either specify a non-empty
title (a blank space " " will do) or call setHeader(true) so that the container element will get created.
Parameters:
title - Defaults to "" |
| setTitleCollapse | | public void setTitleCollapse(boolean titleCollapse) throws IllegalStateException(Code) | | True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar,
false to allow it only by clicking to tool button
Parameters:
titleCollapse - Defaults to false
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setTools | | public void setTools(Tool[] tools) throws IllegalStateException(Code) | | The tools to be added to the header tool area.
Parameters:
tools - the tools to add
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setTopToolbar | | public void setTopToolbar(Toolbar toolbar) throws IllegalStateException(Code) | | The top toolbar of the panel. Note that this is not available as a property after render.
To access the top toolbar after render, use getTopToolbar.
Parameters:
toolbar - the toolbar
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setTopToolbar | | public void setTopToolbar(Button button) throws IllegalStateException(Code) | | The top toolbar of the panel. Note that this is not available as a property after render.
To access the top toolbar after render, use getTopToolbar.
Parameters:
button - the button
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| setTopToolbar | | public void setTopToolbar(Button[] buttons) throws IllegalStateException(Code) | | The top toolbar of the panel. Note that this is not available as a property after render.
To access the top toolbar after render, use getTopToolbar.
Note: This property cannot be changed after the Component has been rendered. To add buttons after the Panel has been
rendered, call
Panel.getTopToolbar() and then add Bottons directly to the toolbar.
Parameters:
buttons - the buttons
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| toggleCollapse | | native public void toggleCollapse()(Code) | | Shortcut for performing an expand or collapse based on the current state of the panel.
|
| toggleCollapse | | native public void toggleCollapse(boolean animate)(Code) | | Shortcut for performing an expand or collapse based on the current state of the panel.
Parameters:
animate - true to animate |
| Methods inherited from com.gwtext.client.widgets.Component | public void addClass(String cls)(Code)(Java Doc)
native public void addClassCreated(String cls)(Code)(Java Doc)
native public void addEvent(String events)(Code)(Java Doc)
public void addEvents(String[] events)(Code)(Java Doc)
protected void addListener(String event, JavaScriptObject fn)(Code)(Java Doc)
native public void addListener(String event, Function funtion)(Code)(Java Doc)
native protected void addListener(ComponentListener listener)(Code)(Java Doc)
protected void afterRender()(Code)(Java Doc)
protected void beforeDestroy()(Code)(Java Doc)
protected void check() throws IllegalStateException(Code)(Java Doc)
public Component cloneComponent()(Code)(Java Doc)
public Component cloneComponent(Component overrides)(Code)(Java Doc)
native protected JavaScriptObject cloneConfig(JavaScriptObject config)(Code)(Java Doc)
abstract protected JavaScriptObject create(JavaScriptObject config)(Code)(Java Doc)
native public void destroy()(Code)(Java Doc)
public void disable()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void error(String message) throws IllegalStateException(Code)(Java Doc)
public void focus()(Code)(Java Doc)
native public void focus(boolean selectText)(Code)(Java Doc)
native public void focus(boolean selectText, int delay)(Code)(Java Doc)
public Element getApplyTo()(Code)(Java Doc)
protected String getAttribute(String attribute)(Code)(Java Doc)
protected boolean getAttributeAsBoolean(String attribute)(Code)(Java Doc)
protected float getAttributeAsFloat(String attribute)(Code)(Java Doc)
protected int getAttributeAsInt(String attribute)(Code)(Java Doc)
protected JavaScriptObject getAttributeAsJavaScriptObject(String attribute)(Code)(Java Doc)
public boolean getAutoShow()(Code)(Java Doc)
public String getCls()(Code)(Java Doc)
native protected static JavaScriptObject getComponentJS(String id)(Code)(Java Doc)
public JavaScriptObject getConfig()(Code)(Java Doc)
abstract protected JavaScriptObject getConfigPrototype()(Code)(Java Doc)
public String getCtCls()(Code)(Java Doc)
public String getDisabledClass()(Code)(Java Doc)
native public ExtElement getEl()(Code)(Java Doc)
native protected Element getElement(JavaScriptObject jsObj)(Code)(Java Doc)
public Element getElement()(Code)(Java Doc)
public String getHideMode()(Code)(Java Doc)
public boolean getHideParent()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
native public String getItemId()(Code)(Java Doc)
public JavaScriptObject getJsObj()(Code)(Java Doc)
public int getOffsetHeight()(Code)(Java Doc)
public int getOffsetWidth()(Code)(Java Doc)
public JavaScriptObject getOrCreateJsObj()(Code)(Java Doc)
native public Container getOwnerContainer()(Code)(Java Doc)
public Element getRenderTo()(Code)(Java Doc)
public String[] getStateEvents()(Code)(Java Doc)
public String getStateId()(Code)(Java Doc)
public String getStyle()(Code)(Java Doc)
protected Element getStyleElement()(Code)(Java Doc)
public String getTitle()(Code)(Java Doc)
public String getXType()(Code)(Java Doc)
native public String getXTypes()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public void hide()(Code)(Java Doc)
protected void initComponent()(Code)(Java Doc)
public boolean isCreated()(Code)(Java Doc)
public boolean isDisabled()(Code)(Java Doc)
public boolean isHidden()(Code)(Java Doc)
native public boolean isRendered()(Code)(Java Doc)
native public boolean isVisible()(Code)(Java Doc)
native public boolean isXType(String xtype)(Code)(Java Doc)
native public boolean isXType(String xtype, boolean shallow)(Code)(Java Doc)
protected void onDestroy()(Code)(Java Doc)
native public void removeClass(String cls)(Code)(Java Doc)
native public void render(String id)(Code)(Java Doc)
native public void render(String id, String position)(Code)(Java Doc)
native public void render(String id, int position)(Code)(Java Doc)
native public void render(Element element)(Code)(Java Doc)
native public void render(Element element, String position)(Code)(Java Doc)
native public void render(Element element, int position)(Code)(Java Doc)
public void setApplyTo(Element element) throws IllegalStateException(Code)(Java Doc)
protected void setAttribute(String attribute, String value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, String value, boolean allowPostCreate, boolean allowPostRendered)(Code)(Java Doc)
protected void setAttribute(String attribute, int[] value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, int[] value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, long value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, double value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, int value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, int value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, Date value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, JavaScriptObject value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, JavaScriptObject value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, String[] value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, String[] value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, boolean value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, boolean value, boolean allowPostCreate, boolean allowPostRendered)(Code)(Java Doc)
protected void setAttribute(String attribute, Element value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, Element value, boolean allowPostCreate, boolean allowPostRendered)(Code)(Java Doc)
public void setAutoEl(String autoEl)(Code)(Java Doc)
public void setAutoShow(boolean autoShow) throws IllegalStateException(Code)(Java Doc)
public void setCls(String cls)(Code)(Java Doc)
public void setCtCls(String ctCls) throws IllegalStateException(Code)(Java Doc)
public void setDisabled(boolean disabled)(Code)(Java Doc)
public void setDisabledClass(String disabledClass)(Code)(Java Doc)
public void setEl(Element el) throws IllegalStateException(Code)(Java Doc)
public void setEl(String elementID) throws IllegalStateException(Code)(Java Doc)
public void setHeight(String height)(Code)(Java Doc)
public void setHideMode(String hideMode)(Code)(Java Doc)
public void setHideParent(boolean hideParent) throws IllegalStateException(Code)(Java Doc)
final public void setId(String id) throws IllegalStateException(Code)(Java Doc)
public void setRenderTo(Element elem) throws IllegalStateException(Code)(Java Doc)
public void setStateEvents(String[] stateEvents) throws IllegalStateException(Code)(Java Doc)
public void setStateId(String stateId) throws IllegalStateException(Code)(Java Doc)
public void setStyle(String style) throws IllegalStateException(Code)(Java Doc)
public void setTitle(String title)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)
public void setWidth(String width)(Code)(Java Doc)
public void show()(Code)(Java Doc)
|
|
|