|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.layout.Layout
com.smartgwt.client.widgets.layout.VLayout
com.smartgwt.client.widgets.layout.SplitPane
public class SplitPane
A device- and orientation-sensitive layout that implements the common pattern of rendering two panes side-by-side on desktop devices and tablets (eg iPad) in landscape orientation, while switching to showing a single pane for handset-sized devices or tablets in portrait orientation.
The SplitPane's main components are the navigationPane and the detailPane. Both components will be displayed side by side
as columns when viewed on a desktop device or a tablet in landscape mode.
Only one pane will be shown at a time when
viewed on a handset sized device (such as iPhone), or a tablet in portrait orientation. By default the detailPane is shown, and the showNavigationPane / showDetailPane methods may be called to switch between
views.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
| Field Summary |
|---|
| Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
|---|
config, configOnly, id, isElementSet, scClassName |
| Fields inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
DEBUG_ID_PREFIX |
| Constructor Summary | |
|---|---|
SplitPane()
|
|
SplitPane(JavaScriptObject jsObj)
|
|
| Method Summary | |
|---|---|
protected JavaScriptObject |
create()
|
Canvas |
getDetailNavigationControl()
Navigation control that appears only when the navigation pane is not showing (showing detail pane on handset, or portrait mode on tablet). |
Canvas |
getDetailPane()
The right-hand of the two panes managed by this widget, used for viewing details. |
Canvas[] |
getDetailToolButtons()
Tool buttons to display in the detail detailToolStrip. |
Canvas |
getListPane()
An optional list pane displayed in the left-hand of the panes or in a popup according to the pane layout. |
NavigationBar |
getNavigationBar()
The AutoChild navigationBar managed by this widget. |
Canvas |
getNavigationPane()
The left-hand of the two panes managed by this widget, used for navigation. |
static SplitPane |
getOrCreateRef(JavaScriptObject jsObj)
|
static void |
setDefaultProperties(SplitPane splitPaneProperties)
Class level method to set the default properties of this class. |
void |
setDetailNavigationControl(Canvas detailNavigationControl)
Navigation control that appears only when the navigation pane is not showing (showing detail pane on handset, or portrait mode on tablet). |
void |
setDetailPane(Canvas detailPane)
The right-hand of the two panes managed by this widget, used for viewing details. |
void |
setDetailTitle(String title)
Sets the title for the Detail Pane. |
void |
setDetailToolButtons(Canvas... detailToolButtons)
Tool buttons to display in the detail detailToolStrip. |
void |
setLeftButtonIcon(String newIcon)
Setter for LeftButtonIcon. |
void |
setLeftButtonTitle(String newTitle)
Setter for leftButtonTitle. |
void |
setListPane(Canvas listPane)
An optional list pane displayed in the left-hand of the panes or in a popup according to the pane layout. |
void |
setListTitle(String title)
Sets the title for the List Pane. |
void |
setNavigationBar(NavigationBar navigationBar)
The AutoChild navigationBar managed by this widget. |
void |
setNavigationClickHandler(NavigationClickHandler handler)
Handler to fire when the user navigates by clicking the back or forward (left / right) buttons. |
void |
setNavigationPane(Canvas navigationPane)
The left-hand of the two panes managed by this widget, used for navigation. |
void |
setNavigationTitle(String title)
Sets the title for the Navigation Pane. |
void |
setRightButtonIcon(String newIcon)
Setter for rightButtonIcon. |
void |
setRightButtonTitle(String newTitle)
Setter for rightButtonTitle |
void |
setShowLeftButton(boolean visible)
Show or hide the leftButton. |
void |
setShowRightButton(boolean visible)
Show or hide the rightButton. |
void |
showDetailPane()
Causes a transition to the Detail Pane |
void |
showListPane()
Causes a transition to the List Pane |
void |
showNavigationPane()
Causes a transition to the Navigation Pane |
| Methods inherited from class com.smartgwt.client.widgets.layout.VLayout |
|---|
setDefaultProperties |
| Methods inherited from class com.google.gwt.user.client.ui.Widget |
|---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
| Methods inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
|---|
fireEvent |
| Constructor Detail |
|---|
public SplitPane()
public SplitPane(JavaScriptObject jsObj)
| Method Detail |
|---|
public static SplitPane getOrCreateRef(JavaScriptObject jsObj)
protected JavaScriptObject create()
create in class VLayoutpublic void setDetailNavigationControl(Canvas detailNavigationControl)
Note : This is an advanced setting
detailNavigationControl - detailNavigationControl Default value is nullpublic Canvas getDetailNavigationControl()
public void setDetailPane(Canvas detailPane)
detailPane - new detail pane for this widget. Default value is nullpublic Canvas getDetailPane()
public void setDetailToolButtons(Canvas... detailToolButtons)
detailToolStrip.
detailToolButtons at runtime
detailToolButtons - new controls for the toolstrip. Default value is nullpublic Canvas[] getDetailToolButtons()
detailToolStrip.
public void setListPane(Canvas listPane)
listPane - new list pane for this widget. Default value is nullpublic Canvas getListPane()
public void setNavigationBar(NavigationBar navigationBar)
throws IllegalStateException
navigationBar managed by this widget.
navigationBar - navigationBar Default value is null
IllegalStateException - this property cannot be changed after the component has been createdpublic NavigationBar getNavigationBar()
navigationBar managed by this widget.
public void setNavigationPane(Canvas navigationPane)
navigationPane - new navigation pane. Default value is nullpublic Canvas getNavigationPane()
public void setDetailTitle(String title)
title - new title for the detail panepublic void setLeftButtonIcon(String newIcon)
LeftButtonIcon.
newIcon - new icon for Left buttonpublic void setLeftButtonTitle(String newTitle)
leftButtonTitle. Note that this
is normally automatically set to the navigationPaneTitle or listPaneTitle as appropriate.
newTitle - new title for left buttonpublic void setListTitle(String title)
title - new title for the list panepublic void setNavigationTitle(String title)
title - new title for the navigation panepublic void setRightButtonIcon(String newIcon)
rightButtonIcon.
newIcon - new icon for right buttonpublic void setRightButtonTitle(String newTitle)
rightButtonTitle
newTitle - new title for right buttonpublic void setShowLeftButton(boolean visible)
leftButton. Note that the
default behavior is to automatically create and show a "back button" as the left button that allows transitioning back
to the navigationPane (tablet and handset mode) or the listPane (handset mode).
visible - if true, the button will be shown, otherwise hidden.public void setShowRightButton(boolean visible)
rightButton.
visible - if true, the button will be shown, otherwise hidden.public void showDetailPane()
public void showListPane()
public void showNavigationPane()
public static void setDefaultProperties(SplitPane splitPaneProperties)
Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.
splitPaneProperties - properties that should be used as new defaults when instances of this class are createdpublic void setNavigationClickHandler(NavigationClickHandler handler)
handler -
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||