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.
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 NavigationBar
s 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 . |
java.lang.Boolean |
getAutoNavigate()
If set, the
SplitPane will automatically monitor selection changes in the navigationPane or 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()
LeftLayout?s initial size
|
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. |
static SplitPane |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
PageOrientation |
getPageOrientation()
Current
PageOrientation . |
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 ? |
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.
|
void |
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. |
void |
setAnimateNavigationBarStateChanges(boolean animateNavigationBarStateChanges)
Whether to animate state changes of the
navigationBar . |
void |
setAutoNavigate(java.lang.Boolean autoNavigate)
If set, the
SplitPane will automatically monitor selection changes in the navigationPane or listPane , and call navigateListPane() or navigateDetailPane() when selections are changed. |
void |
setCurrentPane(CurrentPane currentPane)
The most recently shown pane.
|
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 |
setDetailPaneTitleTemplate(java.lang.String detailPaneTitleTemplate)
Default value chosen for
detailPaneTitle when navigateDetailPane() is called. |
void |
setDetailTitle(java.lang.String detailTitle)
The title for the
detailPane . |
void |
setDetailToolButtons(Canvas... detailToolButtons)
detailToolButtons allows you to specify a set of controls that are specially placed based on the deviceMode and pageOrientation . |
void |
setDeviceMode(DeviceMode deviceMode)
UI layout mode used for this
SplitPane . |
void |
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 . |
void |
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.
|
void |
setListPaneTitleTemplate(java.lang.String listPaneTitleTemplate)
Default value chosen for
listPaneTitle when navigateListPane() is called. |
void |
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. |
void |
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 ). |
void |
setNavigationPaneWidth(int navigationPaneWidth)
LeftLayout?s initial size
|
void |
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. |
void |
setPageOrientation(PageOrientation pageOrientation)
Current
PageOrientation . |
void |
setRightButtonTitle(java.lang.String newTitle)
Setter for the
rightButtonTitle of the
navigationBar . |
void |
setShowDetailToolStrip(java.lang.Boolean showDetailToolStrip)
If set to
false , the detailToolStrip will not be shown. |
void |
setShowLeftButton(boolean showLeftButton)
Should the
leftButton be shown in the navigation bar ? |
void |
setShowListToolStrip(java.lang.Boolean showListToolStrip)
If set to
false , the listToolStrip
will not be shown. |
void |
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 . |
void |
setShowNavigationBar(java.lang.Boolean showNavigationBar)
If set to
false , the navigationBar
will not be shown. |
void |
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" . |
void |
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 . |
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, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, 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, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
addChild, 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, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, 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, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, 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, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, 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, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeFonts, resizeIcons, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, 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, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, 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, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
addDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, 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, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
public 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
.AutoChildUsage
public 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
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public void 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 falsepublic 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 void 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 truejava.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 void setAutoNavigate(java.lang.Boolean autoNavigate) throws java.lang.IllegalStateException
SplitPane
will automatically monitor selection changes in the navigationPane
or listPane
, and call navigateListPane()
or navigateDetailPane()
when selections are changed.
If any configured panes lack DataSources or there is no DataSource relationship declared between panes,
autoNavigate
does nothing.
autoNavigate
- New autoNavigate value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoNavigate()
SplitPane
will automatically monitor selection changes in the navigationPane
or listPane
, and call navigateListPane()
or navigateDetailPane()
when selections are changed.
If any configured panes lack DataSources or there is no DataSource relationship declared between panes,
autoNavigate
does nothing.
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 void 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"public 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 void 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 nullpublic Canvas getDetailNavigationControl()
See also showMiniNav
for a way to enable a built-in control.
public void setDetailPane(Canvas detailPane)
detailPane
at runtime.detailPane
- new detail pane for this widget. Default value is nullpublic Canvas getDetailPane()
public void 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}"setListPaneTitleTemplate(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 void setDetailTitle(java.lang.String detailTitle)
detailPane
.
detailPane
.detailTitle
- new title for the detail pane. Default value is nullHTMLString
public java.lang.String getDetailTitle()
detailPane
.HTMLString
public void 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 nullpublic 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 void 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 nulljava.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 void 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 Layout
editProxyConstructor
- New editProxyConstructor value. Default value is "SplitPaneEditProxy"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCClassName
public java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.getEditProxyConstructor
in class Layout
SCClassName
public 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 void setListPane(Canvas listPane)
listPane
at runtime.listPane
- new list pane for this widget. Default value is nullpublic Canvas getListPane()
public void 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}"setDetailPaneTitleTemplate(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 void setListTitle(java.lang.String listTitle)
listPane
.
listPane
.listTitle
- new title for the list pane. Default value is nullHTMLString
public java.lang.String getListTitle()
listPane
.HTMLString
public 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 void 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 nullpublic 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 void setNavigationPaneWidth(int navigationPaneWidth) throws java.lang.IllegalStateException
navigationPaneWidth
- New navigationPaneWidth value. Default value is 320java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getNavigationPaneWidth()
public void 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 nullHTMLString
public java.lang.String getNavigationTitle()
navigationPane
, displayed in
the navigationBar
and also used for the title of a
back button in some configurations.HTMLString
public void 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 nullpublic 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 void setShowDetailToolStrip(java.lang.Boolean showDetailToolStrip) throws java.lang.IllegalStateException
false
, the detailToolStrip
will not be shown.showDetailToolStrip
- New showDetailToolStrip value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDetailToolStrip()
false
, the detailToolStrip
will not be shown.public void 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 falsecom.smartgwt.client.widgets.layout.SplitPane#setLeftButton
,
com.smartgwt.client.widgets.layout.SplitPane#setBackButton
public 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 void setShowListToolStrip(java.lang.Boolean showListToolStrip) throws java.lang.IllegalStateException
false
, the listToolStrip
will not be shown.showListToolStrip
- New showListToolStrip value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowListToolStrip()
false
, the listToolStrip
will not be shown.public void 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 falsejava.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 void setShowNavigationBar(java.lang.Boolean showNavigationBar) throws java.lang.IllegalStateException
false
, the navigationBar
will not be shown. If set to true
, the navigationBar
will always be shown, even when the
deviceMode
is DeviceMode.DESKTOP
and the navigationBar
would be empty.showNavigationBar
- New showNavigationBar value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic 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 DeviceMode.DESKTOP
and the navigationBar
would be empty.public void 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 truejava.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 void 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 falsepublic boolean getShowRightButton()
rightButton
be shown in the navigationBar
?public 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 HasDownClickHandlers
handler
- 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 HTMLString
public 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 HTMLString
public void navigatePane()
Both the source pane and target pane must have a DataSource
, and either:
DataSourceField.foreignKey
, so that ListGrid.fetchRelatedData()
can be used on the target pane.
setData()
. target
is CurrentPane.LIST
if the listPane
is present, otherwise CurrentPane.DETAIL
. The title applied to the target pane is based on listPaneTitleTemplate
if the target pane is the
listPane
, otherwise detailPaneTitleTemplate
.
The source pane usually does not need to be specified: if the target pane is the
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)
Both the source pane and target pane must have a DataSource
, and either:
DataSourceField.foreignKey
, so that ListGrid.fetchRelatedData()
can be used on the target pane.
setData()
. target
is CurrentPane.LIST
if the listPane
is present, otherwise CurrentPane.DETAIL
. The title applied to the target pane is based on listPaneTitleTemplate
if the target pane is the
listPane
, otherwise detailPaneTitleTemplate
.
The source pane usually does not need to be specified: if the target pane is the
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 HTMLString
source
- 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
.
addNavigationClickHandler
in interface HasNavigationClickHandlers
handler
- 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 HasPaneChangedHandlers
handler
- 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 HTMLString
HTMLString
public void setRightButtonTitle(java.lang.String newTitle)
rightButtonTitle
of the
navigationBar
.newTitle
- new title for the right button.
See HTMLString
HTMLString
public 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 HTMLString
backButtonTitle
- optional new title for the back button
.
See HTMLString
direction
- 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 HTMLString
backButtonTitle
- optional new title for the back button
.
See HTMLString
direction
- 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 HasUpClickHandlers
handler
- 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 createdSGWTProperties
public 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 LogicalStructure
getLogicalStructure
in class Layout