public class Shuttle extends Layout
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
Shuttle() |
Shuttle(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
void |
clearSelection()
Deselect all currently selected records
|
void |
clearSelection(boolean fireSelectionChanged)
Deselect all currently selected records
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
deselectRecords(ListGridRecord[] records)
Programmatically deselect a set of records that are currently selected and displayed in the target grid.
|
void |
deselectRecords(ListGridRecord[] records,
boolean fireSelectionChanged)
Programmatically deselect a set of records that are currently selected and displayed in the target grid.
|
VLayout |
getControlBar()
|
DataSource |
getDataSource()
DataSource for this shuttle's data set.
|
ImgButton |
getDeselectAllButton()
ImgButton for deselecting the full set of selected data in the shuttle.
|
java.lang.Integer |
getDeselectAllButtonHeight()
Height for the
deselectAllButton |
java.lang.String |
getDeselectAllButtonIcon()
Icon for the
deselectAllButton |
java.lang.Integer |
getDeselectAllButtonWidth()
Width for the
deselectAllButton |
ImgButton |
getDeselectButton()
ImgButton for deselecting a single record
|
java.lang.Integer |
getDeselectButtonHeight()
Height for the
deselectButton |
java.lang.String |
getDeselectButtonIcon()
Icon for the
deselectButton |
java.lang.Integer |
getDeselectButtonWidth()
Width for the
deselectButton |
java.lang.String |
getFetchOperation()
OperationId for fetching records from the shuttle's DataSource . |
DSRequest |
getFilterContext()
DSRequest configuration for retrieving records from this shuttle's dataSource.
|
Criteria |
getImplicitCriteria()
Implicit criteria for retrieving records from this shuttle's dataSource.
|
java.lang.String |
getIncompleteDataWarning()
Warning to display when the user attempts to
select
all records from a partially loaded data set. |
SortSpecifier[] |
getInitialSort()
Initial sort specifiers for this item's list of
options. |
java.lang.String |
getLoadingPlaceholderAttribute()
This attribute will be set to true for any loading placeholder records returned by
getSelectedRecords() |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static Shuttle |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
ImgButton |
getSelectAllButton()
ImgButton for selecting the full set of data in the shuttle.
|
java.lang.Integer |
getSelectAllButtonHeight()
Height for the
selectAllButton |
java.lang.String |
getSelectAllButtonIcon()
Icon for the
selectAllButton |
java.lang.Integer |
getSelectAllButtonWidth()
Width for the
selectAllButton |
ImgButton |
getSelectButton()
ImgButton for selecting a single record
|
java.lang.Integer |
getSelectButtonHeight()
Height for the
selectButton |
java.lang.String |
getSelectButtonIcon()
Icon for the
selectButton |
java.lang.Integer |
getSelectButtonWidth()
Width for the
selectButton |
ListGridRecord |
getSelectedRecords()
Initial set of selected records for the shuttle.
|
java.lang.String[] |
getSelectedValues()
Initial selected values for the shuttle.
|
int[] |
getSelectedValuesAsIntArray()
Initial selected values for the shuttle.
|
SortDirection |
getSortDirection()
Sort direction for this item's list of options. |
java.lang.String |
getSortField()
Sort field for this item's list of options. |
java.lang.Integer |
getSortFieldAsInt()
Sort field for this item's list of options. |
java.lang.String[] |
getSortFieldAsStringArray()
Sort field for this item's list of options. |
ListGrid |
getSourceGrid()
List grid containing the (unselected) set of records.
|
java.lang.String |
getSourceGridTitle()
Title for the source grid, shown as a
Canvas.groupTitle |
ListGrid |
getTargetGrid()
List grid containing the selected set of records.
|
java.lang.String |
getTargetGridTitle()
Title for the target grid, shown as a
Canvas.groupTitle |
TextMatchStyle |
getTextMatchStyle()
TextMatchStyle for retrieving records from this shuttle's dataSource.
|
java.lang.String |
getValueField()
This field is expected to be unique for records within the shuttle's data set.
|
java.lang.String |
getValueFieldName()
Returns the
valueField for this shuttle |
void |
selectionUpdated()
Notification method fired when records are selected or unselected in this shuttle.
|
void |
selectRecords(ListGridRecord[] records)
Programmatically select a set of records from this shuttle's dataSource.
|
void |
selectRecords(ListGridRecord[] records,
boolean fireSelectionChanged)
Programmatically select a set of records from this shuttle's dataSource.
|
Shuttle |
setDataSource(DataSource dataSource)
DataSource for this shuttle's data set.
|
static void |
setDefaultProperties(Shuttle shuttleProperties)
Class level method to set the default properties of this class.
|
Shuttle |
setDeselectAllButtonHeight(java.lang.Integer deselectAllButtonHeight)
Height for the
deselectAllButton |
Shuttle |
setDeselectAllButtonIcon(java.lang.String deselectAllButtonIcon)
Icon for the
deselectAllButton |
Shuttle |
setDeselectAllButtonWidth(java.lang.Integer deselectAllButtonWidth)
Width for the
deselectAllButton |
Shuttle |
setDeselectButtonHeight(java.lang.Integer deselectButtonHeight)
Height for the
deselectButton |
Shuttle |
setDeselectButtonIcon(java.lang.String deselectButtonIcon)
Icon for the
deselectButton |
Shuttle |
setDeselectButtonWidth(java.lang.Integer deselectButtonWidth)
Width for the
deselectButton |
Shuttle |
setFetchOperation(java.lang.String fetchOperation)
OperationId for fetching records from the shuttle's DataSource . |
Shuttle |
setFilterContext(DSRequest filterContext)
DSRequest configuration for retrieving records from this shuttle's dataSource.
|
Shuttle |
setImplicitCriteria(Criteria implicitCriteria)
Implicit criteria for retrieving records from this shuttle's dataSource.
|
Shuttle |
setIncompleteDataWarning(java.lang.String incompleteDataWarning)
Warning to display when the user attempts to
select
all records from a partially loaded data set. |
Shuttle |
setInitialSort(SortSpecifier... initialSort)
Initial sort specifiers for this item's list of
options. |
Shuttle |
setLoadingPlaceholderAttribute(java.lang.String loadingPlaceholderAttribute)
This attribute will be set to true for any loading placeholder records returned by
getSelectedRecords() |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.ShuttleLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
Shuttle |
setSelectAllButtonHeight(java.lang.Integer selectAllButtonHeight)
Height for the
selectAllButton |
Shuttle |
setSelectAllButtonIcon(java.lang.String selectAllButtonIcon)
Icon for the
selectAllButton |
Shuttle |
setSelectAllButtonWidth(java.lang.Integer selectAllButtonWidth)
Width for the
selectAllButton |
Shuttle |
setSelectButtonHeight(java.lang.Integer selectButtonHeight)
Height for the
selectButton |
Shuttle |
setSelectButtonIcon(java.lang.String selectButtonIcon)
Icon for the
selectButton |
Shuttle |
setSelectButtonWidth(java.lang.Integer selectButtonWidth)
Width for the
selectButton |
void |
setSelectedByValue(int[] value,
java.lang.Boolean selected)
Method to add or remove records from the current selection where the
valueField matches the values passed in. |
void |
setSelectedByValue(java.lang.String[] value,
java.lang.Boolean selected)
Method to add or remove records from the current selection where the
valueField matches the values passed in. |
Shuttle |
setSelectedRecords(ListGridRecord selectedRecords)
Initial set of selected records for the shuttle.
|
Shuttle |
setSelectedValues(int... selectedValues)
Initial selected values for the shuttle.
|
Shuttle |
setSelectedValues(java.lang.String... selectedValues)
Initial selected values for the shuttle.
|
Shuttle |
setSortDirection(SortDirection sortDirection)
Sort direction for this item's list of options. |
Shuttle |
setSortField(java.lang.Integer sortField)
Sort field for this item's list of options. |
Shuttle |
setSortField(java.lang.String... sortField)
Sort field for this item's list of options. |
Shuttle |
setSortField(java.lang.String sortField)
Sort field for this item's list of options. |
Shuttle |
setSourceGridTitle(java.lang.String sourceGridTitle)
Title for the source grid, shown as a
Canvas.groupTitle |
Shuttle |
setTargetGridTitle(java.lang.String targetGridTitle)
Title for the target grid, shown as a
Canvas.groupTitle |
Shuttle |
setTextMatchStyle(TextMatchStyle textMatchStyle)
TextMatchStyle for retrieving records from this shuttle's dataSource.
|
Shuttle |
setValueField(java.lang.String valueField)
This field is expected to be unique for records within the shuttle's data set.
|
boolean |
valuesFetchComplete()
Notification method fired when a fetch to retrieve records for an array of values passed to
setSelectedByValue() is complete. |
boolean |
valuesFetchInProgress()
Returns true if this shuttle is currently fetching record(s) associated with values passed to
setSelectedByValue() |
boolean |
valuesFetchInProgress(java.lang.Object value)
Returns true if this shuttle is currently fetching record(s) associated with values passed to
setSelectedByValue() |
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_Layout, onInit, 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, showMember
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, 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, 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, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
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, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
public Shuttle()
public Shuttle(com.google.gwt.core.client.JavaScriptObject jsObj)
public static Shuttle getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public VLayout getControlBar() throws java.lang.IllegalStateException
selectAllButton
,
selectButton
, deselectButton
and deselectAllButton
This component is an AutoChild named "controlBar". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setDataSource(DataSource dataSource) throws java.lang.IllegalStateException
dataSource
- New dataSource value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic DataSource getDataSource()
public ImgButton getDeselectAllButton() throws java.lang.IllegalStateException
This component is an AutoChild named "deselectAllButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setDeselectAllButtonHeight(java.lang.Integer deselectAllButtonHeight) throws java.lang.IllegalStateException
deselectAllButton
deselectAllButtonHeight
- New deselectAllButtonHeight value. Default value is 22Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getDeselectAllButtonHeight()
deselectAllButton
public Shuttle setDeselectAllButtonIcon(java.lang.String deselectAllButtonIcon) throws java.lang.IllegalStateException
deselectAllButton
deselectAllButtonIcon
- New deselectAllButtonIcon value. Default value is "[SKINIMG]TransferIcons/left_all.png"Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCImgURL
public java.lang.String getDeselectAllButtonIcon()
deselectAllButton
SCImgURL
public Shuttle setDeselectAllButtonWidth(java.lang.Integer deselectAllButtonWidth) throws java.lang.IllegalStateException
deselectAllButton
deselectAllButtonWidth
- New deselectAllButtonWidth value. Default value is 24Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getDeselectAllButtonWidth()
deselectAllButton
public ImgButton getDeselectButton() throws java.lang.IllegalStateException
This component is an AutoChild named "deselectButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setDeselectButtonHeight(java.lang.Integer deselectButtonHeight) throws java.lang.IllegalStateException
deselectButton
deselectButtonHeight
- New deselectButtonHeight value. Default value is 22Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getDeselectButtonHeight()
deselectButton
public Shuttle setDeselectButtonIcon(java.lang.String deselectButtonIcon) throws java.lang.IllegalStateException
deselectButton
public java.lang.String getDeselectButtonIcon()
deselectButton
SCImgURL
public Shuttle setDeselectButtonWidth(java.lang.Integer deselectButtonWidth) throws java.lang.IllegalStateException
deselectButton
deselectButtonWidth
- New deselectButtonWidth value. Default value is 24Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getDeselectButtonWidth()
deselectButton
public Shuttle setFetchOperation(java.lang.String fetchOperation) throws java.lang.IllegalStateException
OperationId
for fetching records from the shuttle's DataSource
.fetchOperation
- New fetchOperation value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getFetchOperation()
OperationId
for fetching records from the shuttle's DataSource
.public Shuttle setFilterContext(DSRequest filterContext) throws java.lang.IllegalStateException
filterContext
- New filterContext value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic DSRequest getFilterContext()
public Shuttle setImplicitCriteria(Criteria implicitCriteria)
These criteria may be combined with
"inSet"
or "notInSet"
sub criteria for the valueField
in order to populate the set of unselected records
in the sourceGrid
. They are ListGrid.implicitCriteria
meaning that any user-entered
filter criteria
will be overlayed on top of these
criteria.
If this method is called after the component has been drawn/initialized:
Update the implicitCriteria
for the shuttle.
implicitCriteria
- new implicitCriteria. Default value is nullShuttle
instance, for chaining setter callspublic Criteria getImplicitCriteria()
These criteria may be combined with
"inSet"
or "notInSet"
sub criteria for the valueField
in order to populate the set of unselected records
in the sourceGrid
. They are ListGrid.implicitCriteria
meaning that any user-entered
filter criteria
will be overlayed on top of these
criteria.
public Shuttle setIncompleteDataWarning(java.lang.String incompleteDataWarning) throws java.lang.IllegalStateException
select
all
records from a partially loaded
data set.incompleteDataWarning
- New incompleteDataWarning value. Default value is "Unable to select all - the data set does not have all matching records loaded from the dataSource."Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getIncompleteDataWarning()
select
all
records from a partially loaded
data set.public Shuttle setInitialSort(SortSpecifier... initialSort) throws java.lang.IllegalStateException
Initial sort specifiers
for this item's list of
options. Will be applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.initialSort
- New initialSort value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic SortSpecifier[] getInitialSort()
Initial sort specifiers
for this item's list of
options. Will be applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.public Shuttle setLoadingPlaceholderAttribute(java.lang.String loadingPlaceholderAttribute) throws java.lang.IllegalStateException
getSelectedRecords()
Note : This is an advanced setting
loadingPlaceholderAttribute
- New loadingPlaceholderAttribute value. Default value is "_isLoadingPlaceholder"Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getLoadingPlaceholderAttribute()
getSelectedRecords()
public ImgButton getSelectAllButton() throws java.lang.IllegalStateException
This component is an AutoChild named "selectAllButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setSelectAllButtonHeight(java.lang.Integer selectAllButtonHeight) throws java.lang.IllegalStateException
selectAllButton
selectAllButtonHeight
- New selectAllButtonHeight value. Default value is 22Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getSelectAllButtonHeight()
selectAllButton
public Shuttle setSelectAllButtonIcon(java.lang.String selectAllButtonIcon) throws java.lang.IllegalStateException
selectAllButton
selectAllButtonIcon
- New selectAllButtonIcon value. Default value is "[SKINIMG]TransferIcons/right_all.png"Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCImgURL
public java.lang.String getSelectAllButtonIcon()
selectAllButton
SCImgURL
public Shuttle setSelectAllButtonWidth(java.lang.Integer selectAllButtonWidth) throws java.lang.IllegalStateException
selectAllButton
selectAllButtonWidth
- New selectAllButtonWidth value. Default value is 24Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getSelectAllButtonWidth()
selectAllButton
public ImgButton getSelectButton() throws java.lang.IllegalStateException
This component is an AutoChild named "selectButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setSelectButtonHeight(java.lang.Integer selectButtonHeight) throws java.lang.IllegalStateException
selectButton
selectButtonHeight
- New selectButtonHeight value. Default value is 22Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getSelectButtonHeight()
selectButton
public Shuttle setSelectButtonIcon(java.lang.String selectButtonIcon) throws java.lang.IllegalStateException
selectButton
public java.lang.String getSelectButtonIcon()
selectButton
SCImgURL
public Shuttle setSelectButtonWidth(java.lang.Integer selectButtonWidth) throws java.lang.IllegalStateException
selectButton
selectButtonWidth
- New selectButtonWidth value. Default value is 24Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getSelectButtonWidth()
selectButton
public Shuttle setSelectedRecords(ListGridRecord selectedRecords) throws java.lang.IllegalStateException
See also selectedValues
for initializing selection based on record
values.
To update the selection at runtime use selectRecords()
and deselectRecords()
.
selectedRecords
- New selectedRecords value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic ListGridRecord getSelectedRecords()
See also selectedValues
for initializing selection based on record
values.
To update the selection at runtime use selectRecords()
and deselectRecords()
.
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. See valuesFetchInProgress()
.
In this case no record
will be returned by this method for that record by default. The includeLoadingPlaceholders
parameter will
cause this method to also return placeholder record objects for these unloaded records, which have two properties
specified - the valueField
value _isLoadingPlaceholder:true
. Default value is null
public Shuttle setSelectedValues(java.lang.String... selectedValues) throws java.lang.IllegalStateException
If specified, the shuttle will be initialized with records with matching
valueField
being selected.
See also selectedRecords
for initializing selection with specific
records. If both properties are specified, selectedValues
will have no effect
To update the selection
by value at runtime use setSelectedByValue()
selectedValues
- New selectedValues value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String[] getSelectedValues()
If specified, the shuttle will be initialized with records with matching
valueField
being selected.
See also selectedRecords
for initializing selection with specific
records. If both properties are specified, selectedValues
will have no effect
To update the selection
by value at runtime use setSelectedByValue()
valueField
value 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. See valuesFetchInProgress()
.
The includeUnloadedValues
parameter can be used to return values for these unloaded records. Default value is null
public Shuttle setSelectedValues(int... selectedValues) throws java.lang.IllegalStateException
If specified, the shuttle will be initialized with records with matching
valueField
being selected.
See also selectedRecords
for initializing selection with specific
records. If both properties are specified, selectedValues
will have no effect
To update the selection
by value at runtime use setSelectedByValue()
selectedValues
- New selectedValues value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int[] getSelectedValuesAsIntArray()
If specified, the shuttle will be initialized with records with matching
valueField
being selected.
See also selectedRecords
for initializing selection with specific
records. If both properties are specified, selectedValues
will have no effect
To update the selection
by value at runtime use setSelectedByValue()
valueField
value 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. See valuesFetchInProgress()
.
The includeUnloadedValues
parameter can be used to return values for these unloaded records. Default value is null
public Shuttle setSortDirection(SortDirection sortDirection) throws java.lang.IllegalStateException
Sort direction
for this item's list of options. Will
be applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.sortDirection
- New sortDirection value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic SortDirection getSortDirection()
Sort direction
for this item's list of options. Will
be applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.public Shuttle setSortField(java.lang.String sortField) throws java.lang.IllegalStateException
Sort field
for this item's list of options. Will be
applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.sortField
- New sortField value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSortField()
Sort field
for this item's list of options. Will be
applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.public Shuttle setSortField(java.lang.String... sortField) throws java.lang.IllegalStateException
Sort field
for this item's list of options. Will be
applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.sortField
- New sortField value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String[] getSortFieldAsStringArray()
Sort field
for this item's list of options. Will be
applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.public Shuttle setSortField(java.lang.Integer sortField) throws java.lang.IllegalStateException
Sort field
for this item's list of options. Will be
applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.sortField
- New sortField value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getSortFieldAsInt()
Sort field
for this item's list of options. Will be
applied to sourceGrid
and targetGrid
. To specify initial sort for each grid separately,
these properties may be set per grid using the standard autoChild pattern
.public ListGrid getSourceGrid() throws java.lang.IllegalStateException
targetGrid
.
This component is an AutoChild named "sourceGrid". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setSourceGridTitle(java.lang.String sourceGridTitle) throws java.lang.IllegalStateException
Canvas.groupTitle
sourceGridTitle
- New sourceGridTitle value. Default value is "Unselected Values"Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSourceGridTitle()
Canvas.groupTitle
public ListGrid getTargetGrid() throws java.lang.IllegalStateException
sourceGrid
.
This component is an AutoChild named "targetGrid". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Shuttle setTargetGridTitle(java.lang.String targetGridTitle) throws java.lang.IllegalStateException
Canvas.groupTitle
targetGridTitle
- New targetGridTitle value. Default value is "Selected Values"Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getTargetGridTitle()
Canvas.groupTitle
public Shuttle setTextMatchStyle(TextMatchStyle textMatchStyle) throws java.lang.IllegalStateException
textMatchStyle
- New textMatchStyle value. Default value is "substring"Shuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic TextMatchStyle getTextMatchStyle()
public Shuttle setValueField(java.lang.String valueField) throws java.lang.IllegalStateException
dataSource.primaryKey
will be used. May be used to select records by value
and to retrieve the current
selected values
.
valueField
- New valueField value. Default value is nullShuttle
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getValueField()
dataSource.primaryKey
will be used. May be used to select records by value
and to retrieve the current
selected values
.
public void clearSelection()
public void clearSelection(boolean fireSelectionChanged)
fireSelectionChanged
- Fire the selectionUpdated()
notification?public void deselectRecords(ListGridRecord[] records)
records
- Records to deselectpublic void deselectRecords(ListGridRecord[] records, boolean fireSelectionChanged)
records
- Records to deselectfireSelectionChanged
- Fire the selectionUpdated()
notification?public java.lang.String getValueFieldName()
valueField
for this shuttlepublic void selectionUpdated()
Use getSelectedRecords()
or getSelectedValues()
to retrieve the current selection.
public void selectRecords(ListGridRecord[] records)
records
- Records to selectpublic void selectRecords(ListGridRecord[] records, boolean fireSelectionChanged)
records
- Records to selectfireSelectionChanged
- Fire the selectionUpdated()
notification?public void setSelectedByValue(java.lang.String[] value, java.lang.Boolean selected)
valueField
matches the values passed in. If the source
listGrid does not have a complete data set
and does
not contain an entry for any of the requested values, a separate fetch request will be issued against our DataSource
to pick up the records for the specified value(s). The valuesFetchInProgress()
and valuesFetchComplete()
methods provide information about
this fetch.
value
- Array of values to selectselected
- New selected state for the recordspublic void setSelectedByValue(int[] value, java.lang.Boolean selected)
valueField
matches the values passed in. If the source
listGrid does not have a complete data set
and does
not contain an entry for any of the requested values, a separate fetch request will be issued against our DataSource
to pick up the records for the specified value(s). The valuesFetchInProgress()
and valuesFetchComplete()
methods provide information about
this fetch.
value
- Array of values to selectselected
- New selected state for the recordspublic boolean valuesFetchComplete()
setSelectedByValue()
is complete. Note that if no associated record for the specified value was found in the dataSource, this method will still fire.
public boolean valuesFetchInProgress()
setSelectedByValue()
If no explicit
value
parameter was passed, this method will return true if this shuttle has any outstanding values
fetches.
public boolean valuesFetchInProgress(java.lang.Object value)
setSelectedByValue()
If no explicit
value
parameter was passed, this method will return true if this shuttle has any outstanding values
fetches.
value
- if passed, this method will return true only if there is an outstanding fetch to retrieve the associated record for
this specified valuepublic static void setDefaultProperties(Shuttle shuttleProperties)
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.
shuttleProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.ShuttleLogicalStructure s)
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure
in interface LogicalStructure
getLogicalStructure
in class Layout