Class SplitPane
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasDownClickHandlers,HasMembersChangedHandlers,HasNavigationClickHandlers,HasPaneChangedHandlers,HasUpClickHandlers
- Direct Known Subclasses:
NavPanel
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:TreeGridof folders -
listPane:ListGridshowing messages in a folder -
detailPane: message detail view (perhaps aDetailViewerover anHTMLFlowor 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.
Auto-Navigation
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.
Automatic control placement
detailToolButtons allows you to define a set
of controls that are specially placed based on the deviceMode and pageOrientation. See detailToolButtons for details.
NavigationBar and ToolStrips
By default, bars are created as follows:
- in
deviceMode:"tablet"anddeviceMode"handset", thenavigationBaris always created. - in
deviceMode:"desktop", thenavigationBaris created by default only if thenavigationTitleis specified and non-empty orshowRightButtonand/orshowLeftButtonistrue, orshowNavigationBaristrue. - in
deviceMode:"desktop"anddeviceMode"tablet", thedetailToolStripis shown above thedetailPane. - in
deviceMode:"handset", thedetailToolStripis created only ifdetailToolButtonsare specified, and is placed underneath thedetailPane. -
listToolStrip- separate bar for thelistPane, only present fordeviceMode:"desktop"when alistPaneis 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDownClickHandler(DownClickHandler handler) Add a downClick handler.Add a navigationClick handler.addPaneChangedHandler(PaneChangedHandler handler) Add a paneChanged handler.addUpClickHandler(UpClickHandler handler) Add a upClick handler.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()booleanShould default history-tracking support be enabled? Iftrue, then a history management scheme utilizing History.addHistoryEntry() and History.registerCallback() is enabled.booleanWhether to animate state changes of thenavigationBar.booleanIf set, theSplitPanewill automatically monitor selection changes in thenavigationPaneandlistPane, and callnavigateListPane()ornavigateDetailPane()when selections are changed.The most recently shown pane.Navigation control that appears only when the navigation pane is not showing (showing detail pane on handset, or portrait mode on tablet).The right-hand of the two panes managed by this widget, used for viewing details.Default value chosen fordetailPaneTitlewhennavigateDetailPane()is called.The title for thedetailPane.Canvas[]detailToolButtonsallows you to specify a set of controls that are specially placed based on thedeviceModeandpageOrientation.Toolstrip servicing thedetailPane.UI layout mode used for thisSplitPane.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.An optional list pane displayed in the left-hand of the panes or in a side panel according to the pane layout.Default value chosen forlistPaneTitlewhennavigateListPane()is called.The title for thelistPane.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.An arbitrary widget that is visible in all configurations when thecurrentPaneisCurrentPane.NAVIGATION(it may also be visible when thecurrentPaneisCurrentPane.LISTorCurrentPane.DETAIL).intSets a size for the navigation pane.Sets a size for the navigation pane.The title for thenavigationPane, displayed in thenavigationBarand also used for the title of a back button in some configurations.booleanWhether or not to callSplitPane.navigationClick(), if present, after navigation has already occurred.static SplitPanegetOrCreateRef(JavaScriptObject jsObj) CurrentPageOrientation.Note: This is a Layout property which is inapplicable on this class.If set tofalse, thedetailToolStripwill not be shown.booleanShould theleftButtonbe shown in thenavigation bar?If set tofalse, thelistToolStripwill not be shown.If true, aMiniNavControlwill be shown: In thenavigationBarwhen the device mode isDeviceMode.HANDSETand thecurrentPaneisCurrentPane.DETAIL.If set tofalse, thenavigationBarwill not be shown.booleanIf enabled, theSplitPanewill add resize bars between thenavigationPaneanddetailPanewhen these panes are shown side-by-side, and between thelistPaneanddetailPaneindeviceMode:"desktop".booleanShould therightButtonbe shown in thenavigationBar?Note: This is a Layout property which is inapplicable on this class.voidCallsnavigatePane()with thedetailPaneas the target pane.voidnavigateDetailPane(String title) CallsnavigatePane()with thedetailPaneas the target pane.voidCallsnavigatePane()with thelistPaneas the target pane.voidnavigateListPane(String title) CallsnavigatePane()with thelistPaneas the target pane.voidCauses the target pane component to load data and update its title based on the current selection in the source pane.voidnavigatePane(CurrentPane target) voidnavigatePane(CurrentPane target, String title) voidnavigatePane(CurrentPane target, 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.setAddHistoryEntries(boolean addHistoryEntries) Should default history-tracking support be enabled? Iftrue, then a history management scheme utilizing History.addHistoryEntry() and History.registerCallback() is enabled.setAnimateNavigationBarStateChanges(boolean animateNavigationBarStateChanges) Whether to animate state changes of thenavigationBar.setAutoNavigate(boolean autoNavigate) If set, theSplitPanewill automatically monitor selection changes in thenavigationPaneandlistPane, and callnavigateListPane()ornavigateDetailPane()when selections are changed.setCurrentPane(CurrentPane currentPane) The most recently shown pane.static voidsetDefaultProperties(SplitPane splitPaneProperties) Class level method to set the default properties of this class.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).setDetailPane(Canvas detailPane) The right-hand of the two panes managed by this widget, used for viewing details.setDetailPaneTitleTemplate(String detailPaneTitleTemplate) Default value chosen fordetailPaneTitlewhennavigateDetailPane()is called.setDetailTitle(String detailTitle) The title for thedetailPane.setDetailToolButtons(Canvas... detailToolButtons) detailToolButtonsallows you to specify a set of controls that are specially placed based on thedeviceModeandpageOrientation.setDeviceMode(DeviceMode deviceMode) UI layout mode used for thisSplitPane.setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.voidsetLeftButtonTitle(String newTitle) Setter for theleftButtonTitleof thenavigationBar.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.setListPaneTitleTemplate(String listPaneTitleTemplate) Default value chosen forlistPaneTitlewhennavigateListPane()is called.setListTitle(String listTitle) The title for thelistPane.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setNavigationPane(Canvas navigationPane) An arbitrary widget that is visible in all configurations when thecurrentPaneisCurrentPane.NAVIGATION(it may also be visible when thecurrentPaneisCurrentPane.LISTorCurrentPane.DETAIL).setNavigationPaneWidth(int navigationPaneWidth) Sets a size for the navigation pane.setNavigationPaneWidth(String navigationPaneWidth) Sets a size for the navigation pane.setNavigationTitle(String navigationTitle) The title for thenavigationPane, displayed in thenavigationBarand also used for the title of a back button in some configurations.setNotifyAfterNavigationClick(boolean notifyAfterNavigationClick) Whether or not to callSplitPane.navigationClick(), if present, after navigation has already occurred.setPageOrientation(PageOrientation pageOrientation) CurrentPageOrientation.setReverseOrder(Boolean reverseOrder) Note: This is a Layout property which is inapplicable on this class.voidsetRightButtonTitle(String newTitle) Setter for therightButtonTitleof thenavigationBar.setShowDetailToolStrip(Boolean showDetailToolStrip) If set tofalse, thedetailToolStripwill not be shown.setShowLeftButton(boolean showLeftButton) Should theleftButtonbe shown in thenavigation bar?setShowListToolStrip(Boolean showListToolStrip) If set tofalse, thelistToolStripwill not be shown.setShowMiniNav(Boolean showMiniNav) If true, aMiniNavControlwill be shown: In thenavigationBarwhen the device mode isDeviceMode.HANDSETand thecurrentPaneisCurrentPane.DETAIL.setShowNavigationBar(Boolean showNavigationBar) If set tofalse, thenavigationBarwill not be shown.setShowResizeBars(boolean showResizeBars) If enabled, theSplitPanewill add resize bars between thenavigationPaneanddetailPanewhen these panes are shown side-by-side, and between thelistPaneanddetailPaneindeviceMode:"desktop".setShowRightButton(boolean showRightButton) Should therightButtonbe shown in thenavigationBar?
If this method is called after the component has been drawn/initialized: Show or hide therightButtonof thenavigationBar.setVertical(Boolean vertical) Note: This is a Layout property which is inapplicable on this class.voidCauses a transition to thedetailPane, optionally updating thedetail title.voidshowDetailPane(String detailPaneTitle) voidshowDetailPane(String detailPaneTitle, String backButtonTitle) voidshowDetailPane(String detailPaneTitle, String backButtonTitle, NavigationDirection direction) Causes a transition to thedetailPane, optionally updating thedetail title.voidCauses a transition to thelistPane, optionally updating thelist title.voidshowListPane(String listPaneTitle) voidshowListPane(String listPaneTitle, String backButtonTitle) voidshowListPane(String listPaneTitle, String backButtonTitle, NavigationDirection direction) Causes a transition to thelistPane, optionally updating thelist title.voidCauses a transition to thenavigationPane.voidshowNavigationPane(NavigationDirection direction) Causes a transition to thenavigationPane.Methods inherited from class com.smartgwt.client.widgets.layout.Layout
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, onInit_Layout, 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, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
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, 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, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, 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, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
SplitPane
public SplitPane() -
SplitPane
-
SplitPane
-
SplitPane
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
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, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
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, seeSGWTProperties.- See Also:
-
create
-
setAddHistoryEntries
Should default history-tracking support be enabled? Iftrue, 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:
- History entries are only added after
page loadand when theSplitPaneis drawn. - A history entry
is added for a pane that is hidden by
showNavigationPane(),showListPane(), orshowDetailPane()for the currentdeviceModeandpageOrientationsettings.Example 1: When
deviceModeis "desktop", all 3 panes are shown simultaneously, so no history entries are added.Example 2: When
deviceModeis "handset", callingshowDetailPane()will hide the current pane (thelistPaneif present, otherwise thenavigationPane). 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
deviceModeis "tablet", thedetailPaneis always visible, but changes to the content of thedetailPaneare transparent to theSplitPane. The application can add history entries of its own when the user causes new information to be displayed in thedetailPane.
If this method is called after the component has been drawn/initialized: Setter foraddHistoryEntries.- Parameters:
addHistoryEntries- the new setting. Default value is false- Returns:
SplitPaneinstance, for chaining setter calls
- History entries are only added after
-
getAddHistoryEntries
public boolean getAddHistoryEntries()Should default history-tracking support be enabled? Iftrue, 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:
- History entries are only added after
page loadand when theSplitPaneis drawn. - A history entry
is added for a pane that is hidden by
showNavigationPane(),showListPane(), orshowDetailPane()for the currentdeviceModeandpageOrientationsettings.Example 1: When
deviceModeis "desktop", all 3 panes are shown simultaneously, so no history entries are added.Example 2: When
deviceModeis "handset", callingshowDetailPane()will hide the current pane (thelistPaneif present, otherwise thenavigationPane). 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
deviceModeis "tablet", thedetailPaneis always visible, but changes to the content of thedetailPaneare transparent to theSplitPane. The application can add history entries of its own when the user causes new information to be displayed in thedetailPane.- Returns:
- Current addHistoryEntries value. Default value is false
- History entries are only added after
-
getBackButton
ANavigationButtonshown to the left of thetitlein thenavigationBar.In
deviceModesother than "desktop", this button is automatically created and allows transitioning back to thenavigationPane(in tablet and handset modes) or thelistPane(in handset mode). In thesedeviceModes, settingshowLeftButtonto true shows theleftButtonin addition to the automatically-created back button.When
deviceModeis "desktop", this button is never shown. SeeshowLeftButtonfor more information.This button's
titleis determined automatically by theSplitPane. SeelistTitleanddetailTitle.This component is an AutoChild named "backButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current backButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setCurrentPane
The most recently shown pane. In handsetDeviceMode, thecurrentPaneis the only pane that is actually visible to the user. In other modes more than one pane can be simultaneously visible, so thecurrentPaneis the most recent pane that was brought into view via a call tosetCurrentPane()orshowNavigationPane().The default value of
currentPaneis "navigation".
If this method is called after the component has been drawn/initialized: Reveals the pane indicated by thenewPaneparameter.This has different effects based on the
DeviceModeandPageOrientation. 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 otherDeviceModesettings.- Parameters:
currentPane- new pane to show. Default value is "navigation"- Returns:
SplitPaneinstance, for chaining setter calls
-
getCurrentPane
The most recently shown pane. In handsetDeviceMode, thecurrentPaneis the only pane that is actually visible to the user. In other modes more than one pane can be simultaneously visible, so thecurrentPaneis the most recent pane that was brought into view via a call tosetCurrentPane()orshowNavigationPane().The default value of
currentPaneis "navigation".- Returns:
- Current currentPane value. Default value is "navigation"
-
setDetailPane
The right-hand of the two panes managed by this widget, used for viewing details.
If this method is called after the component has been drawn/initialized: Sets a newdetailPaneat runtime.- Parameters:
detailPane- new detail pane for this widget. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getDetailPane
The right-hand of the two panes managed by this widget, used for viewing details.- Returns:
- Current detailPane value. Default value is null
-
setDetailPaneTitleTemplate
Default value chosen fordetailPaneTitlewhennavigateDetailPane()is called.Available variables are the same as for
listPaneTitleTemplate.
If this method is called after the component has been drawn/initialized: Sets a newdetailPaneTitleTemplateat runtime.By calling this method it is assumed you want the detail pane title to change to the new template.
- Parameters:
detailPaneTitleTemplate- new template, can use HTML to be styled. Default value is "${titleField}"- Returns:
SplitPaneinstance, for chaining setter calls- See Also:
-
getDetailPaneTitleTemplate
Default value chosen fordetailPaneTitlewhennavigateDetailPane()is called.Available variables are the same as for
listPaneTitleTemplate.- Returns:
- Current detailPaneTitleTemplate value. Default value is "${titleField}"
- See Also:
-
setDetailTitle
The title for thedetailPane.
If this method is called after the component has been drawn/initialized: Sets the title for thedetailPane.- Parameters:
detailTitle- new title for the detail pane. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls- See Also:
-
getDetailTitle
The title for thedetailPane.- Returns:
- Current detailTitle value. Default value is null
- See Also:
-
setDetailToolButtons
detailToolButtonsallows you to specify a set of controls that are specially placed based on thedeviceModeandpageOrientation. This is generally useful for a compact strip ofImgButtoncontrols, approximately 5 of which will fit comfortably using typically-sized icons and in the most space-constricted modes.These controls are placed as follows:
- in
deviceMode:"desktop"anddeviceMode"tablet" withpageOrientation"landscape",detailToolButtonsappear in thedetailToolStripshown above of thedetailPane. - in
deviceMode:"handset",detailToolButtonsappear in adetailToolStripunderneath the detailPane. This toolstrip is only created in "handset" mode ifdetailToolButtonsare provided. -
in
deviceMode:"tablet"andpageOrientation:"portrait",detailToolButtonsappear insplitPane.navigationBar.
If this method is called after the component has been drawn/initialized: Updates thedetailToolButtonsat runtime.- Parameters:
detailToolButtons- new controls for the toolstrip. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
- in
-
getDetailToolButtons
detailToolButtonsallows you to specify a set of controls that are specially placed based on thedeviceModeandpageOrientation. This is generally useful for a compact strip ofImgButtoncontrols, approximately 5 of which will fit comfortably using typically-sized icons and in the most space-constricted modes.These controls are placed as follows:
- in
deviceMode:"desktop"anddeviceMode"tablet" withpageOrientation"landscape",detailToolButtonsappear in thedetailToolStripshown above of thedetailPane. - in
deviceMode:"handset",detailToolButtonsappear in adetailToolStripunderneath the detailPane. This toolstrip is only created in "handset" mode ifdetailToolButtonsare provided. -
in
deviceMode:"tablet"andpageOrientation:"portrait",detailToolButtonsappear insplitPane.navigationBar.
- Returns:
- Current detailToolButtons value. Default value is null
- in
-
getDetailToolStrip
Toolstrip servicing thedetailPane.In
deviceModeDeviceMode.DESKTOPanddeviceModeDeviceMode.TABLET, thedetailToolStripis shown above thedetailPane. IndeviceModeDeviceMode.HANDSET, thedetailToolStripis created only ifdetailToolButtonsare specified, and is placed underneath thedetailPane.This component is an AutoChild named "detailToolStrip". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current detailToolStrip value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setDeviceMode
UI layout mode used for thisSplitPane.A
SplitPanecan be configured with up to 3 panes: thenavigationPane,listPaneanddetailPane. BothDeviceModeandPageOrientationinfluence the placement of these panes as follows:- "handset"
deviceMode: only a single pane is shown at a time. Not orientation sensitive - "tablet"
deviceModewithpageOrientation:"landscape": thedetailPaneis shown side by side with either thenavigationPaneorlistPane - "tablet"
deviceModewithpageOrientation:"portrait": thedetailPaneis shown only. End user navigation that would show thelistPaneornavigationPaneshows those panes on top of thedetailPane(temporarily covering part of its content) - "desktop"
deviceMode: all 3 panes are shown simultaneously. Not orientation sensitive
listPaneis optional; if not present, wherever thelistPaneis mentioned above, thenavigationPaneis shown instead.- Parameters:
deviceMode- New deviceMode value. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
- "handset"
-
getDeviceMode
UI layout mode used for thisSplitPane.A
SplitPanecan be configured with up to 3 panes: thenavigationPane,listPaneanddetailPane. BothDeviceModeandPageOrientationinfluence the placement of these panes as follows:- "handset"
deviceMode: only a single pane is shown at a time. Not orientation sensitive - "tablet"
deviceModewithpageOrientation:"landscape": thedetailPaneis shown side by side with either thenavigationPaneorlistPane - "tablet"
deviceModewithpageOrientation:"portrait": thedetailPaneis shown only. End user navigation that would show thelistPaneornavigationPaneshows those panes on top of thedetailPane(temporarily covering part of its content) - "desktop"
deviceMode: all 3 panes are shown simultaneously. Not orientation sensitive
listPaneis optional; if not present, wherever thelistPaneis mentioned above, thenavigationPaneis shown instead.- Returns:
- Current deviceMode value. Default value is null
- See Also:
- "handset"
-
setEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classLayout- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "SplitPaneEditProxy"- Returns:
SplitPaneinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classLayout- Returns:
- Current editProxyConstructor value. Default value is "SplitPaneEditProxy"
- See Also:
-
getLeftButton
An additionalNavigationButtonwhich may be shown to the left of thetitlein thenavigation bar.Important note: by default, this button has no
directionand does not fire thenavigationClicknotification. You can provide adirectionand 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.- Returns:
- Current leftButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.- See Also:
-
setListPane
An optional list pane displayed in the left-hand of the panes or in a side panel according to the pane layout.
If this method is called after the component has been drawn/initialized: Sets a newlistPaneat runtime.- Parameters:
listPane- new list pane for this widget. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getListPane
An optional list pane displayed in the left-hand of the panes or in a side panel according to the pane layout.- Returns:
- Current listPane value. Default value is null
-
setListPaneTitleTemplate
Default value chosen forlistPaneTitlewhennavigateListPane()is called.Available variables are:
- "titleField" - the value of the
DataSource.titleFieldin the selected record from thenavigationPane - "index" - position of the selected record
- "totalRows" - total number of rows in the component where the record is selected
- "record" - the entire selected Record
If this method is called after the component has been drawn/initialized: Sets a newlistPaneTitleTemplateat runtime.By calling this method it is assumed you want the list pane title to change to the new template.
- Parameters:
listPaneTitleTemplate- new template, can use HTML to be styled. Default value is "${titleField}"- Returns:
SplitPaneinstance, for chaining setter calls- See Also:
- "titleField" - the value of the
-
getListPaneTitleTemplate
Default value chosen forlistPaneTitlewhennavigateListPane()is called.Available variables are:
- "titleField" - the value of the
DataSource.titleFieldin the selected record from thenavigationPane - "index" - position of the selected record
- "totalRows" - total number of rows in the component where the record is selected
- "record" - the entire selected Record
- Returns:
- Current listPaneTitleTemplate value. Default value is "${titleField}"
- See Also:
- "titleField" - the value of the
-
setListTitle
The title for thelistPane.
If this method is called after the component has been drawn/initialized: Sets the title for thelistPane.- Parameters:
listTitle- new title for the list pane. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls- See Also:
-
getListTitle
The title for thelistPane.- Returns:
- Current listTitle value. Default value is null
- See Also:
-
getListToolStrip
Bar displayed above thelistPane, if alistPaneis present, only fordeviceMode"desktop".This component is an AutoChild named "listToolStrip". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current listToolStrip value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setPageOrientation
CurrentPageOrientation. The default behavior of theSplitPaneis to register for orientation change notifications from the device (seePage.getOrientation()) and automatically change orientation based on thetype of device.You can instead set a specific value for
pageOrientationif 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. Passnullto return to responding automatically to device orientation.See
PageOrientationfor details of how page orientation affects layout.- Parameters:
pageOrientation- new orientation to use. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getPageOrientation
CurrentPageOrientation. The default behavior of theSplitPaneis to register for orientation change notifications from the device (seePage.getOrientation()) and automatically change orientation based on thetype of device.You can instead set a specific value for
pageOrientationif you only want to use a specific layout, and not respond to orientation information from the device.- Returns:
- Current pageOrientation value. Default value is null
-
setReverseOrder
Note: This is a Layout property which is inapplicable on this class. A SplitPane always works from left to right.- Overrides:
setReverseOrderin classLayout- Parameters:
reverseOrder- New reverseOrder value. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getReverseOrder
Note: This is a Layout property which is inapplicable on this class. A SplitPane always works from left to right.- Overrides:
getReverseOrderin classLayout- Returns:
- Current reverseOrder value. Default value is null
-
setShowDetailToolStrip
If set tofalse, thedetailToolStripwill not be shown. Otherwise, thedetailToolStripwill be shown if either thedeviceModeis notDeviceMode.HANDSETordetailToolButtonsare specified.
If this method is called after the component has been drawn/initialized: Setter forshowDetailToolStrip. Note: If the property is setfalseafter thedetailToolStripautochild has already been created, it will be hidden but not destroyed.- Parameters:
showDetailToolStrip- new value. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getShowDetailToolStrip
If set tofalse, thedetailToolStripwill not be shown. Otherwise, thedetailToolStripwill be shown if either thedeviceModeis notDeviceMode.HANDSETordetailToolButtonsare specified.- Returns:
- Current showDetailToolStrip value. Default value is null
-
setShowLeftButton
Should theleftButtonbe shown in thenavigation bar?When set to true, the
leftButtonis displayed to the left of thenavigationTitle, and to the right of thebackButton, whendeviceModeis not "desktop".
If this method is called after the component has been drawn/initialized: Show or hide theleftButtonin the navigation bar.- Parameters:
showLeftButton- iftrue, theleftButtonwill be shown, otherwise hidden. Default value is false- Returns:
SplitPaneinstance, for chaining setter calls- See Also:
-
com.smartgwt.client.widgets.layout.SplitPane#setLeftButtoncom.smartgwt.client.widgets.layout.SplitPane#setBackButton
-
getShowLeftButton
public boolean getShowLeftButton()Should theleftButtonbe shown in thenavigation bar?When set to true, the
leftButtonis displayed to the left of thenavigationTitle, and to the right of thebackButton, whendeviceModeis not "desktop".- Returns:
- Current showLeftButton value. Default value is false
- See Also:
-
setShowListToolStrip
If set tofalse, thelistToolStripwill not be shown. Otherwise, thelistToolStripwill be shown if thedeviceModeisDeviceMode.DESKTOPand alistPaneis provided.
If this method is called after the component has been drawn/initialized: Setter forshowListToolStrip. Note: If the property is setfalseafter thedetailToolStripautochild has already been created, it will be hidden but not destroyed.- Parameters:
showListToolStrip- new value. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getShowListToolStrip
If set tofalse, thelistToolStripwill not be shown. Otherwise, thelistToolStripwill be shown if thedeviceModeisDeviceMode.DESKTOPand alistPaneis provided.- Returns:
- Current showListToolStrip value. Default value is null
-
setShowResizeBars
If enabled, theSplitPanewill add resize bars between thenavigationPaneanddetailPanewhen these panes are shown side-by-side, and between thelistPaneanddetailPaneindeviceMode:"desktop".- Parameters:
showResizeBars- New showResizeBars value. Default value is true- Returns:
SplitPaneinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowResizeBars
public boolean getShowResizeBars()If enabled, theSplitPanewill add resize bars between thenavigationPaneanddetailPanewhen these panes are shown side-by-side, and between thelistPaneanddetailPaneindeviceMode:"desktop".- Returns:
- Current showResizeBars value. Default value is true
-
setShowRightButton
Should therightButtonbe shown in thenavigationBar?
If this method is called after the component has been drawn/initialized: Show or hide therightButtonof thenavigationBar.- Parameters:
showRightButton- iftrue, the button will be shown, otherwise hidden. Default value is false- Returns:
SplitPaneinstance, for chaining setter calls
-
getShowRightButton
public boolean getShowRightButton()Should therightButtonbe shown in thenavigationBar?- Returns:
- Current showRightButton value. Default value is false
-
setVertical
Note: This is a Layout property which is inapplicable on this class.- Overrides:
setVerticalin classLayout- Parameters:
vertical- New vertical value. Default value is null- Returns:
SplitPaneinstance, for chaining setter calls
-
getVertical
Note: This is a Layout property which is inapplicable on this class.- Overrides:
getVerticalin classLayout- Returns:
- Current vertical value. Default value is null
-
addDownClickHandler
Add a downClick handler.Notification method fired when the
miniNav is showingand the down button on thenavigationBar'sMiniNavControlis clicked.- Specified by:
addDownClickHandlerin interfaceHasDownClickHandlers- Parameters:
handler- the downClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addPaneChangedHandler
Add a paneChanged handler.Notification fired when the
SplitPane.currentPanechanges, either due to end-user action or due to a programmatic call tosetCurrentPane()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
SplitPaneis not drawn.- Specified by:
addPaneChangedHandlerin interfaceHasPaneChangedHandlers- Parameters:
handler- the paneChanged handler- Returns:
HandlerRegistrationused to remove this handler
-
setLeftButtonTitle
Setter for theleftButtonTitleof thenavigationBar.- Parameters:
newTitle- new title for the left button. SeeHTMLString- See Also:
-
setRightButtonTitle
Setter for therightButtonTitleof thenavigationBar.- Parameters:
newTitle- new title for the right button. SeeHTMLString- See Also:
-
showDetailPane
public void showDetailPane()Causes a transition to thedetailPane, optionally updating thedetail title.If, based on the
deviceModeandpageOrientation, this causes thenavigationPaneorlistPaneto be hidden, theback buttonwill be updated with the current title of thenavigationPaneorlistPane, or thebackButtonTitlepassed to this method. WhenaddHistoryEntriesis enabled andbackButtonTitleis passed, thenbackButtonTitlewill be used for the back button title if the user goes back to thedetailPane. -
showDetailPane
- See Also:
-
showDetailPane
- See Also:
-
showListPane
public void showListPane()Causes a transition to thelistPane, optionally updating thelist title.If, based on the
deviceModeandpageOrientation, this causes thenavigationPaneto be hidden, theback buttonwill be updated with the current title of thenavigationPane, or thebackButtonTitlepassed to this method. WhenaddHistoryEntriesis enabled andbackButtonTitleis passed, thenbackButtonTitlewill be used for the back button title if the user goes back to thelistPane. -
showListPane
- See Also:
-
showListPane
- See Also:
-
addUpClickHandler
Add a upClick handler.Notification method fired when the
miniNav is showingand the up button on thenavigationBar'sMiniNavControlis clicked.- Specified by:
addUpClickHandlerin interfaceHasUpClickHandlers- Parameters:
handler- the upClick handler- Returns:
HandlerRegistrationused to remove this handler
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.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.
- Parameters:
splitPaneProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classLayout
-