Class FieldPicker
- 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
DataBoundComponent. It allows for easy customization of the order in which the
fields of a DataBoundComponent are displayed, and of which are visible. If so
configured, it also allows for convenient launching of the HiliteEditor, FormulaBuilder, and SummaryBuilder. A
FieldPicker instance runs in its own window, a FieldPickerWindow-
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.protected JavaScriptObjectcreate()The title displayed for the Add Custom Fields ButtonAListGridshowing the list of available fields.Canvas[]Provides a set of controls to appear assection header controlsabove the available fields grid.The title displayed for the title property of the available fieldsThe title shown on the Cancel buttonAn AutoChildbuttonthat saves the current field-set and exits the Field Picker.Whether the current fields' filter row allows the sample value column to be filtered.AListGridshowing the list of currently selected fields.The title displayed for the title property of the current fieldsThe component whose fields should be edited.An optional DataSource that is used to create a disposabledataBoundComponentif none is provided.The hint shown when editing a field with no title defined.Alabeldisplaying the text assigned as the FieldPicker'sinstructions.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static FieldPickergetOrCreateRef(JavaScriptObject jsObj) The title shown on the 'Visible Fields' grid's context menu item, whose click handler puts the selected item back in the 'Available Fields' collection.If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.The title displayed for the sample value property of the current fieldsAn AutoChildbuttonthat saves the current field-set and exits the Field Picker.The title shown on the Save and Exit buttonbooleanWhen set to false, hides the right-most set of buttons, used for re-ordering fields in the Visible Fields list.booleanShows a "Highlights..." button that shows an interface for editing hilites in the attached DataBoundComponent.setAddCustomFieldsButtonTitle(String addCustomFieldsButtonTitle) The title displayed for the Add Custom Fields ButtonvoidsetAvailableFields(DataSourceField... newFields) Provides a new set of available fields.setAvailableFieldsHeaderControls(Canvas... availableFieldsHeaderControls) Provides a set of controls to appear assection header controlsabove the available fields grid.setAvailableFieldsTitle(String availableFieldsTitle) setAvailableTitleTitle(String availableTitleTitle) The title displayed for the title property of the available fieldsvoidsetCallbackCustomizer(FieldPickerCallbackCustomizer customizer) This method is called during rendering for all events in the visible range - those which would be rendered by default.setCancelButtonTitle(String cancelButtonTitle) The title shown on the Cancel buttonsetCanFilterSampleValue(Boolean canFilterSampleValue) Whether the current fields' filter row allows the sample value column to be filtered.setConfirmText(String confirmText) setCurrentFieldsTitle(String currentFieldsTitle) setCurrentTitleTitle(String currentTitleTitle) The title displayed for the title property of the current fieldssetDataBoundComponent(Canvas dataBoundComponent) The component whose fields should be edited.setDataSource(DataSource dataSource) An optional DataSource that is used to create a disposabledataBoundComponentif none is provided.static voidsetDefaultProperties(FieldPicker fieldPickerProperties) Class level method to set the default properties of this class.setEmptyTitleHint(String emptyTitleHint) The hint shown when editing a field with no title defined.setHilitesText(String hilitesText) setInstructions(String instructions) Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setRemoveItemTitle(String removeItemTitle) The title shown on the 'Visible Fields' grid's context menu item, whose click handler puts the selected item back in the 'Available Fields' collection.setRemoveText(String removeText) setSampleRecord(Record sampleRecord) If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.setSampleRecord(DefaultSampleRecord sampleRecord) If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.setSampleValueTitle(String sampleValueTitle) The title displayed for the sample value property of the current fieldssetSaveAndExitButtonTitle(String saveAndExitButtonTitle) The title shown on the Save and Exit buttonsetShowFieldOrderButtons(boolean showFieldOrderButtons) When set to false, hides the right-most set of buttons, used for re-ordering fields in the Visible Fields list.setShowHilitesButton(boolean showHilitesButton) Shows a "Highlights..." button that shows an interface for editing hilites in the attached DataBoundComponent.Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructureMethods 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, 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, 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
-
FieldPicker
public FieldPicker() -
FieldPicker
-
-
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
-
setAddCustomFieldsButtonTitle
public FieldPicker setAddCustomFieldsButtonTitle(String addCustomFieldsButtonTitle) throws IllegalStateException The title displayed for the Add Custom Fields Button- Parameters:
addCustomFieldsButtonTitle- New addCustomFieldsButtonTitle value. Default value is "Add Custom Fields"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAddCustomFieldsButtonTitle
The title displayed for the Add Custom Fields Button- Returns:
- Current addCustomFieldsButtonTitle value. Default value is "Add Custom Fields"
-
getAvailableFieldsGrid
AListGridshowing the list of available fields.This component is an AutoChild named "availableFieldsGrid". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current availableFieldsGrid value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setAvailableFieldsHeaderControls
public FieldPicker setAvailableFieldsHeaderControls(Canvas... availableFieldsHeaderControls) throws IllegalStateException Provides a set of controls to appear assection header controlsabove the available fields grid.- Parameters:
availableFieldsHeaderControls- New availableFieldsHeaderControls value. Default value is null- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAvailableFieldsHeaderControls
Provides a set of controls to appear assection header controlsabove the available fields grid.- Returns:
- Current availableFieldsHeaderControls value. Default value is null
-
setAvailableFieldsTitle
public FieldPicker setAvailableFieldsTitle(String availableFieldsTitle) throws IllegalStateException - Parameters:
availableFieldsTitle- New availableFieldsTitle value. Default value is "Available Fields"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAvailableFieldsTitle
- Returns:
- Current availableFieldsTitle value. Default value is "Available Fields"
-
setAvailableTitleTitle
The title displayed for the title property of the available fields- Parameters:
availableTitleTitle- New availableTitleTitle value. Default value is "Name"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAvailableTitleTitle
The title displayed for the title property of the available fields- Returns:
- Current availableTitleTitle value. Default value is "Name"
-
getButtonLayout
Ahorizontal layoutused to show theSaveandCancelbuttons.This component is an AutoChild named "buttonLayout". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current buttonLayout value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setCancelButtonTitle
The title shown on the Cancel button- Parameters:
cancelButtonTitle- New cancelButtonTitle value. Default value is "Cancel"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCancelButtonTitle
The title shown on the Cancel button- Returns:
- Current cancelButtonTitle value. Default value is "Cancel"
-
getCancelChangesButton
An AutoChildbuttonthat saves the current field-set and exits the Field Picker.This component is an AutoChild named "cancelChangesButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current cancelChangesButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setCanFilterSampleValue
public FieldPicker setCanFilterSampleValue(Boolean canFilterSampleValue) throws IllegalStateException Whether the current fields' filter row allows the sample value column to be filtered.- Parameters:
canFilterSampleValue- New canFilterSampleValue value. Default value is false- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getCanFilterSampleValue
Whether the current fields' filter row allows the sample value column to be filtered.- Returns:
- Current canFilterSampleValue value. Default value is false
- See Also:
-
setConfirmText
- Parameters:
confirmText- New confirmText value. Default value is "Must save pending changes to proceed. OK?"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getConfirmText
- Returns:
- Current confirmText value. Default value is "Must save pending changes to proceed. OK?"
-
getCurrentFieldsGrid
AListGridshowing the list of currently selected fields.This component is an AutoChild named "currentFieldsGrid". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current currentFieldsGrid value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setCurrentFieldsTitle
- Parameters:
currentFieldsTitle- New currentFieldsTitle value. Default value is "Visible Fields"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCurrentFieldsTitle
- Returns:
- Current currentFieldsTitle value. Default value is "Visible Fields"
-
setCurrentTitleTitle
The title displayed for the title property of the current fields- Parameters:
currentTitleTitle- New currentTitleTitle value. Default value is "Field Title"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCurrentTitleTitle
The title displayed for the title property of the current fields- Returns:
- Current currentTitleTitle value. Default value is "Field Title"
-
setDataBoundComponent
The component whose fields should be edited.Note that if
DataBoundComponent.useAllDataSourceFieldsis set on the component, it will be cleared when the FieldPicker applies the requested ordering since that setting imposes a fixed ordering on the fields.- Parameters:
dataBoundComponent- New dataBoundComponent value. Default value is null- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDataBoundComponent
The component whose fields should be edited.Note that if
DataBoundComponent.useAllDataSourceFieldsis set on the component, it will be cleared when the FieldPicker applies the requested ordering since that setting imposes a fixed ordering on the fields.- Returns:
- Current dataBoundComponent value. Default value is null
-
setDataSource
An optional DataSource that is used to create a disposabledataBoundComponentif none is provided. Has no effect if adataBoundComponentis specified.- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDataSource
An optional DataSource that is used to create a disposabledataBoundComponentif none is provided. Has no effect if adataBoundComponentis specified.- Returns:
- Current dataSource value. Default value is null
-
setEmptyTitleHint
The hint shown when editing a field with no title defined.- Parameters:
emptyTitleHint- New emptyTitleHint value. Default value is "[No title specified]"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getEmptyTitleHint
The hint shown when editing a field with no title defined.- Returns:
- Current emptyTitleHint value. Default value is "[No title specified]"
-
setHilitesText
- Parameters:
hilitesText- New hilitesText value. Default value is "Highlights..."- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getHilitesText
- Returns:
- Current hilitesText value. Default value is "Highlights..."
-
getInstructionLabel
Alabeldisplaying the text assigned as the FieldPicker'sinstructions. Shown across the top of the widget.This component is an AutoChild named "instructionLabel". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current instructionLabel value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setInstructions
- Parameters:
instructions- New instructions value. Default value is "Drag and drop or use arrows to move fields. Drag reorder to change field order."- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getInstructions
- Returns:
- Current instructions value. Default value is "Drag and drop or use arrows to move fields. Drag reorder to change field order."
- See Also:
-
setRemoveItemTitle
The title shown on the 'Visible Fields' grid's context menu item, whose click handler puts the selected item back in the 'Available Fields' collection.- Parameters:
removeItemTitle- New removeItemTitle value. Default value is "Remove"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getRemoveItemTitle
The title shown on the 'Visible Fields' grid's context menu item, whose click handler puts the selected item back in the 'Available Fields' collection.- Returns:
- Current removeItemTitle value. Default value is "Remove"
-
setRemoveText
- Parameters:
removeText- New removeText value. Default value is "You are about to remove the field. Are you sure?"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getRemoveText
- Returns:
- Current removeText value. Default value is "You are about to remove the field. Are you sure?"
-
setSampleRecord
If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.
A value of "first" means the first record. If the underlyingdataBoundComponentis aTreeGrid, you can specify "firstOpenLeaf" to use the first open leaf as the sampleRecord (this is often desirable in trees where the first record may be a folder that's used for organizational purposes only and hence would have no actual data for columns other than the tree column).- Parameters:
sampleRecord- New sampleRecord value. Default value is "first"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSampleRecord
If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.
A value of "first" means the first record. If the underlyingdataBoundComponentis aTreeGrid, you can specify "firstOpenLeaf" to use the first open leaf as the sampleRecord (this is often desirable in trees where the first record may be a folder that's used for organizational purposes only and hence would have no actual data for columns other than the tree column).- Returns:
- Current sampleRecord value. Default value is "first"
-
setSampleRecord
If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.
A value of "first" means the first record. If the underlyingdataBoundComponentis aTreeGrid, you can specify "firstOpenLeaf" to use the first open leaf as the sampleRecord (this is often desirable in trees where the first record may be a folder that's used for organizational purposes only and hence would have no actual data for columns other than the tree column).- Parameters:
sampleRecord- New sampleRecord value. Default value is "first"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSampleRecordAsDefaultSampleRecord
If asampleRecordis provided, the FieldPicker will show a second column in the Current Fields dialog showing the cell value that will appear for that field given the provided sample record.
A value of "first" means the first record. If the underlyingdataBoundComponentis aTreeGrid, you can specify "firstOpenLeaf" to use the first open leaf as the sampleRecord (this is often desirable in trees where the first record may be a folder that's used for organizational purposes only and hence would have no actual data for columns other than the tree column).- Returns:
- Current sampleRecord value. Default value is "first"
-
setSampleValueTitle
The title displayed for the sample value property of the current fields- Parameters:
sampleValueTitle- New sampleValueTitle value. Default value is "Sample Value"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSampleValueTitle
The title displayed for the sample value property of the current fields- Returns:
- Current sampleValueTitle value. Default value is "Sample Value"
-
getSaveAndExitButton
An AutoChildbuttonthat saves the current field-set and exits the Field Picker.This component is an AutoChild named "saveAndExitButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current saveAndExitButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setSaveAndExitButtonTitle
public FieldPicker setSaveAndExitButtonTitle(String saveAndExitButtonTitle) throws IllegalStateException The title shown on the Save and Exit button- Parameters:
saveAndExitButtonTitle- New saveAndExitButtonTitle value. Default value is "Apply"- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSaveAndExitButtonTitle
The title shown on the Save and Exit button- Returns:
- Current saveAndExitButtonTitle value. Default value is "Apply"
-
setShowFieldOrderButtons
public FieldPicker setShowFieldOrderButtons(boolean showFieldOrderButtons) throws IllegalStateException When set to false, hides the right-most set of buttons, used for re-ordering fields in the Visible Fields list.- Parameters:
showFieldOrderButtons- New showFieldOrderButtons value. Default value is true- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowFieldOrderButtons
public boolean getShowFieldOrderButtons()When set to false, hides the right-most set of buttons, used for re-ordering fields in the Visible Fields list.- Returns:
- Current showFieldOrderButtons value. Default value is true
-
setShowHilitesButton
Shows a "Highlights..." button that shows an interface for editing hilites in the attached DataBoundComponent.- Parameters:
showHilitesButton- New showHilitesButton value. Default value is true- Returns:
FieldPickerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowHilitesButton
public boolean getShowHilitesButton()Shows a "Highlights..." button that shows an interface for editing hilites in the attached DataBoundComponent.- Returns:
- Current showHilitesButton value. Default value is true
-
setAvailableFields
Provides a new set of available fields.- Parameters:
newFields-
-
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:
fieldPickerProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setCallbackCustomizer
This method is called during rendering for all events in the visible range - those which would be rendered by default. The customizer should return false to prevent the passed event from appearing in the passed view.- Parameters:
customizer- the customizer to execute.
-
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 classVLayout
-