public class SplitPane extends Layout implements HasDownClickHandlers, HasNavigationClickHandlers, HasPaneChangedHandlers, HasUpClickHandlers
A
SplitPane can manage either two or three panes — a navigationPane and the detailPane are required, and a listPane can also be provided which appears in the same place
as the navigation pane, with built-in navigation between the panes based on NavigationBar. An example of 3-pane usage would be an email application:
navigationPane: TreeGrid of folders listPane:
ListGrid showing messages in a folder detailPane: message
detail view (perhaps a DetailViewer over an HTMLFlow or similar arrangement) The placement of the panes is by default
sensitive to whether the device is detected as a handset (phone), tablet or desktop device (see DeviceMode) and to the current PageOrientation. You can
also configure a SplitPane with a fixed pageOrientation or deviceMode.
Beyond providing the panes listed above,
typical usage is simply to call showListPane() and
showDetailPane() when the SplitPane
should navigate to a new pane. For example, in an email application, clicking on a folder in the
navigationPane should cause the listPane to show messages from the folder, then
showListPane("folder name") would be called to show the listPane and give it a new
title reflecting the name of the folder.
Similarly, clicking on a message in the listPane should show
the message details in the detailPane and call showDetailPane("message title") to
reveal the detailPane and give it an appropriate title.
By default, SplitPane will analyze the controls placed in each pane and the DataSources they are bound to, and automatically navigate between panes.
For example, in a two-pane SplitPane with a ListGrid in the navigationPane and a
DynamicForm in the detailPane, both with the same DataSource, when a record is selected in the grid, DynamicForm.editRecord() will be called to populate the form,
and the detailPane will be shown.
In a 3-pane SplitPane with a TreeGrid and ListGrid in the navigationPane and
listPane respectively, if there is a 1-to-Many relation from the TreeGrid's DataSource to the ListGrid's DataSource,
ListGrid.fetchRelatedData() will be used to load
related records when tree nodes are clicked, and the listPane will be shown.
For a full description of
auto-navigation, see autoNavigate. Just set
autoNavigate to false if you don't want these behaviors.
detailToolButtons allows you to define a set
of controls that are specially placed based on the deviceMode and pageOrientation. See detailToolButtons for details.
By default, bars are created as follows:
deviceMode:"tablet" and
deviceMode "handset", the navigationBar is always created. deviceMode:"desktop", the navigationBar is created
by default only if the navigationTitle is
specified and non-empty or showRightButton
and/or showLeftButton is true,
or showNavigationBar is true.
deviceMode:"desktop" and deviceMode "tablet", the detailToolStrip is shown above the
detailPane. deviceMode:"handset", the detailToolStrip is created only
if detailToolButtons are specified, and is placed underneath the detailPane.
listToolStrip - separate bar for the
listPane, only present for deviceMode:"desktop" when a listPane is provided.
AutoChildren and hence completely optional.
You can omit them entirely, or, if you want navigation bars or tool strips but want to customize them more than the
AutoChild system allows, you can prevent the built-in bars from being created and place your own NavigationBars either inside your navigation, list or detail panes, or
outside the SplitPane as a whole. This allows you to completely customize your navigation but
still use SplitPane to handle device- and orientation-aware layout. See showNavigationBar, showListToolStrip, and showDetailToolStrip. Note that in addition to
the navigationBar, the other automatically created
bars are also instances of NavigationBar despite the "toolStrip" naming
convention. These controls will not generally contain navigation elements; the NavigationBar class is used
for consistent styling, since the navigationBar appears adjacent to the toolstrips in some modes and
orientations, so they should have the same height and styling.
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
SplitPane() |
SplitPane(Canvas navigationPane,
Canvas detailPane) |
SplitPane(Canvas navigationPane,
Canvas listPane,
Canvas detailPane) |
SplitPane(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addDownClickHandler(DownClickHandler handler)
Add a downClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addNavigationClickHandler(NavigationClickHandler handler)
Add a navigationClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addPaneChangedHandler(PaneChangedHandler handler)
Add a paneChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addUpClickHandler(UpClickHandler handler)
Add a upClick handler.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
boolean |
getAddHistoryEntries()
Should default history-tracking support be enabled? If
true, then a history management scheme utilizing
History.addHistoryEntry() and History.registerCallback() is enabled. |
boolean |
getAnimateNavigationBarStateChanges()
Whether to animate state changes of the
navigationBar. |
boolean |
getAutoNavigate()
If set, the
SplitPane will automatically monitor selection changes in the navigationPane and listPane, and call navigateListPane() or navigateDetailPane() when selections are changed. |
NavigationButton |
getBackButton()
|
CurrentPane |
getCurrentPane()
The most recently shown pane.
|
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.
|
java.lang.String |
getDetailPaneTitleTemplate()
Default value chosen for
detailPaneTitle when navigateDetailPane() is called. |
java.lang.String |
getDetailTitle()
The title for the
detailPane. |
Canvas[] |
getDetailToolButtons()
detailToolButtons allows you to specify a set of controls that are specially placed based on the deviceMode and pageOrientation. |
NavigationBar |
getDetailToolStrip()
Toolstrip servicing the
detailPane. |
DeviceMode |
getDeviceMode()
UI layout mode used for this
SplitPane. |
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
NavigationButton |
getLeftButton()
|
Canvas |
getListPane()
An optional list pane displayed in the left-hand of the panes or in a side panel according to the pane layout.
|
java.lang.String |
getListPaneTitleTemplate()
Default value chosen for
listPaneTitle when navigateListPane() is called. |
java.lang.String |
getListTitle()
The title for the
listPane. |
NavigationBar |
getListToolStrip()
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
NavigationBar |
getNavigationBar()
|
Canvas |
getNavigationPane()
An arbitrary widget that is visible in all configurations when the
currentPane is CurrentPane.NAVIGATION (it may also be visible when the currentPane is CurrentPane.LIST or CurrentPane.DETAIL). |
int |
getNavigationPaneWidth()
Sets a size for the navigation pane.
|
java.lang.String |
getNavigationPaneWidthAsString()
Sets a size for the navigation pane.
|
java.lang.String |
getNavigationTitle()
The title for the
navigationPane, displayed in
the navigationBar and also used for the title of a
back button in some configurations. |
boolean |
getNotifyAfterNavigationClick()
Whether or not to call
SplitPane.navigationClick(), if present, after navigation has already occurred. |
static SplitPane |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
PageOrientation |
getPageOrientation()
Current
PageOrientation. |
java.lang.Boolean |
getReverseOrder()
Note: This is a Layout property which is inapplicable on this class.
|
java.lang.Boolean |
getShowDetailToolStrip()
If set to
false, the detailToolStrip will not be shown. |
boolean |
getShowLeftButton()
Should the
leftButton be shown in the navigation bar? |
java.lang.Boolean |
getShowListToolStrip()
If set to
false, the listToolStrip
will not be shown. |
java.lang.Boolean |
getShowMiniNav()
If true, a
MiniNavControl will be shown: In the navigationBar when the device mode is DeviceMode.HANDSET and the currentPane is CurrentPane.DETAIL. |
java.lang.Boolean |
getShowNavigationBar()
If set to
false, the navigationBar
will not be shown. |
boolean |
getShowResizeBars()
If enabled, the
SplitPane will add resize bars between the navigationPane and detailPane when these panes are shown side-by-side, and
between the listPane and detailPane in deviceMode:"desktop". |
boolean |
getShowRightButton()
Should the
rightButton be shown in the navigationBar? |
java.lang.Boolean |
getVertical()
Note: This is a Layout property which is inapplicable on this class.
|
void |
navigateDetailPane()
Calls
navigatePane() with the detailPane as the target pane. |
void |
navigateDetailPane(java.lang.String title)
Calls
navigatePane() with the detailPane as the target pane. |
void |
navigateListPane()
Calls
navigatePane() with the listPane as the target pane. |
void |
navigateListPane(java.lang.String title)
Calls
navigatePane() with the listPane as the target pane. |
void |
navigatePane()
Causes the target pane component to load data and update its title based on the current selection in the source pane.
|
void |
navigatePane(CurrentPane target) |
void |
navigatePane(CurrentPane target,
java.lang.String title) |
void |
navigatePane(CurrentPane target,
java.lang.String title,
CurrentPane source)
Causes the target pane component to load data and update its title based on the current selection in the source pane.
|
SplitPane |
setAddHistoryEntries(boolean addHistoryEntries)
Should default history-tracking support be enabled? If
true, then a history management scheme utilizing
History.addHistoryEntry() and History.registerCallback() is enabled. |
SplitPane |
setAnimateNavigationBarStateChanges(boolean animateNavigationBarStateChanges)
Whether to animate state changes of the
navigationBar. |
SplitPane |
setAutoNavigate(boolean autoNavigate)
If set, the
SplitPane will automatically monitor selection changes in the navigationPane and listPane, and call navigateListPane() or navigateDetailPane() when selections are changed. |
SplitPane |
setCurrentPane(CurrentPane currentPane)
The most recently shown pane.
|
static void |
setDefaultProperties(SplitPane splitPaneProperties)
Class level method to set the default properties of this class.
|
SplitPane |
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).
|
SplitPane |
setDetailPane(Canvas detailPane)
The right-hand of the two panes managed by this widget, used for viewing details.
|
SplitPane |
setDetailPaneTitleTemplate(java.lang.String detailPaneTitleTemplate)
Default value chosen for
detailPaneTitle when navigateDetailPane() is called. |
SplitPane |
setDetailTitle(java.lang.String detailTitle)
The title for the
detailPane. |
SplitPane |
setDetailToolButtons(Canvas... detailToolButtons)
detailToolButtons allows you to specify a set of controls that are specially placed based on the deviceMode and pageOrientation. |
SplitPane |
setDeviceMode(DeviceMode deviceMode)
UI layout mode used for this
SplitPane. |
SplitPane |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
void |
setLeftButtonTitle(java.lang.String newTitle)
Setter for the
leftButtonTitle of the navigationBar. |
SplitPane |
setListPane(Canvas listPane)
An optional list pane displayed in the left-hand of the panes or in a side panel according to the pane layout.
|
SplitPane |
setListPaneTitleTemplate(java.lang.String listPaneTitleTemplate)
Default value chosen for
listPaneTitle when navigateListPane() is called. |
SplitPane |
setListTitle(java.lang.String listTitle)
The title for the
listPane. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.SplitPaneLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
SplitPane |
setNavigationPane(Canvas navigationPane)
An arbitrary widget that is visible in all configurations when the
currentPane is CurrentPane.NAVIGATION (it may also be visible when the currentPane is CurrentPane.LIST or CurrentPane.DETAIL). |
SplitPane |
setNavigationPaneWidth(int navigationPaneWidth)
Sets a size for the navigation pane.
|
SplitPane |
setNavigationPaneWidth(java.lang.String navigationPaneWidth)
Sets a size for the navigation pane.
|
SplitPane |
setNavigationTitle(java.lang.String navigationTitle)
The title for the
navigationPane, displayed in
the navigationBar and also used for the title of a
back button in some configurations. |
SplitPane |
setNotifyAfterNavigationClick(boolean notifyAfterNavigationClick)
Whether or not to call
SplitPane.navigationClick(), if present, after navigation has already occurred. |
SplitPane |
setPageOrientation(PageOrientation pageOrientation)
Current
PageOrientation. |
SplitPane |
setReverseOrder(java.lang.Boolean reverseOrder)
Note: This is a Layout property which is inapplicable on this class.
|
void |
setRightButtonTitle(java.lang.String newTitle)
Setter for the
rightButtonTitle of the
navigationBar. |
SplitPane |
setShowDetailToolStrip(java.lang.Boolean showDetailToolStrip)
If set to
false, the detailToolStrip will not be shown. |
SplitPane |
setShowLeftButton(boolean showLeftButton)
Should the
leftButton be shown in the navigation bar? |
SplitPane |
setShowListToolStrip(java.lang.Boolean showListToolStrip)
If set to
false, the listToolStrip
will not be shown. |
SplitPane |
setShowMiniNav(java.lang.Boolean showMiniNav)
If true, a
MiniNavControl will be shown: In the navigationBar when the device mode is DeviceMode.HANDSET and the currentPane is CurrentPane.DETAIL. |
SplitPane |
setShowNavigationBar(java.lang.Boolean showNavigationBar)
If set to
false, the navigationBar
will not be shown. |
SplitPane |
setShowResizeBars(boolean showResizeBars)
If enabled, the
SplitPane will add resize bars between the navigationPane and detailPane when these panes are shown side-by-side, and
between the listPane and detailPane in deviceMode:"desktop". |
SplitPane |
setShowRightButton(boolean showRightButton)
Should the
rightButton be shown in the navigationBar?
If this method is called after the component has been drawn/initialized: Show or hide the rightButton of the navigationBar. |
SplitPane |
setVertical(java.lang.Boolean vertical)
Note: This is a Layout property which is inapplicable on this class.
|
void |
showDetailPane()
Causes a transition to the
detailPane, optionally
updating the detail title. |
void |
showDetailPane(java.lang.String detailPaneTitle) |
void |
showDetailPane(java.lang.String detailPaneTitle,
java.lang.String backButtonTitle) |
void |
showDetailPane(java.lang.String detailPaneTitle,
java.lang.String backButtonTitle,
NavigationDirection direction)
Causes a transition to the
detailPane, optionally
updating the detail title. |
void |
showListPane()
Causes a transition to the
listPane, optionally
updating the list title. |
void |
showListPane(java.lang.String listPaneTitle) |
void |
showListPane(java.lang.String listPaneTitle,
java.lang.String backButtonTitle) |
void |
showListPane(java.lang.String listPaneTitle,
java.lang.String backButtonTitle,
NavigationDirection direction)
Causes a transition to the
listPane, optionally
updating the list title. |
void |
showNavigationPane()
Causes a transition to the
navigationPane. |
void |
showNavigationPane(NavigationDirection direction)
Causes a transition to the
navigationPane. |
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVisibleMember, setVPolicy, showMember, showMemberaddChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic SplitPane()
public SplitPane(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SplitPane getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public SplitPane setAddHistoryEntries(boolean addHistoryEntries)
true, then a history management scheme utilizing
History.addHistoryEntry() and History.registerCallback() is enabled. The history callback is registered as an additive
callback, allowing other history callbacks including the primary callback to be registered. The default history management scheme is as follows:
page load and when the SplitPane is drawn.showNavigationPane(), showListPane(), or showDetailPane() for the current deviceMode and pageOrientation settings. Example 1: When
deviceMode is "desktop", all 3 panes are shown simultaneously, so no history entries are added.
Example
2: When deviceMode is "handset", calling showDetailPane() will hide the current pane (the listPane if present, otherwise the navigationPane). A history entry is added for the pane that was hidden
The default history management
scheme can be supplemented with application-specific history management. For example, when deviceMode is
"tablet", the detailPane is always visible, but
changes to the content of the detailPane are transparent to the SplitPane. The application can
add history entries of its own when the user causes new information to be displayed in the detailPane.
If this method is called after the component has been drawn/initialized:
Setter for addHistoryEntries.
addHistoryEntries - the new setting. Default value is falseSplitPane instance, for chaining setter callspublic boolean getAddHistoryEntries()
true, then a history management scheme utilizing
History.addHistoryEntry() and History.registerCallback() is enabled. The history callback is registered as an additive
callback, allowing other history callbacks including the primary callback to be registered. The default history management scheme is as follows:
page load and when the SplitPane is drawn.showNavigationPane(), showListPane(), or showDetailPane() for the current deviceMode and pageOrientation settings. Example 1: When
deviceMode is "desktop", all 3 panes are shown simultaneously, so no history entries are added.
Example
2: When deviceMode is "handset", calling showDetailPane() will hide the current pane (the listPane if present, otherwise the navigationPane). A history entry is added for the pane that was hidden
The default history management
scheme can be supplemented with application-specific history management. For example, when deviceMode is
"tablet", the detailPane is always visible, but
changes to the content of the detailPane are transparent to the SplitPane. The application can
add history entries of its own when the user causes new information to be displayed in the detailPane.
public SplitPane setAnimateNavigationBarStateChanges(boolean animateNavigationBarStateChanges) throws java.lang.IllegalStateException
navigationBar. Enabled by default except when the browser is known to have poor animation performance.animateNavigationBarStateChanges - New animateNavigationBarStateChanges value. Default value is trueSplitPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdNavigationBar.setAnimateStateChanges(boolean)public boolean getAnimateNavigationBarStateChanges()
navigationBar. Enabled by default except when the browser is known to have poor animation performance.NavigationBar.getAnimateStateChanges()public SplitPane setAutoNavigate(boolean autoNavigate) throws java.lang.IllegalStateException
SplitPane will automatically monitor selection changes in the navigationPane and listPane, and call navigateListPane() or navigateDetailPane() when selections are changed.
If a pane is not a DataBoundComponent, but contains a component (selected via a
breadth-first search), then that inner component will be monitored for selection changes instead. In either case,
autoNavigate does nothing unless the monitored component has a valid DataSource and there is a DataSource relationship declared between panes. Note that for
Layouts, the members will be searched when looking for a component rather than the children.
Auto-navigation occurs after the recordClick() or selectionUpdated() method is called, so if you
implement these methods, your code will run first. Importantly, if your methods call fetchData(), setCriteria(), DynamicForm.editRecord() or DynamicForm.editNewRecord() on the target component,
navigation will still occur, but duplicate calls to fetch related data, set data into the target, or start editing the
record in the target will be skipped.
The selection of the pane or pane inner component for monitoring is done only
when the SplitPane is created, and when a new navigationPane or listPane is assigned, except when the SplitPane
is in edit mode (e.g. when using Reify). where the component redetection logic gets run every time a pane's widget
hierarchy changes. Changing the hierarchy under a pane at other times in a way that will affect the breadth-first
selection of an inner component may lead to unexpected behavior.
Note that only one inner component under each pane (or the pane itself) will be monitored, even if multiple inner components might satisfy the related-data requirement.
autoNavigate - New autoNavigate value. Default value is trueSplitPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getAutoNavigate()
SplitPane will automatically monitor selection changes in the navigationPane and listPane, and call navigateListPane() or navigateDetailPane() when selections are changed.
If a pane is not a DataBoundComponent, but contains a component (selected via a
breadth-first search), then that inner component will be monitored for selection changes instead. In either case,
autoNavigate does nothing unless the monitored component has a valid DataSource and there is a DataSource relationship declared between panes. Note that for
Layouts, the members will be searched when looking for a component rather than the children.
Auto-navigation occurs after the recordClick() or selectionUpdated() method is called, so if you
implement these methods, your code will run first. Importantly, if your methods call fetchData(), setCriteria(), DynamicForm.editRecord() or DynamicForm.editNewRecord() on the target component,
navigation will still occur, but duplicate calls to fetch related data, set data into the target, or start editing the
record in the target will be skipped.
The selection of the pane or pane inner component for monitoring is done only
when the SplitPane is created, and when a new navigationPane or listPane is assigned, except when the SplitPane
is in edit mode (e.g. when using Reify). where the component redetection logic gets run every time a pane's widget
hierarchy changes. Changing the hierarchy under a pane at other times in a way that will affect the breadth-first
selection of an inner component may lead to unexpected behavior.
Note that only one inner component under each pane (or the pane itself) will be monitored, even if multiple inner components might satisfy the related-data requirement.
public NavigationButton getBackButton() throws java.lang.IllegalStateException
NavigationButton shown to the left of the title in the navigationBar. In deviceModes other than "desktop", this button is
automatically created and allows transitioning back to the navigationPane (in tablet and handset modes) or the
listPane (in handset mode). In these deviceModes, setting showLeftButton to true shows the leftButton in addition to the
automatically-created back button.
When deviceMode is "desktop", this button is never shown. See showLeftButton for more information.
This button's
title is determined automatically by the SplitPane.
See listTitle and detailTitle.
This component is an AutoChild named "backButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public SplitPane setCurrentPane(CurrentPane currentPane)
DeviceMode, the currentPane is
the only pane that is actually visible to the user. In other modes more than one pane can be simultaneously visible, so
the currentPane is the most recent pane that was brought into view via a call to setCurrentPane() or showNavigationPane(). The default value of
currentPane is "navigation".
If this method is called after the component has been drawn/initialized:
Reveals the pane indicated by the newPane parameter.
This has different effects based on the DeviceMode and PageOrientation. For example, in "handset" mode, the new pane will be the only one showing. In other modes such as "desktop", this method may do nothing, but should still be called in order to ensure correct behavior with other DeviceMode settings.
currentPane - new pane to show. Default value is "navigation"SplitPane instance, for chaining setter callspublic CurrentPane getCurrentPane()
DeviceMode, the currentPane is
the only pane that is actually visible to the user. In other modes more than one pane can be simultaneously visible, so
the currentPane is the most recent pane that was brought into view via a call to setCurrentPane() or showNavigationPane(). The default value of
currentPane is "navigation".
public SplitPane setDetailNavigationControl(Canvas detailNavigationControl)
See also showMiniNav
for a way to enable a built-in control.
If this method is called after the component has been drawn/initialized:
Navigation control that appears only when the navigation pane is not showing (showing detail pane on handset, or portrait mode on tablet).
Note : This is an advanced setting
detailNavigationControl - New detailNavigationControl value. Default value is nullSplitPane instance, for chaining setter callspublic Canvas getDetailNavigationControl()
See also showMiniNav
for a way to enable a built-in control.
public SplitPane setDetailPane(Canvas detailPane)
detailPane at runtime.detailPane - new detail pane for this widget. Default value is nullSplitPane instance, for chaining setter callspublic Canvas getDetailPane()
public SplitPane setDetailPaneTitleTemplate(java.lang.String detailPaneTitleTemplate)
detailPaneTitle when navigateDetailPane() is called. Available variables
are the same as for listPaneTitleTemplate.
If this method is called after the component has been drawn/initialized:
Sets a new detailPaneTitleTemplate at runtime.
By calling this method it is assumed you want the detail pane title to change to the new template.
detailPaneTitleTemplate - new template, can use HTML to be styled. Default value is "${titleField}"SplitPane instance, for chaining setter callssetListPaneTitleTemplate(java.lang.String),
HTMLString,
SplitPane Examplepublic java.lang.String getDetailPaneTitleTemplate()
detailPaneTitle when navigateDetailPane() is called. Available variables
are the same as for listPaneTitleTemplate.
getListPaneTitleTemplate(),
HTMLString,
SplitPane Examplepublic SplitPane setDetailTitle(java.lang.String detailTitle)
detailPane.
detailPane.detailTitle - new title for the detail pane. Default value is nullSplitPane instance, for chaining setter callsHTMLStringpublic java.lang.String getDetailTitle()
detailPane.HTMLStringpublic SplitPane setDetailToolButtons(Canvas... detailToolButtons)
detailToolButtons allows you to specify a set of controls that are specially placed based on the deviceMode and pageOrientation. This is generally useful for a compact
strip of ImgButton controls, approximately 5 of which will fit comfortably using
typically-sized icons and in the most space-constricted modes. These controls are placed as follows:
deviceMode:"desktop" and deviceMode "tablet" with pageOrientation
"landscape", detailToolButtons appear in the detailToolStrip shown above of the
detailPane. deviceMode:"handset", detailToolButtons appear in a
detailToolStrip underneath the
detailPane. This toolstrip is only created in "handset" mode if detailToolButtons are provided. deviceMode:"tablet" and pageOrientation:"portrait", detailToolButtons
appear in splitPane.navigationBar. detailToolButtons at runtime.detailToolButtons - new controls for the toolstrip. Default value is nullSplitPane instance, for chaining setter callspublic Canvas[] getDetailToolButtons()
detailToolButtons allows you to specify a set of controls that are specially placed based on the deviceMode and pageOrientation. This is generally useful for a compact
strip of ImgButton controls, approximately 5 of which will fit comfortably using
typically-sized icons and in the most space-constricted modes. These controls are placed as follows:
deviceMode:"desktop" and deviceMode "tablet" with pageOrientation
"landscape", detailToolButtons appear in the detailToolStrip shown above of the
detailPane. deviceMode:"handset", detailToolButtons appear in a
detailToolStrip underneath the
detailPane. This toolstrip is only created in "handset" mode if detailToolButtons are provided. deviceMode:"tablet" and pageOrientation:"portrait", detailToolButtons
appear in splitPane.navigationBar. public NavigationBar getDetailToolStrip() throws java.lang.IllegalStateException
detailPane. In deviceMode DeviceMode.DESKTOP and deviceMode DeviceMode.TABLET, the detailToolStrip is shown above the
detailPane. In deviceMode DeviceMode.HANDSET, the detailToolStrip is created only if
detailToolButtons are specified, and is placed
underneath the detailPane.
This component is an AutoChild named "detailToolStrip". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public SplitPane setDeviceMode(DeviceMode deviceMode) throws java.lang.IllegalStateException
SplitPane. A SplitPane can be configured with up to 3 panes:
the navigationPane, listPane and detailPane. Both DeviceMode and PageOrientation influence the placement of
these panes as follows:
deviceMode: only a single pane is shown at a time. Not
orientation sensitive deviceMode with pageOrientation:"landscape": the
detailPane is shown side by side with either the navigationPane or listPane
deviceMode with pageOrientation:"portrait": the detailPane is
shown only. End user navigation that would show the listPane or navigationPane shows
those panes on top of the detailPane (temporarily covering part of its content) deviceMode: all 3 panes are shown simultaneously. Not orientation sensitive listPane is optional; if not present, wherever the listPane is mentioned above, the
navigationPane is shown instead.deviceMode - New deviceMode value. Default value is nullSplitPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic DeviceMode getDeviceMode()
SplitPane. A SplitPane can be configured with up to 3 panes:
the navigationPane, listPane and detailPane. Both DeviceMode and PageOrientation influence the placement of
these panes as follows:
deviceMode: only a single pane is shown at a time. Not
orientation sensitive deviceMode with pageOrientation:"landscape": the
detailPane is shown side by side with either the navigationPane or listPane
deviceMode with pageOrientation:"portrait": the detailPane is
shown only. End user navigation that would show the listPane or navigationPane shows
those panes on top of the detailPane (temporarily covering part of its content) deviceMode: all 3 panes are shown simultaneously. Not orientation sensitive listPane is optional; if not present, wherever the listPane is mentioned above, the
navigationPane is shown instead.public SplitPane setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy for this component when the component is
first placed into edit mode.setEditProxyConstructor in class LayouteditProxyConstructor - New editProxyConstructor value. Default value is "SplitPaneEditProxy"SplitPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSCClassNamepublic java.lang.String getEditProxyConstructor()
EditProxy for this component when the component is
first placed into edit mode.getEditProxyConstructor in class LayoutSCClassNamepublic NavigationButton getLeftButton() throws java.lang.IllegalStateException
NavigationButton which may be shown to the left of the title in the navigation bar. Important note: by default,
this button has no direction and does not fire the
navigationClick notification. You can
provide a direction and apply a click handler via the autoChild system.
This component is an AutoChild named "leftButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.getShowLeftButton(),
getBackButton()public SplitPane setListPane(Canvas listPane)
listPane at runtime.listPane - new list pane for this widget. Default value is nullSplitPane instance, for chaining setter callspublic Canvas getListPane()
public SplitPane setListPaneTitleTemplate(java.lang.String listPaneTitleTemplate)
listPaneTitle when navigateListPane() is called. Available variables are:
DataSource.titleField in the selected record from the navigationPane listPaneTitleTemplate at runtime. By calling this method it is assumed you want the list pane title to change to the new template.
listPaneTitleTemplate - new template, can use HTML to be styled. Default value is "${titleField}"SplitPane instance, for chaining setter callssetDetailPaneTitleTemplate(java.lang.String),
HTMLString,
SplitPane Examplepublic java.lang.String getListPaneTitleTemplate()
listPaneTitle when navigateListPane() is called. Available variables are:
DataSource.titleField in the selected record from the navigationPane getDetailPaneTitleTemplate(),
HTMLString,
SplitPane Examplepublic SplitPane setListTitle(java.lang.String listTitle)
listPane.
listPane.listTitle - new title for the list pane. Default value is nullSplitPane instance, for chaining setter callsHTMLStringpublic java.lang.String getListTitle()
listPane.HTMLStringpublic NavigationBar getListToolStrip() throws java.lang.IllegalStateException
listPane, if a
listPane is present, only for deviceMode "desktop".
This component is an AutoChild named "listToolStrip". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public NavigationBar getNavigationBar() throws java.lang.IllegalStateException
NavigationBar instance managed by this SplitPane that is placed above the navigationPane. The following passthroughs apply:
animateNavigationBarStateChanges
for NavigationBar.animateStateChanges
showRightButton for NavigationBar.showRightButton Note that
in deviceMode DeviceMode.DESKTOP with showNavigationBar unset, the
navigationBar is automatically hidden when it would be empty (navigationTitle is an empty string and
showRightButton and showLeftButton are both false). The
navigationBar will be shown if the navigationTitle is set to a non-empty string, or
showRightButton or showLeftButton is set to true.
This component is an AutoChild named "navigationBar". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.getShowNavigationBar()public SplitPane setNavigationPane(Canvas navigationPane)
currentPane is CurrentPane.NAVIGATION (it may also be visible when the currentPane is CurrentPane.LIST or CurrentPane.DETAIL). The
navigationPane is typically used for navigation, to initialize the content of the listPane (when using a listPane) or the detailPane. For example, in an email application the
navigationPane pane widget could be a TreeGrid of the inboxes and
folders.
If this method is called after the component has been drawn/initialized:
Update the navigationPane at runtime.
navigationPane - new navigation pane for this widget. Default value is nullSplitPane instance, for chaining setter callspublic Canvas getNavigationPane()
currentPane is CurrentPane.NAVIGATION (it may also be visible when the currentPane is CurrentPane.LIST or CurrentPane.DETAIL). The
navigationPane is typically used for navigation, to initialize the content of the listPane (when using a listPane) or the detailPane. For example, in an email application the
navigationPane pane widget could be a TreeGrid of the inboxes and
folders.
public SplitPane setNavigationPaneWidth(int navigationPaneWidth)
This size is active only on platforms where multiple panes are showing at once;
if a single pane is showing, navigationPaneWidth is ignored.
Note that setting a
navigationPaneWidth which creates more size in one of the panes may backfire on mobile, where all panes end
up having the same width (the device width). If you make one pane larger to accommodate more controls or content, make
sure you use techniques such as showing fewer columns on mobile, or using adaptive components such as AdaptiveMenu.
If you simply want side-by-side display with arbitrary proportions,
and don't care about tablet and mobile adaptation, use HLayout instead.
navigationPaneWidth - New navigationPaneWidth value. Default value is 320SplitPane instance, for chaining setter callsCanvas.setWidth(java.lang.Integer)public int getNavigationPaneWidth()
This size is active only on platforms where multiple panes are showing at once;
if a single pane is showing, navigationPaneWidth is ignored.
Note that setting a
navigationPaneWidth which creates more size in one of the panes may backfire on mobile, where all panes end
up having the same width (the device width). If you make one pane larger to accommodate more controls or content, make
sure you use techniques such as showing fewer columns on mobile, or using adaptive components such as AdaptiveMenu.
If you simply want side-by-side display with arbitrary proportions,
and don't care about tablet and mobile adaptation, use HLayout instead.
Canvas.getWidth()public SplitPane setNavigationPaneWidth(java.lang.String navigationPaneWidth)
This size is active only on platforms where multiple panes are showing at once;
if a single pane is showing, navigationPaneWidth is ignored.
Note that setting a
navigationPaneWidth which creates more size in one of the panes may backfire on mobile, where all panes end
up having the same width (the device width). If you make one pane larger to accommodate more controls or content, make
sure you use techniques such as showing fewer columns on mobile, or using adaptive components such as AdaptiveMenu.
If you simply want side-by-side display with arbitrary proportions,
and don't care about tablet and mobile adaptation, use HLayout instead.
navigationPaneWidth - New navigationPaneWidth value. Default value is 320SplitPane instance, for chaining setter callsCanvas.setWidth(java.lang.Integer)public java.lang.String getNavigationPaneWidthAsString()
This size is active only on platforms where multiple panes are showing at once;
if a single pane is showing, navigationPaneWidth is ignored.
Note that setting a
navigationPaneWidth which creates more size in one of the panes may backfire on mobile, where all panes end
up having the same width (the device width). If you make one pane larger to accommodate more controls or content, make
sure you use techniques such as showing fewer columns on mobile, or using adaptive components such as AdaptiveMenu.
If you simply want side-by-side display with arbitrary proportions,
and don't care about tablet and mobile adaptation, use HLayout instead.
Canvas.getWidth()public SplitPane setNavigationTitle(java.lang.String navigationTitle)
navigationPane, displayed in
the navigationBar and also used for the title of a
back button in some configurations.
navigationPane.navigationTitle - new title for the navigation pane. Default value is nullSplitPane instance, for chaining setter callsHTMLStringpublic java.lang.String getNavigationTitle()
navigationPane, displayed in
the navigationBar and also used for the title of a
back button in some configurations.HTMLStringpublic SplitPane setNotifyAfterNavigationClick(boolean notifyAfterNavigationClick)
SplitPane.navigationClick(), if present, after navigation has already occurred. This may be set to provide backcompat
with legacy code, as by default the Framework will call SplitPane.navigationClick() before navigation to
allow cancelation. Note that if this property is set, SplitPane.navigationClick() cannot be canceled.
notifyAfterNavigationClick - New notifyAfterNavigationClick value. Default value is falseSplitPane instance, for chaining setter callsPaneChangedEvent,
NavigationClickEventpublic boolean getNotifyAfterNavigationClick()
SplitPane.navigationClick(), if present, after navigation has already occurred. This may be set to provide backcompat
with legacy code, as by default the Framework will call SplitPane.navigationClick() before navigation to
allow cancelation. Note that if this property is set, SplitPane.navigationClick() cannot be canceled.
PaneChangedEvent,
NavigationClickEventpublic SplitPane setPageOrientation(PageOrientation pageOrientation)
PageOrientation. The default behavior of the SplitPane is to
register for orientation change notifications from the device (see Page.getOrientation()) and automatically change orientation based on the type of device. You can instead set a specific value for
pageOrientation if you only want to use a specific layout, and not respond to orientation information from
the device.
If this method is called after the component has been drawn/initialized:
Explicitly sets the page orientation to a fixed value instead of being responsive to device orientation changes. Pass null to return to responding automatically to device orientation.
See PageOrientation for details of how page orientation affects layout.
pageOrientation - new orientation to use. Default value is nullSplitPane instance, for chaining setter callspublic PageOrientation getPageOrientation()
PageOrientation. The default behavior of the SplitPane is to
register for orientation change notifications from the device (see Page.getOrientation()) and automatically change orientation based on the type of device. You can instead set a specific value for
pageOrientation if you only want to use a specific layout, and not respond to orientation information from
the device.
public SplitPane setReverseOrder(java.lang.Boolean reverseOrder)
setReverseOrder in class LayoutreverseOrder - New reverseOrder value. Default value is nullSplitPane instance, for chaining setter callspublic java.lang.Boolean getReverseOrder()
getReverseOrder in class Layoutpublic SplitPane setShowDetailToolStrip(java.lang.Boolean showDetailToolStrip)
false, the detailToolStrip will not be shown. Otherwise, the detailToolStrip will be shown if either the deviceMode is not DeviceMode.HANDSET or detailToolButtons are specified.
showDetailToolStrip. Note: If the property is set false after the detailToolStrip autochild has already been created, it will be hidden but not destroyed.showDetailToolStrip - new value. Default value is nullSplitPane instance, for chaining setter callspublic java.lang.Boolean getShowDetailToolStrip()
false, the detailToolStrip will not be shown. Otherwise, the detailToolStrip will be shown if either the deviceMode is not DeviceMode.HANDSET or detailToolButtons are specified.public SplitPane setShowLeftButton(boolean showLeftButton)
leftButton be shown in the navigation bar? When set to true, the leftButton is displayed to the left of the navigationTitle, and to the right of the backButton, when deviceMode is not "desktop".
If this method is called after the component has been drawn/initialized:
Show or hide the leftButton in the navigation bar.
showLeftButton - if true, the leftButton will be shown, otherwise hidden. Default value is falseSplitPane instance, for chaining setter callscom.smartgwt.client.widgets.layout.SplitPane#setLeftButton,
com.smartgwt.client.widgets.layout.SplitPane#setBackButtonpublic boolean getShowLeftButton()
leftButton be shown in the navigation bar? When set to true, the leftButton is displayed to the left of the navigationTitle, and to the right of the backButton, when deviceMode is not "desktop".
getLeftButton(),
getBackButton()public SplitPane setShowListToolStrip(java.lang.Boolean showListToolStrip)
false, the listToolStrip
will not be shown. Otherwise, the listToolStrip
will be shown if the deviceMode is DeviceMode.DESKTOP and a listPane is provided.
showListToolStrip. Note: If the property is set false after the detailToolStrip autochild has already been created, it will be hidden but not destroyed.showListToolStrip - new value. Default value is nullSplitPane instance, for chaining setter callspublic java.lang.Boolean getShowListToolStrip()
false, the listToolStrip
will not be shown. Otherwise, the listToolStrip
will be shown if the deviceMode is DeviceMode.DESKTOP and a listPane is provided.public SplitPane setShowMiniNav(java.lang.Boolean showMiniNav) throws java.lang.IllegalStateException
MiniNavControl will be shown: navigationBar when the device mode is DeviceMode.HANDSET and the currentPane is CurrentPane.DETAIL. detailToolStrip when the device mode is DeviceMode.TABLET and the pageOrientation is PageOrientation.PORTRAIT. showMiniNav - New showMiniNav value. Default value is falseSplitPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetDetailNavigationControl(com.smartgwt.client.widgets.Canvas)public java.lang.Boolean getShowMiniNav()
MiniNavControl will be shown: navigationBar when the device mode is DeviceMode.HANDSET and the currentPane is CurrentPane.DETAIL. detailToolStrip when the device mode is DeviceMode.TABLET and the pageOrientation is PageOrientation.PORTRAIT. getDetailNavigationControl()public SplitPane setShowNavigationBar(java.lang.Boolean showNavigationBar)
false, the navigationBar
will not be shown. If set to true, the navigationBar will always be shown, even when the
deviceMode is If this property is unset, the
navigationBar will be shown if at least one of the
following conditions holds:
deviceMode is
not DeviceMode.DESKTOP navigationTitle is specified and non-empty showRightButton and/or showLeftButton is true,showNavigationBar. Note: If the property is set false after the navigationBar autochild has already been created, it will be hidden but not destroyed.
showNavigationBar - new value. Default value is nullSplitPane instance, for chaining setter callspublic java.lang.Boolean getShowNavigationBar()
false, the navigationBar
will not be shown. If set to true, the navigationBar will always be shown, even when the
deviceMode is If this property is unset, the
navigationBar will be shown if at least one of the
following conditions holds:
deviceMode is
not DeviceMode.DESKTOP navigationTitle is specified and non-empty showRightButton and/or showLeftButton is true,public SplitPane setShowResizeBars(boolean showResizeBars) throws java.lang.IllegalStateException
SplitPane will add resize bars between the navigationPane and detailPane when these panes are shown side-by-side, and
between the listPane and detailPane in deviceMode:"desktop".showResizeBars - New showResizeBars value. Default value is trueSplitPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getShowResizeBars()
SplitPane will add resize bars between the navigationPane and detailPane when these panes are shown side-by-side, and
between the listPane and detailPane in deviceMode:"desktop".public SplitPane setShowRightButton(boolean showRightButton)
rightButton be shown in the navigationBar?
rightButton of the navigationBar.showRightButton - if true, the button will be shown, otherwise hidden. Default value is falseSplitPane instance, for chaining setter callspublic boolean getShowRightButton()
rightButton be shown in the navigationBar?public SplitPane setVertical(java.lang.Boolean vertical)
setVertical in class Layoutvertical - New vertical value. Default value is nullSplitPane instance, for chaining setter callspublic java.lang.Boolean getVertical()
getVertical in class Layoutpublic com.google.gwt.event.shared.HandlerRegistration addDownClickHandler(DownClickHandler handler)
Notification method fired when the miniNav is
showing and the down button on the navigationBar's MiniNavControl is clicked.
addDownClickHandler in interface HasDownClickHandlershandler - the downClick handlerHandlerRegistration used to remove this handlerpublic void navigateDetailPane()
navigatePane() with the detailPane as the target pane.public void navigateDetailPane(java.lang.String title)
navigatePane() with the detailPane as the target pane.title - optional title to use instead of the automatically chosen one.
See HTMLStringpublic void navigateListPane()
navigatePane() with the listPane as the target pane.public void navigateListPane(java.lang.String title)
navigatePane() with the listPane as the target pane.title - optional title to use instead of the automatically chosen one.
See HTMLStringpublic void navigatePane()
For the target pane to load data, both the source pane and
target pane must be DataBoundComponents or contain a component as a descendant
widget, and have a DataSource, and either:
DataSourceField.foreignKey, so that ListGrid.fetchRelatedData() can be used on the target pane. A common example of this would be navigation from a source
pane that's a TreeGrid to a ListGrid
target. setData(). This
would apply, for example, if the source pane is a ListGrid and the target is a
DynamicForm, so that editRecord() gets called, or if the target is a DetailViewer. search forms. If the pane is itself a search form, it will never load related data. Note that one or more
records must be selected in the source component for related data to be loaded (which should be automatically true for
auto-navigation). and only one inner pane component
(or the pane itself) will receive the related data, even if multiple inner components meet the requirements. Even if
we can't load related data into the target pane by the above rules, we'll still show the target pane if it's not already
visible, except during auto-navigation.
Defaults:
target is CurrentPane.LIST if the listPane is present, otherwise CurrentPane.DETAIL. listPaneTitleTemplate if the target pane is the
listPane, otherwise detailPaneTitleTemplate. detailPane, the default source pane is the listPane if present, otherwise the navigationPane. If the target pane is the
listPane, the source pane is always the navigationPane.public void navigatePane(CurrentPane target)
navigatePane()public void navigatePane(CurrentPane target, java.lang.String title)
navigatePane()public void navigatePane(CurrentPane target, java.lang.String title, CurrentPane source)
For the target pane to load data, both the source pane and
target pane must be DataBoundComponents or contain a component as a descendant
widget, and have a DataSource, and either:
DataSourceField.foreignKey, so that ListGrid.fetchRelatedData() can be used on the target pane. A common example of this would be navigation from a source
pane that's a TreeGrid to a ListGrid
target. setData(). This
would apply, for example, if the source pane is a ListGrid and the target is a
DynamicForm, so that editRecord() gets called, or if the target is a DetailViewer. search forms. If the pane is itself a search form, it will never load related data. Note that one or more
records must be selected in the source component for related data to be loaded (which should be automatically true for
auto-navigation). and only one inner pane component
(or the pane itself) will receive the related data, even if multiple inner components meet the requirements. Even if
we can't load related data into the target pane by the above rules, we'll still show the target pane if it's not already
visible, except during auto-navigation.
Defaults:
target is CurrentPane.LIST if the listPane is present, otherwise CurrentPane.DETAIL. listPaneTitleTemplate if the target pane is the
listPane, otherwise detailPaneTitleTemplate. detailPane, the default source pane is the listPane if present, otherwise the navigationPane. If the target pane is the
listPane, the source pane is always the navigationPane.target - pane that should navigatetitle - optional title to use for target pane. If not specified, the title is based on listPaneTitleTemplate if the target pane is the
listPane, otherwise detailPaneTitleTemplate.
See HTMLStringsource - source pane used for selectionpublic com.google.gwt.event.shared.HandlerRegistration addNavigationClickHandler(NavigationClickHandler handler)
Notification method fired when the user clicks the default back / forward buttons on the navigation bar for this
SplitPane.
Note that the return value will be ignored and cancelation won't be possible if SplitPane.notifyAfterNavigationClick has
been set true, since that forces this method to run after we've already navigated to the new pane.
addNavigationClickHandler in interface HasNavigationClickHandlershandler - the navigationClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addPaneChangedHandler(PaneChangedHandler handler)
Notification fired when the SplitPane.currentPane
changes, either due to end-user action or due to a programmatic call to setCurrentPane() or other APIs that can change the pane.
Note that depending on the DeviceMode, this event may not signal that any pane has
actually been shown or hidden, since in some modes multiple panes are shown simultaneously.
Never fires while the
SplitPane is not drawn.
addPaneChangedHandler in interface HasPaneChangedHandlershandler - the paneChanged handlerHandlerRegistration used to remove this handlerpublic void setLeftButtonTitle(java.lang.String newTitle)
leftButtonTitle of the navigationBar.newTitle - new title for the left button.
See HTMLStringHTMLStringpublic void setRightButtonTitle(java.lang.String newTitle)
rightButtonTitle of the
navigationBar.newTitle - new title for the right button.
See HTMLStringHTMLStringpublic void showDetailPane()
detailPane, optionally
updating the detail title. If, based on the
deviceMode and pageOrientation, this causes the navigationPane or listPane to be hidden, the back button will be updated with the current title of the
navigationPane or listPane, or the backButtonTitle passed to this method. When
addHistoryEntries is enabled and
backButtonTitle is passed, then backButtonTitle will be used for the back button title if the
user goes back to the detailPane.
public void showDetailPane(java.lang.String detailPaneTitle)
showDetailPane()public void showDetailPane(java.lang.String detailPaneTitle,
java.lang.String backButtonTitle)
showDetailPane()public void showDetailPane(java.lang.String detailPaneTitle,
java.lang.String backButtonTitle,
NavigationDirection direction)
detailPane, optionally
updating the detail title. If, based on the
deviceMode and pageOrientation, this causes the navigationPane or listPane to be hidden, the back button will be updated with the current title of the
navigationPane or listPane, or the backButtonTitle passed to this method. When
addHistoryEntries is enabled and
backButtonTitle is passed, then backButtonTitle will be used for the back button title if the
user goes back to the detailPane.
detailPaneTitle - optional new detail title.
See HTMLStringbackButtonTitle - optional new title for the back button.
See HTMLStringdirection - when animateNavigationBarStateChanges is true, this is the direction passed to NavigationBar.setViewState().public void showListPane()
listPane, optionally
updating the list title. If, based on the deviceMode and pageOrientation, this causes the navigationPane to be hidden, the back button will be updated with the current title of the
navigationPane, or the backButtonTitle passed to this method. When addHistoryEntries is enabled and
backButtonTitle is passed, then backButtonTitle will be used for the back button title if the
user goes back to the listPane.
public void showListPane(java.lang.String listPaneTitle)
showListPane()public void showListPane(java.lang.String listPaneTitle,
java.lang.String backButtonTitle)
showListPane()public void showListPane(java.lang.String listPaneTitle,
java.lang.String backButtonTitle,
NavigationDirection direction)
listPane, optionally
updating the list title. If, based on the deviceMode and pageOrientation, this causes the navigationPane to be hidden, the back button will be updated with the current title of the
navigationPane, or the backButtonTitle passed to this method. When addHistoryEntries is enabled and
backButtonTitle is passed, then backButtonTitle will be used for the back button title if the
user goes back to the listPane.
listPaneTitle - optional new list title.
See HTMLStringbackButtonTitle - optional new title for the back button.
See HTMLStringdirection - when animateNavigationBarStateChanges is true, this is the direction passed to NavigationBar.setViewState().public void showNavigationPane()
navigationPane.public void showNavigationPane(NavigationDirection direction)
navigationPane.direction - when animateNavigationBarStateChanges is true, this is the direction passed to NavigationBar.setViewState().public com.google.gwt.event.shared.HandlerRegistration addUpClickHandler(UpClickHandler handler)
Notification method fired when the miniNav is
showing and the up button on the navigationBar's
MiniNavControl is clicked.
addUpClickHandler in interface HasUpClickHandlershandler - the upClick handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(SplitPane splitPaneProperties)
Note: This method is intended for setting default attributes only and will affect 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. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
splitPaneProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.SplitPaneLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class Layout