Class Shuttle
- 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,HasMembersChangedHandlers
-
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 TypeMethodDescriptionstatic 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.voidDeselect all currently selected recordsvoidclearSelection(boolean fireSelectionChanged) Deselect all currently selected recordsprotected JavaScriptObjectcreate()voiddeselectRecords(ListGridRecord[] records) Programmatically deselect a set of records that are currently selected and displayed in the target grid.voiddeselectRecords(ListGridRecord[] records, boolean fireSelectionChanged) Programmatically deselect a set of records that are currently selected and displayed in the target grid.DataSource for this shuttle's data set.ImgButton for deselecting the full set of selected data in the shuttle.Height for thedeselectAllButtonIcon for thedeselectAllButtonWidth for thedeselectAllButtonImgButton for deselecting a single recordHeight for thedeselectButtonIcon for thedeselectButtonWidth for thedeselectButtonOperationIdfor fetching records from the shuttle'sDataSource.Fields for thesourceGridandtargetGrid.DSRequest configuration for retrieving records from this shuttle's dataSource.Implicit criteria for retrieving records from this shuttle's dataSource.Warning to display when the user attempts toselect allrecords from apartially loadeddata set.Initial sort specifiersfor this item's list of options.This attribute will be set to true for any loading placeholder records returned bygetSelectedRecords()Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static ShuttlegetOrCreateRef(JavaScriptObject jsObj) ImgButton for selecting the full set of data in the shuttle.Height for theselectAllButtonIcon for theselectAllButtonWidth for theselectAllButtonImgButton for selecting a single recordHeight for theselectButtonIcon for theselectButtonWidth for theselectButtonA shuttle may be initialized with a set of selected records viasetSelectedRecords()before the shuttle has been created.String[]Initial selected values for the shuttle.int[]Initial selected values for the shuttle.Sort directionfor this item's list of options.Sort fieldfor this item's list of options.Sort fieldfor this item's list of options.String[]Sort fieldfor this item's list of options.List grid containing the (unselected) set of records.Title for the source grid, shown as aCanvas.groupTitleList grid containing the selected set of records.Title for the target grid, shown as aCanvas.groupTitleTextMatchStyle for retrieving records from this shuttle's dataSource.This field is expected to be unique for records within the shuttle's data set.Returns thevalueFieldfor this shuttlevoidNotification method fired when records are selected or unselected in this shuttle.voidselectRecords(ListGridRecord[] records) Programmatically select a set of records from this shuttle's dataSource.voidselectRecords(ListGridRecord[] records, boolean fireSelectionChanged) Programmatically select a set of records from this shuttle's dataSource.List of options for this shuttle.setDataSource(DataSource dataSource) DataSource for this shuttle's data set.static voidsetDefaultProperties(Shuttle shuttleProperties) Class level method to set the default properties of this class.setDeselectAllButtonHeight(Integer deselectAllButtonHeight) Height for thedeselectAllButtonsetDeselectAllButtonIcon(String deselectAllButtonIcon) Icon for thedeselectAllButtonsetDeselectAllButtonWidth(Integer deselectAllButtonWidth) Width for thedeselectAllButtonsetDeselectButtonHeight(Integer deselectButtonHeight) Height for thedeselectButtonsetDeselectButtonIcon(String deselectButtonIcon) Icon for thedeselectButtonsetDeselectButtonWidth(Integer deselectButtonWidth) Width for thedeselectButtonsetFetchOperation(String fetchOperation) OperationIdfor fetching records from the shuttle'sDataSource.setFields(ListGridField... fields) Fields for thesourceGridandtargetGrid.setFilterContext(DSRequest filterContext) DSRequest configuration for retrieving records from this shuttle's dataSource.setImplicitCriteria(Criteria implicitCriteria) Implicit criteria for retrieving records from this shuttle's dataSource.setIncompleteDataWarning(String incompleteDataWarning) Warning to display when the user attempts toselect allrecords from apartially loadeddata set.setInitialSort(SortSpecifier... initialSort) Initial sort specifiersfor this item's list of options.setLoadingPlaceholderAttribute(String loadingPlaceholderAttribute) This attribute will be set to true for any loading placeholder records returned bygetSelectedRecords()Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setSelectAllButtonHeight(Integer selectAllButtonHeight) Height for theselectAllButtonsetSelectAllButtonIcon(String selectAllButtonIcon) Icon for theselectAllButtonsetSelectAllButtonWidth(Integer selectAllButtonWidth) Width for theselectAllButtonsetSelectButtonHeight(Integer selectButtonHeight) Height for theselectButtonsetSelectButtonIcon(String selectButtonIcon) Icon for theselectButtonsetSelectButtonWidth(Integer selectButtonWidth) Width for theselectButtonvoidsetSelectedByValue(int[] value, Boolean selected) Method to add or remove records from the current selection where thevalueFieldmatches the values passed in.voidsetSelectedByValue(String[] value, Boolean selected) Method to add or remove records from the current selection where thevalueFieldmatches the values passed in.setSelectedRecords(ListGridRecord selectedRecords) A shuttle may be initialized with a set of selected records viasetSelectedRecords()before the shuttle has been created.setSelectedValues(int... selectedValues) Initial selected values for the shuttle.setSelectedValues(String... selectedValues) Initial selected values for the shuttle.setSortDirection(SortDirection sortDirection) Sort directionfor this item's list of options.setSortField(Integer sortField) Sort fieldfor this item's list of options.setSortField(String sortField) Sort fieldfor this item's list of options.setSortField(String... sortField) Sort fieldfor this item's list of options.setSourceGridTitle(String sourceGridTitle) Title for the source grid, shown as aCanvas.groupTitlesetTargetGridTitle(String targetGridTitle) Title for the target grid, shown as aCanvas.groupTitlesetTextMatchStyle(TextMatchStyle textMatchStyle) TextMatchStyle for retrieving records from this shuttle's dataSource.setValueField(String valueField) This field is expected to be unique for records within the shuttle's data set.booleanNotification method fired when a fetch to retrieve records for an array of values passed tosetSelectedByValue()is complete.booleanReturns true if this shuttle is currently fetching record(s) associated with values passed tosetSelectedByValue()booleanvaluesFetchInProgress(Object value) Returns true if this shuttle is currently fetching record(s) associated with values passed tosetSelectedByValue()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, getEditProxyConstructor, 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, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, 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, 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
-
Shuttle
public Shuttle() -
Shuttle
-
-
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
-
getControlBar
VLayout autoChild holding theselectAllButton,selectButton,deselectButtonanddeselectAllButtonThis component is an AutoChild named "controlBar". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current controlBar value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setData
List of options for this shuttle.Note that a shuttle must have either a data object or a dataSource specified
- Parameters:
data- New data value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setDataSource
DataSource for this shuttle's data set. The list of options will be fetched from this dataSource unless an explicitdataobject was also provided.Note that a shuttle must have either a dataSource or data object.
- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDataSource
DataSource for this shuttle's data set. The list of options will be fetched from this dataSource unless an explicitdataobject was also provided.Note that a shuttle must have either a dataSource or data object.
- Returns:
- Current dataSource value. Default value is null
-
getDeselectAllButton
ImgButton for deselecting the full set of selected data in the shuttle.This component is an AutoChild named "deselectAllButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current deselectAllButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setDeselectAllButtonHeight
public Shuttle setDeselectAllButtonHeight(Integer deselectAllButtonHeight) throws IllegalStateException Height for thedeselectAllButton- Parameters:
deselectAllButtonHeight- New deselectAllButtonHeight value. Default value is 22- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDeselectAllButtonHeight
Height for thedeselectAllButton- Returns:
- Current deselectAllButtonHeight value. Default value is 22
-
setDeselectAllButtonIcon
Icon for thedeselectAllButton- Parameters:
deselectAllButtonIcon- New deselectAllButtonIcon value. Default value is "[SKINIMG]TransferIcons/left_all.png"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getDeselectAllButtonIcon
Icon for thedeselectAllButton- Returns:
- Current deselectAllButtonIcon value. Default value is "[SKINIMG]TransferIcons/left_all.png"
- See Also:
-
setDeselectAllButtonWidth
public Shuttle setDeselectAllButtonWidth(Integer deselectAllButtonWidth) throws IllegalStateException Width for thedeselectAllButton- Parameters:
deselectAllButtonWidth- New deselectAllButtonWidth value. Default value is 24- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDeselectAllButtonWidth
Width for thedeselectAllButton- Returns:
- Current deselectAllButtonWidth value. Default value is 24
-
getDeselectButton
ImgButton for deselecting a single recordThis component is an AutoChild named "deselectButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current deselectButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setDeselectButtonHeight
Height for thedeselectButton- Parameters:
deselectButtonHeight- New deselectButtonHeight value. Default value is 22- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDeselectButtonHeight
Height for thedeselectButton- Returns:
- Current deselectButtonHeight value. Default value is 22
-
setDeselectButtonIcon
Icon for thedeselectButton- Parameters:
deselectButtonIcon- New deselectButtonIcon value. Default value is "[SKINIMG]TransferIcons/left.png"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getDeselectButtonIcon
Icon for thedeselectButton- Returns:
- Current deselectButtonIcon value. Default value is "[SKINIMG]TransferIcons/left.png"
- See Also:
-
setDeselectButtonWidth
Width for thedeselectButton- Parameters:
deselectButtonWidth- New deselectButtonWidth value. Default value is 24- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDeselectButtonWidth
Width for thedeselectButton- Returns:
- Current deselectButtonWidth value. Default value is 24
-
setFetchOperation
OperationIdfor fetching records from the shuttle'sDataSource.- Parameters:
fetchOperation- New fetchOperation value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFetchOperation
OperationIdfor fetching records from the shuttle'sDataSource.- Returns:
- Current fetchOperation value. Default value is null
-
setFields
Fields for thesourceGridandtargetGrid.As with other databound components, if fields are not explicitly specified, they will be derived from the
dataSourceas describedhere- Parameters:
fields- New fields value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFields
Fields for thesourceGridandtargetGrid.As with other databound components, if fields are not explicitly specified, they will be derived from the
dataSourceas describedhere- Returns:
- Current fields value. Default value is null
-
setFilterContext
DSRequest configuration for retrieving records from this shuttle's dataSource.- Parameters:
filterContext- New filterContext value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFilterContext
DSRequest configuration for retrieving records from this shuttle's dataSource.- Returns:
- Current filterContext value. Default value is null
-
setImplicitCriteria
Implicit criteria for retrieving records from this shuttle's dataSource.These criteria may be combined with
"inSet"or"notInSet"sub criteria for thevalueFieldin order to populate the set of unselected records in thesourceGrid. They areListGrid.implicitCriteriameaning that any user-enteredfilter criteriawill be overlayed on top of these criteria.
If this method is called after the component has been drawn/initialized: Update theimplicitCriteriafor the shuttle.- Parameters:
implicitCriteria- new implicitCriteria. Default value is null- Returns:
Shuttleinstance, for chaining setter calls
-
getImplicitCriteria
Implicit criteria for retrieving records from this shuttle's dataSource.These criteria may be combined with
"inSet"or"notInSet"sub criteria for thevalueFieldin order to populate the set of unselected records in thesourceGrid. They areListGrid.implicitCriteriameaning that any user-enteredfilter criteriawill be overlayed on top of these criteria.- Returns:
- Current implicitCriteria value. Default value is null
-
setIncompleteDataWarning
Warning to display when the user attempts toselect allrecords from apartially loadeddata set.- Parameters:
incompleteDataWarning- New incompleteDataWarning value. Default value is "Unable to select all - the data set does not have all matching records loaded from the dataSource."- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getIncompleteDataWarning
Warning to display when the user attempts toselect allrecords from apartially loadeddata set.- Returns:
- Current incompleteDataWarning value. Default value is "Unable to select all - the data set does not have all matching records loaded from the dataSource."
-
setInitialSort
Initial sort specifiersfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Parameters:
initialSort- New initialSort value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getInitialSort
Initial sort specifiersfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Returns:
- Current initialSort value. Default value is null
-
setLoadingPlaceholderAttribute
public Shuttle setLoadingPlaceholderAttribute(String loadingPlaceholderAttribute) throws IllegalStateException This attribute will be set to true for any loading placeholder records returned bygetSelectedRecords()Note : This is an advanced setting
- Parameters:
loadingPlaceholderAttribute- New loadingPlaceholderAttribute value. Default value is "_isLoadingPlaceholder"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getLoadingPlaceholderAttribute
This attribute will be set to true for any loading placeholder records returned bygetSelectedRecords()- Returns:
- Current loadingPlaceholderAttribute value. Default value is "_isLoadingPlaceholder"
-
getSelectAllButton
ImgButton for selecting the full set of data in the shuttle.This component is an AutoChild named "selectAllButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current selectAllButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setSelectAllButtonHeight
Height for theselectAllButton- Parameters:
selectAllButtonHeight- New selectAllButtonHeight value. Default value is 22- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectAllButtonHeight
Height for theselectAllButton- Returns:
- Current selectAllButtonHeight value. Default value is 22
-
setSelectAllButtonIcon
Icon for theselectAllButton- Parameters:
selectAllButtonIcon- New selectAllButtonIcon value. Default value is "[SKINIMG]TransferIcons/right_all.png"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSelectAllButtonIcon
Icon for theselectAllButton- Returns:
- Current selectAllButtonIcon value. Default value is "[SKINIMG]TransferIcons/right_all.png"
- See Also:
-
setSelectAllButtonWidth
Width for theselectAllButton- Parameters:
selectAllButtonWidth- New selectAllButtonWidth value. Default value is 24- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectAllButtonWidth
Width for theselectAllButton- Returns:
- Current selectAllButtonWidth value. Default value is 24
-
getSelectButton
ImgButton for selecting a single recordThis component is an AutoChild named "selectButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current selectButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setSelectButtonHeight
Height for theselectButton- Parameters:
selectButtonHeight- New selectButtonHeight value. Default value is 22- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectButtonHeight
Height for theselectButton- Returns:
- Current selectButtonHeight value. Default value is 22
-
setSelectButtonIcon
Icon for theselectButton- Parameters:
selectButtonIcon- New selectButtonIcon value. Default value is "[SKINIMG]TransferIcons/right.png"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSelectButtonIcon
Icon for theselectButton- Returns:
- Current selectButtonIcon value. Default value is "[SKINIMG]TransferIcons/right.png"
- See Also:
-
setSelectButtonWidth
Width for theselectButton- Parameters:
selectButtonWidth- New selectButtonWidth value. Default value is 24- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectButtonWidth
Width for theselectButton- Returns:
- Current selectButtonWidth value. Default value is 24
-
setSelectedRecords
A shuttle may be initialized with a set of selected records viasetSelectedRecords()before the shuttle has been created.See also
selectedValuesfor initializing selection based on record values.To update the selection at runtime use
selectRecords()anddeselectRecords().- Parameters:
selectedRecords- New selectedRecords value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectedRecords
A shuttle may be initialized with a set of selected records viasetSelectedRecords()before the shuttle has been created.See also
selectedValuesfor initializing selection based on record values.To update the selection at runtime use
selectRecords()anddeselectRecords().- Returns:
- Returns the current set of selected records.
Note that if a user called
setSelectedByValue()for a record that was not loaded in the source list, we may not yet have a selected record for that value. SeevaluesFetchInProgress().In this case no record will be returned by this method for that record by default. The
includeLoadingPlaceholdersparameter will cause this method to also return placeholder record objects for these unloaded records, which have two properties specified - thevalueFieldvalue_isLoadingPlaceholder:true. Default value is null
-
setSelectedValues
Initial selected values for the shuttle.If specified, the shuttle will be initialized with records with matching
valueFieldbeing selected.See also
selectedRecordsfor initializing selection with specific records. If both properties are specified,selectedValueswill have no effectTo update the selection by value at runtime use
setSelectedByValue()- Parameters:
selectedValues- New selectedValues value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectedValues
Initial selected values for the shuttle.If specified, the shuttle will be initialized with records with matching
valueFieldbeing selected.See also
selectedRecordsfor initializing selection with specific records. If both properties are specified,selectedValueswill have no effectTo update the selection by value at runtime use
setSelectedByValue()- Returns:
- Returns the
valueFieldvalue from the current set of selected records.Note that if a user called
setSelectedByValue()for a record that was not loaded in the source list, we may not yet have a selected record for that value. SeevaluesFetchInProgress().The
includeUnloadedValuesparameter can be used to return values for these unloaded records. Default value is null
-
setSelectedValues
Initial selected values for the shuttle.If specified, the shuttle will be initialized with records with matching
valueFieldbeing selected.See also
selectedRecordsfor initializing selection with specific records. If both properties are specified,selectedValueswill have no effectTo update the selection by value at runtime use
setSelectedByValue()- Parameters:
selectedValues- New selectedValues value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSelectedValuesAsIntArray
public int[] getSelectedValuesAsIntArray()Initial selected values for the shuttle.If specified, the shuttle will be initialized with records with matching
valueFieldbeing selected.See also
selectedRecordsfor initializing selection with specific records. If both properties are specified,selectedValueswill have no effectTo update the selection by value at runtime use
setSelectedByValue()- Returns:
- Returns the
valueFieldvalue from the current set of selected records.Note that if a user called
setSelectedByValue()for a record that was not loaded in the source list, we may not yet have a selected record for that value. SeevaluesFetchInProgress().The
includeUnloadedValuesparameter can be used to return values for these unloaded records. Default value is null
-
setSortDirection
Sort directionfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Parameters:
sortDirection- New sortDirection value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSortDirection
Sort directionfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Returns:
- Current sortDirection value. Default value is null
-
setSortField
Sort fieldfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Parameters:
sortField- New sortField value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSortField
Sort fieldfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Returns:
- Current sortField value. Default value is null
-
setSortField
Sort fieldfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Parameters:
sortField- New sortField value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSortFieldAsStringArray
Sort fieldfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Returns:
- Current sortField value. Default value is null
-
setSortField
Sort fieldfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Parameters:
sortField- New sortField value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSortFieldAsInt
Sort fieldfor this item's list of options. Will be applied tosourceGridandtargetGrid. To specify initial sort for each grid separately, these properties may be set per grid using the standardautoChild pattern.- Returns:
- Current sortField value. Default value is null
-
getSourceGrid
List grid containing the (unselected) set of records. The user may select items by dragging them from this grid to thetargetGrid.This component is an AutoChild named "sourceGrid". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current sourceGrid value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setSourceGridTitle
Title for the source grid, shown as aCanvas.groupTitle- Parameters:
sourceGridTitle- New sourceGridTitle value. Default value is "Unselected Values"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSourceGridTitle
Title for the source grid, shown as aCanvas.groupTitle- Returns:
- Current sourceGridTitle value. Default value is "Unselected Values"
-
getTargetGrid
List grid containing the selected set of records. The user may unselect items by dragging them from this grid to thesourceGrid.This component is an AutoChild named "targetGrid". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current targetGrid value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTargetGridTitle
Title for the target grid, shown as aCanvas.groupTitle- Parameters:
targetGridTitle- New targetGridTitle value. Default value is "Selected Values"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getTargetGridTitle
Title for the target grid, shown as aCanvas.groupTitle- Returns:
- Current targetGridTitle value. Default value is "Selected Values"
-
setTextMatchStyle
TextMatchStyle for retrieving records from this shuttle's dataSource.- Parameters:
textMatchStyle- New textMatchStyle value. Default value is "substring"- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getTextMatchStyle
TextMatchStyle for retrieving records from this shuttle's dataSource.- Returns:
- Current textMatchStyle value. Default value is "substring"
-
setValueField
This field is expected to be unique for records within the shuttle's data set. If not explicitly specified thedataSource.primaryKeywill be used.May be used to
select records by valueand to retrieve the currentselected values.- Parameters:
valueField- New valueField value. Default value is null- Returns:
Shuttleinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueField
This field is expected to be unique for records within the shuttle's data set. If not explicitly specified thedataSource.primaryKeywill be used.May be used to
select records by valueand to retrieve the currentselected values.- Returns:
- Current valueField value. Default value is null
-
clearSelection
public void clearSelection()Deselect all currently selected records -
clearSelection
public void clearSelection(boolean fireSelectionChanged) Deselect all currently selected records- Parameters:
fireSelectionChanged- Fire theselectionUpdated()notification?
-
deselectRecords
Programmatically deselect a set of records that are currently selected and displayed in the target grid.- Parameters:
records- Records to deselect
-
deselectRecords
Programmatically deselect a set of records that are currently selected and displayed in the target grid.- Parameters:
records- Records to deselectfireSelectionChanged- Fire theselectionUpdated()notification?
-
getValueFieldName
Returns thevalueFieldfor this shuttle- Returns:
- value field name
-
selectionUpdated
public void selectionUpdated()Notification method fired when records are selected or unselected in this shuttle.Use
getSelectedRecords()orgetSelectedValues()to retrieve the current selection. -
selectRecords
Programmatically select a set of records from this shuttle's dataSource. The specified records will be added to any existing selection.- Parameters:
records- Records to select
-
selectRecords
Programmatically select a set of records from this shuttle's dataSource. The specified records will be added to any existing selection.- Parameters:
records- Records to selectfireSelectionChanged- Fire theselectionUpdated()notification?
-
setSelectedByValue
Method to add or remove records from the current selection where thevalueFieldmatches the values passed in.If the source listGrid does not have a
complete data setand does not contain an entry for any of the requested values, a separate fetch request will be issued against ourDataSourceto pick up the records for the specified value(s). ThevaluesFetchInProgress()andvaluesFetchComplete()methods provide information about this fetch.- Parameters:
value- Array of values to selectselected- New selected state for the records
-
setSelectedByValue
Method to add or remove records from the current selection where thevalueFieldmatches the values passed in.If the source listGrid does not have a
complete data setand does not contain an entry for any of the requested values, a separate fetch request will be issued against ourDataSourceto pick up the records for the specified value(s). ThevaluesFetchInProgress()andvaluesFetchComplete()methods provide information about this fetch.- Parameters:
value- Array of values to selectselected- New selected state for the records
-
valuesFetchComplete
public boolean valuesFetchComplete()Notification method fired when a fetch to retrieve records for an array of values passed tosetSelectedByValue()is complete.Note that if no associated record for the specified value was found in the dataSource, this method will still fire.
- Returns:
- true if there is an outstanding values fetch
-
valuesFetchInProgress
public boolean valuesFetchInProgress()Returns true if this shuttle is currently fetching record(s) associated with values passed tosetSelectedByValue()If no explicit
valueparameter was passed, this method will return true if this shuttle has any outstanding values fetches.- Returns:
- true if there is an outstanding values fetch
-
valuesFetchInProgress
Returns true if this shuttle is currently fetching record(s) associated with values passed tosetSelectedByValue()If no explicit
valueparameter was passed, this method will return true if this shuttle has any outstanding values fetches.- Parameters:
value- if passed, this method will return true only if there is an outstanding fetch to retrieve the associated record for this specified value- Returns:
- true if there is an outstanding values fetch
-
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:
shuttleProperties- 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
-