public class BatchUploader extends VStack implements HasBeforeCommitHandlers, HasPreviewShownHandlers
NOTE: BatchUploader is only available with Smart GWT Power or better.
By default, a
BatchUploader consists of a single FileItem form field. This form field
will upload a file using the special "batchUpload" built-in DataSource. The uploaded file data will be parsed and
validated using the uploadDataSource, then
streamed back to the browser, along with any errors, for display in a ListGrid.
The BatchUploader.previewShown() notification method will
be fired when the uploaded records are being displayed in this grid.
The user can then correct any errors and submit
the final dataset, which will be added to the DataSource via a series of "add" DSRequests, all submitted as a single
HTTP request via request queuing.
Developers may specify a
custom "add" operation to use on the target uploadDataSource via the uploadOperation
property.
Additional form fields can be added to the form that uploads the data file via uploadFormFields. Values entered into these fields are
not included in the "add" DSRequests used to store the uploaded records. Instead, they are stored as HttpSession
attributes with the names corresponding to the names of the specified uploadFormFields (optionally with a
prefix applied, in case this is necessary to
avoid name collisions in the session). This allows any custom logic for the "add" operation to access these additional
fields via httpSession.getAttribute(). If uploadFormFields are not provided method httpSession.getAttribute() will not be called.
Because all records are saved in a single HTTP request, a similar strategy of storing data as servletRequest or session attributes allows reuse of objects required to perform the "add" operations (such as field values common to all added records, or a SQL connection or transaction manager).
If uploadFieldName is set on any of the uploadDataSource's fields, the BatchUploader will use that name to map the uploaded file's content.
Note, that for
CSV data format header line is optional. If first
non-empty line in the uploaded file has no matching field names, it is assumed that there's no header row, and all rows
(including the first one) are treated as data rows.
Imported data can be transformed during import, see DataSourceField.importStrategy for details.
A
couple of server-side techniques are interesting in conjunction with the BatchUploader. One is to set the DataSource.serverConstructor property to point at your
own class that inherits from com.isomorphic.datasource.BasicDataSource. The most interesting reason for
doing this is to override the validate method and provide complete custom validation - for example,
checking relations to other tables.
Another technique is to handle the initial Smart GWT call in your own servlet,
by setting the dataURL property. You then handle the add
requests with a combination of your own code and Smart GWT server API calls. This is a good way to add special pre-
and post-processing to the normal server-side flow.
Note: The special "batchUpload" DataSource, which should
reside in the shared/ds folder of your application's webroot (see Installation Instructions). is not part of your application's data flow, and it has nothing to do with the uploadDataSource you use to actually persist the
validated and error-corrected data: it is simply a means to uploading the raw data in the first place. Normally, you
should simply ignore its presence and treat it as an internal detail of the Smart GWT framework.
However, there are circumstances in which you may wish to change it to achieve specific aims. For example, you may wish to override the Java class it invokes, in order to insert your own security or other validation logic into the initial upload flow. This is entirely in keeping with the design, but we regard it as an out-of-the-ordinary use-case: normal usage is simply to ignore the presence of the batchUpload DataSource.
BatchUploader is a VStack, that simply stacks members on the vertical axis without trying to manage
their height. If you need to control heights, you can set vPolicy to "fill"
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
BatchUploader() |
BatchUploader(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addBeforeCommitHandler(BeforeCommitHandler handler)
Add a beforeCommit handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addPreviewShownHandler(PreviewShownHandler handler)
Add a previewShown handler.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getAllRecordsInErrorMessage()
Message to display when the user clicks "Commit" but there is nothing we can commit because every row in the grid has
errors
|
java.lang.Boolean |
getAutoInterpretBooleans()
Controls if server-side API BatchUpload.parseUploadData(...) will convert imported boolean fields values to
actual Booleans or will leave them as Strings.
|
IButton |
getCancelButton()
Button that cancels the uncommitted upload.
|
java.lang.String |
getCancelButtonTitle()
Title for the
cancel button. |
java.lang.String |
getCancelConfirmMessage()
Confirmation message to show if the user clicks the "Cancel" button and
warnOnCancel is true. |
IButton |
getCommitButton()
Button that commits changes once the user is happy with the data.
|
java.lang.String |
getCommitButtonTitle()
Title for the
commit button. |
java.lang.String |
getCommitConfirmationMessage()
Message to display after data has been committed, when
showCommitConfirmation is true. |
ImportFormat |
getDataFormat()
Format to assume for user-provided data.
|
java.lang.String |
getDataURL()
If set, the batchUploader will copy this value to the queue of "add" requests it sends to the server to actually
populate the data.
|
java.lang.String |
getDefaultDelimiter()
Deprecated.
in favor of
uploadDelimiter |
java.lang.String |
getDefaultQuoteString()
Deprecated.
in favor of
uploadQuoteString |
java.lang.String |
getDiscardedColumnsMessage()
Message displayed when columns in the imported file were discarded and
displayDiscardedColumns is true. |
java.lang.Boolean |
getDisplayDiscardedColumns()
If columns were present in the imported data that were discarded because they could not be matched to any DataSource
fields, whether these should be displayed to the user, using the
discardedColumnsMessage shown within the uploadStatusMessages component. |
java.lang.String |
getErrorMessageDelimiterOrEndOfLine()
Error message to show when the uploading process detects a missing delimiter or end of line after quoted value in the
first line.
|
java.lang.String |
getErrorMessageExcelFileDetected()
Error message to show when the uploading process detects an Excel File, which is not supported.
|
java.lang.String |
getErrorMessageFileIsBlank()
Error message to show when the uploading process detects a file with no data.
|
java.lang.String |
getErrorMessageInputType()
Error message to show when the uploading process detects an invalid inputType.
|
java.lang.String |
getErrorMessageRowsNotParsed()
Error message to show when the uploaded file has rows other than the first row that could not be parsed.
|
java.lang.String |
getErrorMessageUndeterminedDelimiter()
Error message to show when the uploading process is unable to detect the delimiter.
|
java.lang.String |
getErrorMessageUnterminatedQuote()
Error message to show when the uploading process detects an unterminated quote string in the first line.
|
ListGrid |
getGrid()
Grid which will show a preview of data to be uploaded, with errors flagged
|
ListGridField[] |
getGridFields()
Fields to apply to
grid. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
IButton |
getNextButton()
Button that scrolls grid to the next error.
|
java.lang.String |
getNextButtonTitle()
Title for the
next error button. |
static BatchUploader |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
PartialCommitOption |
getPartialCommit()
Specifies what action to take if the user attempts to commit a partially validated set of data (ie, one that still
contains some errors).
|
java.lang.String |
getPartialCommitConfirmationMessage()
Message to display after data has been committed, when
showCommitConfirmation is true. |
java.lang.String |
getPartialCommitError()
If
partialCommit is set to "prevent", the text to
display to the user if they try to commit a dataset containing errors. |
java.lang.String |
getPartialCommitPrompt()
If
partialCommit is set to "prompt", the text to
display to the user in the confirmation dialog. |
IButton |
getPreviousButton()
Button that scrolls grid to the previous error.
|
java.lang.String |
getPreviousButtonTitle()
Title for the
previous error button. |
DSRequest |
getRequestProperties()
Object containing properties to send with every "add" request this batchUploader sends.
|
java.lang.Boolean |
getShowCommitConfirmation()
Whether to show the
commit message after
data is successfully committed. |
java.lang.String |
getUpdatesRolledBackMessage()
Message to display if at least one update was rolled back due to errors in another row.
|
IButton |
getUploadButton()
Button that triggers the upload.
|
java.lang.String |
getUploadButtonTitle()
Title for the
upload button. |
DataSource |
getUploadDataSource()
DataSource used to save uploaded records.
|
java.lang.String |
getUploadDelimiter()
The delimiter to use when importing character-delimited files.
|
java.lang.String |
getUploadEncoding()
On server-side, BatchUploader uses
DataImport to import uploaded files, specifically APIs taking
java.io.Reader parameter. |
java.lang.String |
getUploadFieldPrefix()
String to prepend to the names of the additional fields specified in
uploadFormFields before they are stored in the
HttpSession on the server. |
FileItem |
getUploadFileItem()
FileItem for selecting the file to upload.
|
java.lang.String |
getUploadFileLabel()
Title to display next to the
FileItem field where the user enters a
filename to upload |
DynamicForm |
getUploadForm()
Form used to specify file to upload, and any additional fields required.
|
FormItem[] |
getUploadFormFields()
Optional fields for the uploadForm.
|
java.lang.String |
getUploadOperation()
Optional
DSRequest.operationId for the "add" operation used to
add new records to the uploadDataSource. |
java.lang.String |
getUploadQuoteString()
The character used to quote strings.
|
HTMLFlow |
getUploadStatusMessages()
Container for informational messages that are shown when a user attempts an upload.
|
java.lang.Boolean |
getWarnOnCancel()
If set, indicates that a warning dialog should be shown when Cancel is clicked, asking the user to confirm that this is
really what they want to do.
|
BatchUploader |
setAllRecordsInErrorMessage(java.lang.String allRecordsInErrorMessage)
Message to display when the user clicks "Commit" but there is nothing we can commit because every row in the grid has
errors
|
BatchUploader |
setAutoInterpretBooleans(java.lang.Boolean autoInterpretBooleans)
Controls if server-side API BatchUpload.parseUploadData(...) will convert imported boolean fields values to
actual Booleans or will leave them as Strings.
|
BatchUploader |
setCancelButtonTitle(java.lang.String cancelButtonTitle)
Title for the
cancel button. |
BatchUploader |
setCancelConfirmMessage(java.lang.String cancelConfirmMessage)
Confirmation message to show if the user clicks the "Cancel" button and
warnOnCancel is true. |
BatchUploader |
setCommitButtonTitle(java.lang.String commitButtonTitle)
Title for the
commit button. |
BatchUploader |
setCommitConfirmationMessage(java.lang.String commitConfirmationMessage)
Message to display after data has been committed, when
showCommitConfirmation is true. |
BatchUploader |
setDataFormat(ImportFormat dataFormat)
Format to assume for user-provided data.
|
BatchUploader |
setDataURL(java.lang.String dataURL)
If set, the batchUploader will copy this value to the queue of "add" requests it sends to the server to actually
populate the data.
|
BatchUploader |
setDefaultDelimiter(java.lang.String defaultDelimiter)
Deprecated.
in favor of
uploadDelimiter |
static void |
setDefaultProperties(BatchUploader batchUploaderProperties)
Class level method to set the default properties of this class.
|
BatchUploader |
setDefaultQuoteString(java.lang.String defaultQuoteString)
Deprecated.
in favor of
uploadQuoteString |
BatchUploader |
setDiscardedColumnsMessage(java.lang.String discardedColumnsMessage)
Message displayed when columns in the imported file were discarded and
displayDiscardedColumns is true. |
BatchUploader |
setDisplayDiscardedColumns(java.lang.Boolean displayDiscardedColumns)
If columns were present in the imported data that were discarded because they could not be matched to any DataSource
fields, whether these should be displayed to the user, using the
discardedColumnsMessage shown within the uploadStatusMessages component. |
BatchUploader |
setErrorMessageDelimiterOrEndOfLine(java.lang.String errorMessageDelimiterOrEndOfLine)
Error message to show when the uploading process detects a missing delimiter or end of line after quoted value in the
first line.
|
BatchUploader |
setErrorMessageExcelFileDetected(java.lang.String errorMessageExcelFileDetected)
Error message to show when the uploading process detects an Excel File, which is not supported.
|
BatchUploader |
setErrorMessageFileIsBlank(java.lang.String errorMessageFileIsBlank)
Error message to show when the uploading process detects a file with no data.
|
BatchUploader |
setErrorMessageInputType(java.lang.String errorMessageInputType)
Error message to show when the uploading process detects an invalid inputType.
|
BatchUploader |
setErrorMessageRowsNotParsed(java.lang.String errorMessageRowsNotParsed)
Error message to show when the uploaded file has rows other than the first row that could not be parsed.
|
BatchUploader |
setErrorMessageUndeterminedDelimiter(java.lang.String errorMessageUndeterminedDelimiter)
Error message to show when the uploading process is unable to detect the delimiter.
|
BatchUploader |
setErrorMessageUnterminatedQuote(java.lang.String errorMessageUnterminatedQuote)
Error message to show when the uploading process detects an unterminated quote string in the first line.
|
BatchUploader |
setGridFields(ListGridField... gridFields)
Fields to apply to
grid. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.BatchUploaderLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
BatchUploader |
setNextButtonTitle(java.lang.String nextButtonTitle)
Title for the
next error button. |
BatchUploader |
setPartialCommit(PartialCommitOption partialCommit)
Specifies what action to take if the user attempts to commit a partially validated set of data (ie, one that still
contains some errors).
|
BatchUploader |
setPartialCommitConfirmationMessage(java.lang.String partialCommitConfirmationMessage)
Message to display after data has been committed, when
showCommitConfirmation is true. |
BatchUploader |
setPartialCommitError(java.lang.String partialCommitError)
If
partialCommit is set to "prevent", the text to
display to the user if they try to commit a dataset containing errors. |
BatchUploader |
setPartialCommitPrompt(java.lang.String partialCommitPrompt)
If
partialCommit is set to "prompt", the text to
display to the user in the confirmation dialog. |
BatchUploader |
setPreviousButtonTitle(java.lang.String previousButtonTitle)
Title for the
previous error button. |
BatchUploader |
setRequestProperties(DSRequest requestProperties)
Object containing properties to send with every "add" request this batchUploader sends.
|
BatchUploader |
setShowCommitConfirmation(java.lang.Boolean showCommitConfirmation)
Whether to show the
commit message after
data is successfully committed. |
BatchUploader |
setUpdatesRolledBackMessage(java.lang.String updatesRolledBackMessage)
Message to display if at least one update was rolled back due to errors in another row.
|
BatchUploader |
setUploadButtonTitle(java.lang.String uploadButtonTitle)
Title for the
upload button. |
BatchUploader |
setUploadDataSource(DataSource uploadDataSource)
DataSource used to save uploaded records.
|
BatchUploader |
setUploadDelimiter(java.lang.String uploadDelimiter)
The delimiter to use when importing character-delimited files.
|
BatchUploader |
setUploadEncoding(java.lang.String uploadEncoding)
On server-side, BatchUploader uses
DataImport to import uploaded files, specifically APIs taking
java.io.Reader parameter. |
BatchUploader |
setUploadFieldPrefix(java.lang.String uploadFieldPrefix)
String to prepend to the names of the additional fields specified in
uploadFormFields before they are stored in the
HttpSession on the server. |
BatchUploader |
setUploadFileLabel(java.lang.String uploadFileLabel)
Title to display next to the
FileItem field where the user enters a
filename to upload |
BatchUploader |
setUploadFormFields(FormItem... uploadFormFields)
Optional fields for the uploadForm.
|
void |
setUploadFormItems(FormItem... items)
Synonym of
setUploadFormFields(FormItem...). |
BatchUploader |
setUploadOperation(java.lang.String uploadOperation)
Optional
DSRequest.operationId for the "add" operation used to
add new records to the uploadDataSource. |
BatchUploader |
setUploadQuoteString(java.lang.String uploadQuoteString)
The character used to quote strings.
|
BatchUploader |
setWarnOnCancel(java.lang.Boolean warnOnCancel)
If set, indicates that a warning dialog should be shown when Cancel is clicked, asking the user to confirm that this is
really what they want to do.
|
setDefaultProperties, setLogicalStructureaddMember, 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, showMemberaddChild, 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, 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, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, 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, 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, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeFonts, 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, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, 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, 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, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, 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, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic BatchUploader()
public BatchUploader(com.google.gwt.core.client.JavaScriptObject jsObj)
public static BatchUploader 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.AutoChildUsagepublic 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.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public BatchUploader setAllRecordsInErrorMessage(java.lang.String allRecordsInErrorMessage) throws java.lang.IllegalStateException
allRecordsInErrorMessage - New allRecordsInErrorMessage value. Default value is "All records have errors; nothing to commit"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getAllRecordsInErrorMessage()
public BatchUploader setAutoInterpretBooleans(java.lang.Boolean autoInterpretBooleans)
Default behavior would interpret boolean values by following rules:
autoInterpretBooleans - New autoInterpretBooleans value. Default value is trueBatchUploader instance, for chaining setter callspublic java.lang.Boolean getAutoInterpretBooleans()
Default behavior would interpret boolean values by following rules:
public IButton getCancelButton() throws java.lang.IllegalStateException
This component is an AutoChild named "cancelButton". 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 BatchUploader setCancelButtonTitle(java.lang.String cancelButtonTitle) throws java.lang.IllegalStateException
cancel button.cancelButtonTitle - New cancelButtonTitle value. Default value is "Cancel"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getCancelButtonTitle()
cancel button.public BatchUploader setCancelConfirmMessage(java.lang.String cancelConfirmMessage)
warnOnCancel is true. Defaults to "You will lose any work
you have done on this data. Proceed anyway?"cancelConfirmMessage - New cancelConfirmMessage value. Default value is See belowBatchUploader instance, for chaining setter callspublic java.lang.String getCancelConfirmMessage()
warnOnCancel is true. Defaults to "You will lose any work
you have done on this data. Proceed anyway?"public IButton getCommitButton() throws java.lang.IllegalStateException
This component is an AutoChild named "commitButton". 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 BatchUploader setCommitButtonTitle(java.lang.String commitButtonTitle) throws java.lang.IllegalStateException
commit button.commitButtonTitle - New commitButtonTitle value. Default value is "Commit"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getCommitButtonTitle()
commit button.public BatchUploader setCommitConfirmationMessage(java.lang.String commitConfirmationMessage) throws java.lang.IllegalStateException
showCommitConfirmation is true.commitConfirmationMessage - New commitConfirmationMessage value. Default value is "Records added"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getCommitConfirmationMessage()
showCommitConfirmation is true.public BatchUploader setDataFormat(ImportFormat dataFormat) throws java.lang.IllegalStateException
ImportFormat "auto" for auto-detection.dataFormat - New dataFormat value. Default value is "csv"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic ImportFormat getDataFormat()
ImportFormat "auto" for auto-detection.public BatchUploader setDataURL(java.lang.String dataURL)
dataURL - New dataURL value. Default value is nullBatchUploader instance, for chaining setter callspublic java.lang.String getDataURL()
public BatchUploader setDefaultDelimiter(java.lang.String defaultDelimiter)
uploadDelimiterdefaultDelimiter - New defaultDelimiter value. Default value is ","BatchUploader instance, for chaining setter callspublic java.lang.String getDefaultDelimiter()
uploadDelimiterpublic BatchUploader setDefaultQuoteString(java.lang.String defaultQuoteString)
uploadQuoteStringdefaultQuoteString - New defaultQuoteString value. Default value is "\""BatchUploader instance, for chaining setter callspublic java.lang.String getDefaultQuoteString()
uploadQuoteStringpublic BatchUploader setDiscardedColumnsMessage(java.lang.String discardedColumnsMessage) throws java.lang.IllegalStateException
displayDiscardedColumns is true. Within this
message, ${discardedColumns} can be used to show a comma separated list of the column names that were discarded
(example: "price, saleDate, total"). Default message is: "The following columns in your uploaded file were ignored because they did not match any of the expected column names: ${discardedColumns}"
discardedColumnsMessage - New discardedColumnsMessage value. Default value is "..."BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getDiscardedColumnsMessage()
displayDiscardedColumns is true. Within this
message, ${discardedColumns} can be used to show a comma separated list of the column names that were discarded
(example: "price, saleDate, total"). Default message is: "The following columns in your uploaded file were ignored because they did not match any of the expected column names: ${discardedColumns}"
public BatchUploader setDisplayDiscardedColumns(java.lang.Boolean displayDiscardedColumns) throws java.lang.IllegalStateException
discardedColumnsMessage shown within the uploadStatusMessages component.displayDiscardedColumns - New displayDiscardedColumns value. Default value is trueBatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getDisplayDiscardedColumns()
discardedColumnsMessage shown within the uploadStatusMessages component.public BatchUploader setErrorMessageDelimiterOrEndOfLine(java.lang.String errorMessageDelimiterOrEndOfLine) throws java.lang.IllegalStateException
errorMessageDelimiterOrEndOfLine - New errorMessageDelimiterOrEndOfLine value. Default value is "Delimiter or end of line expected after quoted value - problem found in the first line at character position: ${errorOffset}."BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageDelimiterOrEndOfLine()
public BatchUploader setErrorMessageExcelFileDetected(java.lang.String errorMessageExcelFileDetected) throws java.lang.IllegalStateException
errorMessageExcelFileDetected - New errorMessageExcelFileDetected value. Default value is "You uploaded an Excel file. Please save your data as a csv file and re-upload"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageExcelFileDetected()
public BatchUploader setErrorMessageFileIsBlank(java.lang.String errorMessageFileIsBlank) throws java.lang.IllegalStateException
errorMessageFileIsBlank - New errorMessageFileIsBlank value. Default value is "The provided file is blank. Please, provide a file with data."BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageFileIsBlank()
public BatchUploader setErrorMessageInputType(java.lang.String errorMessageInputType) throws java.lang.IllegalStateException
errorMessageInputType - New errorMessageInputType value. Default value is "Invalid inputType value was set!"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageInputType()
public BatchUploader setErrorMessageRowsNotParsed(java.lang.String errorMessageRowsNotParsed) throws java.lang.IllegalStateException
This is a
dynamic string - text within ${...} will be evaluated as JS code when the message is displayed.
The following variables are available to be used in this message:
errorMessageRowsNotParsed - New errorMessageRowsNotParsed value. Default value is "Some rows could not be parsed; the grid below shows ${goodRowCount} of ${totalRows} data rows. Row number ${firstBadRow} was the first row to fail to be parsed."BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageRowsNotParsed()
This is a
dynamic string - text within ${...} will be evaluated as JS code when the message is displayed.
The following variables are available to be used in this message:
public BatchUploader setErrorMessageUndeterminedDelimiter(java.lang.String errorMessageUndeterminedDelimiter) throws java.lang.IllegalStateException
errorMessageUndeterminedDelimiter - New errorMessageUndeterminedDelimiter value. Default value is "We were unable to guess the delimiter"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageUndeterminedDelimiter()
public BatchUploader setErrorMessageUnterminatedQuote(java.lang.String errorMessageUnterminatedQuote) throws java.lang.IllegalStateException
errorMessageUnterminatedQuote - New errorMessageUnterminatedQuote value. Default value is "Unterminated quote string - problem found in the first line at character position: ${errorOffset}."BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getErrorMessageUnterminatedQuote()
public ListGrid getGrid() throws java.lang.IllegalStateException
This component is an AutoChild named "grid". 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 BatchUploader setGridFields(ListGridField... gridFields)
grid. These will override the field
definitions in the uploadDataSource on a field by
field basis, as described under DataBoundComponent.fields.gridFields - New gridFields value. Default value is nullBatchUploader instance, for chaining setter callspublic ListGridField[] getGridFields()
grid. These will override the field
definitions in the uploadDataSource on a field by
field basis, as described under DataBoundComponent.fields.public IButton getNextButton() throws java.lang.IllegalStateException
This component is an AutoChild named "nextButton". 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 BatchUploader setNextButtonTitle(java.lang.String nextButtonTitle) throws java.lang.IllegalStateException
next error button.nextButtonTitle - New nextButtonTitle value. Default value is "Next error"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getNextButtonTitle()
next error button.public BatchUploader setPartialCommit(PartialCommitOption partialCommit)
partialCommit - New partialCommit value. Default value is "prompt"BatchUploader instance, for chaining setter callspublic PartialCommitOption getPartialCommit()
public BatchUploader setPartialCommitConfirmationMessage(java.lang.String partialCommitConfirmationMessage) throws java.lang.IllegalStateException
showCommitConfirmation is true.partialCommitConfirmationMessage - New partialCommitConfirmationMessage value. Default value is "Valid records added; some records remain in error"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getPartialCommitConfirmationMessage()
showCommitConfirmation is true.public BatchUploader setPartialCommitError(java.lang.String partialCommitError)
partialCommit is set to "prevent", the text to
display to the user if they try to commit a dataset containing errors. By default, this text is "There are errors in
your data. Please correct all errors before clicking Commit"partialCommitError - New partialCommitError value. Default value is See belowBatchUploader instance, for chaining setter callspublic java.lang.String getPartialCommitError()
partialCommit is set to "prevent", the text to
display to the user if they try to commit a dataset containing errors. By default, this text is "There are errors in
your data. Please correct all errors before clicking Commit"public BatchUploader setPartialCommitPrompt(java.lang.String partialCommitPrompt)
partialCommit is set to "prompt", the text to
display to the user in the confirmation dialog. By default, this text is "There are errors in your data so it cannot
all be saved. If you proceed, you will lose the records with errors. Click 'OK' to proceed anyway, or 'Cancel' to
return to your data"partialCommitPrompt - New partialCommitPrompt value. Default value is See belowBatchUploader instance, for chaining setter callspublic java.lang.String getPartialCommitPrompt()
partialCommit is set to "prompt", the text to
display to the user in the confirmation dialog. By default, this text is "There are errors in your data so it cannot
all be saved. If you proceed, you will lose the records with errors. Click 'OK' to proceed anyway, or 'Cancel' to
return to your data"public IButton getPreviousButton() throws java.lang.IllegalStateException
This component is an AutoChild named "previousButton". 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 BatchUploader setPreviousButtonTitle(java.lang.String previousButtonTitle) throws java.lang.IllegalStateException
previous error button.previousButtonTitle - New previousButtonTitle value. Default value is "Previous error"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getPreviousButtonTitle()
previous error button.public BatchUploader setRequestProperties(DSRequest requestProperties)
requestProperties - New requestProperties value. Default value is nullBatchUploader instance, for chaining setter callspublic DSRequest getRequestProperties()
public BatchUploader setShowCommitConfirmation(java.lang.Boolean showCommitConfirmation) throws java.lang.IllegalStateException
commit message after
data is successfully committed.showCommitConfirmation - New showCommitConfirmation value. Default value is trueBatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowCommitConfirmation()
commit message after
data is successfully committed.public BatchUploader setUpdatesRolledBackMessage(java.lang.String updatesRolledBackMessage) throws java.lang.IllegalStateException
transactions overview for details of Smart GWT's automatic
transactional updates featureupdatesRolledBackMessage - New updatesRolledBackMessage value. Default value is "One or more updates were rolled-back due to errors on other rows"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getUpdatesRolledBackMessage()
transactions overview for details of Smart GWT's automatic
transactional updates featurepublic IButton getUploadButton() throws java.lang.IllegalStateException
This component is an AutoChild named "uploadButton". 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 BatchUploader setUploadButtonTitle(java.lang.String uploadButtonTitle) throws java.lang.IllegalStateException
upload button.uploadButtonTitle - New uploadButtonTitle value. Default value is "Upload"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getUploadButtonTitle()
upload button.public BatchUploader setUploadDataSource(DataSource uploadDataSource) throws java.lang.IllegalStateException
Be careful to note that this is the DataSource representing your data as it will be persisted to your server. It is completely different from the special "batchUpload" DataSource which is used purely as a medium to upload the raw data to the server in the first place.
uploadDataSource - New uploadDataSource value. Default value is nullBatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic DataSource getUploadDataSource()
Be careful to note that this is the DataSource representing your data as it will be persisted to your server. It is completely different from the special "batchUpload" DataSource which is used purely as a medium to upload the raw data to the server in the first place.
public BatchUploader setUploadDelimiter(java.lang.String uploadDelimiter)
uploadDelimiter - New uploadDelimiter value. Default value is ","BatchUploader instance, for chaining setter callspublic java.lang.String getUploadDelimiter()
public BatchUploader setUploadEncoding(java.lang.String uploadEncoding)
DataImport to import uploaded files, specifically APIs taking
java.io.Reader parameter. BatchUploader.uploadEncoding setting defines the encoding, which
will be used to create a java.io.Reader instance to read data from uploaded files. The default is "UTF-8".uploadEncoding - New uploadEncoding value. Default value is "UTF-8"BatchUploader instance, for chaining setter callspublic java.lang.String getUploadEncoding()
DataImport to import uploaded files, specifically APIs taking
java.io.Reader parameter. BatchUploader.uploadEncoding setting defines the encoding, which
will be used to create a java.io.Reader instance to read data from uploaded files. The default is "UTF-8".public BatchUploader setUploadFieldPrefix(java.lang.String uploadFieldPrefix)
uploadFormFields before they are stored in the
HttpSession on the server. This property provides a basic namespace facility, allowing you to avoid name collisions
with existing session attributes. Example usage: if you have an additional field called "someDate" and you set uploadFieldPrefix to "myFields_", your additionalFormField will be available as an HttpSession attribute called "myFields_someDate"
uploadFieldPrefix - New uploadFieldPrefix value. Default value is nullBatchUploader instance, for chaining setter callspublic java.lang.String getUploadFieldPrefix()
uploadFormFields before they are stored in the
HttpSession on the server. This property provides a basic namespace facility, allowing you to avoid name collisions
with existing session attributes. Example usage: if you have an additional field called "someDate" and you set uploadFieldPrefix to "myFields_", your additionalFormField will be available as an HttpSession attribute called "myFields_someDate"
public FileItem getUploadFileItem() throws java.lang.IllegalStateException
This component is an AutoChild named "uploadFileItem". 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 BatchUploader setUploadFileLabel(java.lang.String uploadFileLabel) throws java.lang.IllegalStateException
FileItem field where the user enters a
filename to uploaduploadFileLabel - New uploadFileLabel value. Default value is "Upload File"BatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getUploadFileLabel()
FileItem field where the user enters a
filename to uploadpublic DynamicForm getUploadForm() throws java.lang.IllegalStateException
This component is an AutoChild named "uploadForm". 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 BatchUploader setUploadFormFields(FormItem... uploadFormFields) throws java.lang.IllegalStateException
uploadFormFields - New uploadFormFields value. Default value is nullBatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic FormItem[] getUploadFormFields()
public BatchUploader setUploadOperation(java.lang.String uploadOperation) throws java.lang.IllegalStateException
DSRequest.operationId for the "add" operation used to
add new records to the uploadDataSource.uploadOperation - New uploadOperation value. Default value is nullBatchUploader instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getUploadOperation()
DSRequest.operationId for the "add" operation used to
add new records to the uploadDataSource.public BatchUploader setUploadQuoteString(java.lang.String uploadQuoteString)
uploadQuoteString - New uploadQuoteString value. Default value is "\""BatchUploader instance, for chaining setter callspublic java.lang.String getUploadQuoteString()
public HTMLFlow getUploadStatusMessages() throws java.lang.IllegalStateException
grid.
This component is an AutoChild named "uploadStatusMessages". 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 BatchUploader setWarnOnCancel(java.lang.Boolean warnOnCancel)
cancelConfirmMessagewarnOnCancel - New warnOnCancel value. Default value is trueBatchUploader instance, for chaining setter callspublic java.lang.Boolean getWarnOnCancel()
cancelConfirmMessagepublic com.google.gwt.event.shared.HandlerRegistration addBeforeCommitHandler(BeforeCommitHandler handler)
Notification method fired when the BatchUploader.commitButton is clicked.
This notification occurs before actually committing data to the server. It allows to make changes to the data after user edits, but before it will be sent to server.
Read also BatchUploader.previewShown() docs for details how to
change data in grid and for possibility to interrupt upload process on the server as well.
addBeforeCommitHandler in interface HasBeforeCommitHandlershandler - the beforeCommit handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addPreviewShownHandler(PreviewShownHandler handler)
Notification method fired when the BatchUploader.grid is
populated with a new set of data for the user to preview before commit.
This notification occurs after the user has
uploaded a new data file, the data has been processed on the server, and the preview grid populated with the data ready
for committing. Developers may use this notification to examine or modify the data set to be uploaded. The ListGrid.data object will be populated with the array of uploaded
records, and standard grid APIs such as ListGrid.getRowErrors(), ListGrid.setEditValue(), etc
may be used to interact with this data.
Note that developers wishing to manipulate the uploaded data can also do
this on the server side when user hits the commit button to submit the data to the BatchUploader.uploadDataSource. This can be achieved by
setting the BatchUploader.uploadOperation to call
a custom "add" type operation on the target
dataSource.
addPreviewShownHandler in interface HasPreviewShownHandlershandler - the previewShown handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(BatchUploader batchUploaderProperties)
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.
batchUploaderProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic void setUploadFormItems(FormItem... items) throws java.lang.IllegalStateException
setUploadFormFields(FormItem...).java.lang.IllegalStateExceptionpublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.BatchUploaderLogicalStructure 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 LogicalStructuregetLogicalStructure in class VStack