kw.UploadProgressDisplay Class

Members

kw.UploadProgressDisplay (Object)

Constructs and returns the UploadProgressDisplay represented by the specified settings object.

Setting Attributes

• element (element) – The DOM element to use as a container for this UploadProgressDisplay. If the id attribute isn't specified, it will be set to the id of this DOM element.
• fileSizeFormatter (Function) – The function to use to format file sizes. Default value: kw.defaultFileSizeFormatter.
• hideAfterUpload (Boolean) – A boolean that specifies whether the UploadProgressDisplay should automatically hide itself after an upload. Default value: true.
• id (String) – The unique id for this UploadProgressDisplay. If the element attribute isn't specified, this must match a DOM id.
• percentFormatter (Function) – The function to use to format numbers to percent. Default value: kw.defaultPercentFormatter.
• showDuringUpload (Boolean) – A boolean that specifies whether the UploadProgressDisplay should automatically display itself during an upload. Default value: true.
• timeFormatter (Function) – The function to use to format numbers of seconds to time strings. Default value: kw.defaultTimeFormatter.
• uploadConnector (kw.UploadConnector) – The UploadConnector for which to display progress updates. This can be either the actual UploadConnector object, or the String id that the UploadConnector was created with.

get_Element()

Returns the DOM element that is used as a container for this UploadProgressDisplay.

Return Value

• element – The the DOM element that is used as a container for this UploadProgressDisplay.

get_FileSizeFormatter()

Returns the function to use to format file sizes.

Return Value

• Function – The function to use to format file sizes.

get_HideAfterUpload()

Returns a boolean that specifies whether the UploadProgressDisplay should automatically hide itself after an upload.

Return Value

• Boolean – A boolean that specifies whether the UploadProgressDisplay should automatically hide itself after an upload.

get_Id()

Returns the id of this UploadProgressDisplay.

Return Value

• String – The id of this UploadProgressDisplay.

get_PercentFormatter()

Returns the function to use to format numbers to percent.

Return Value

• Function – The function to use to format numbers to percent.

get_ShowDuringUpload()

Returns a boolean that specifies whether the UploadProgressDisplay should automatically show itself during an upload.

Return Value

• Boolean – A boolean that specifies whether the UploadProgressDisplay should automatically show itself during an upload.

get_TimeFormatter()

Returns the function to use to format numbers of seconds to time strings.

Return Value

• Function – The function to use to format numbers of seconds to time strings.

get_UploadConnector()

Returns the UploadConnector for which to display progress updates.

Return Value

• kw.UploadConnector – The UploadConnector for which to display progress updates.