UIButtonCapturePhoto class

A Button that captures a photo. See UICapture.

Inheritance
Available extensions

Constructors

UIButtonCapturePhoto(Element? parent, {String? text, CaptureType captureType = CaptureType.photo, dynamic buttonContent, String? fieldName, double? captureAspectRatio, int? captureMaxWidth, int? captureMaxHeight, CaptureDataFormat captureDataFormat = CaptureDataFormat.arrayBuffer, bool editCapture = false, CapturePhotoEditor? photoEditor, Object? selectedFileData, String? navigate, Map<String, String>? navigateParameters, ParametersProvider? navigateParametersProvider, dynamic classes, dynamic classes2, dynamic componentClass, dynamic style, bool small = false, String? fontSize})

Properties

acceptFilesExtensions → Set<String>?
no setterinherited
buttonContent → dynamic
final
captureAspectRatio ↔ double?
The aspect ratio of a captured image. It's the ratio of its width to its height. For example:
getter/setter pairinherited
captureDataFormat ↔ CaptureDataFormat
getter/setter pairinherited
captureMaxHeight ↔ int?
The maximum height of the captured photo. See captureType.
getter/setter pairinherited
captureMaxWidth ↔ int?
The maximum width of the captured photo. See captureType.
getter/setter pairinherited
captureType → CaptureType
finalinherited
clearParent → UIComponentClearParent?
finalinherited
componentInternals → UIComponentInternals
no setterinherited
constructing → bool?
no setterinherited
content → HTMLElement?
no setterinherited
dataEncoding ↔ Encoding?
getter/setter pairinherited
dataSource → DataSource?
no setterinherited
dataSourceCall ↔ DataSourceCall?
getter/setter pairinherited
dataSourceCallString → String
no setterinherited
disabled ↔ bool
getter/setter pairinherited
disposeCount → int
no setterinherited
domTreeMap → DOMTreeMap<UINode>
DOMTreeMap for this component (lazily-created).
no setterinherited
domTreeMapIfInitialized → DOMTreeMap<UINode>?
Returns the DOMTreeMap if it has already been initialized.
no setterinherited
editCapture → bool
finalinherited
eventListeners → List<MapEntry<String, List<UIEventListener>>>
no setterinherited
fieldName → String
finalinherited
fontSize → String?
final
globalID → int
finalinherited
hasDataSource → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasSelectedFile → bool
no setterinherited
hasSelectedFileData → bool
no setterinherited
id ↔ dynamic
getter/setter pairinherited
isDisposed → bool
Whether this instance has been disposed.
no setterinherited
isInDOM → bool
no setterinherited
isLoadingUIAsyncContent → bool
no setterinherited
isRefreshFromExternalCall → bool
no setterinherited
isRendered → bool
no setterinherited
isRenderedWithError → bool
Returns true if current/last render had errors.
no setterinherited
isRendering → bool
no setterinherited
isShowing → bool
no setterinherited
localeChangedFromLastRender → bool
no setterinherited
onCapture → EventStream<UICapture>
finalinherited
onCaptureData → EventStream<UICapture>
finalinherited
onChange → EventStream
no setterinherited
onClick → EventStream<MouseEvent>
finalinherited
onlyShowSelectedImageInButton ↔ bool
getter/setter pair
onRender → EventStream<UIComponent>
no setterinherited
parent → UIElement?
no setterinherited
parentUIComponent → UIComponent?
The parent UIComponent.
no setterinherited
photoEditor → CapturePhotoEditor?
finalinherited
photoScaleMimeType ↔ String?
MimeType to use when scaling a captured photo. Usually 'image/png', 'image/jpeg' or 'image/webp'. Default: 'image/jpeg' See captureMaxWidth and captureMaxHeight.
getter/setter pairinherited
photoScaleQuality ↔ double
Image quality to use when scaling a captured photo. Used when photoScaleMimeType is 'image/jpeg' or 'image/webp'. Default: 0.98 See captureMaxWidth and captureMaxHeight.
getter/setter pairinherited
preserveRender ↔ bool
If true will preserve last render in next calls to render.
getter/setter pairinherited
preserveRenderCount → int
no setterinherited
refreshOnNavigate ↔ bool
getter/setter pairinherited
removeExifFromImage ↔ bool
If true will remove the Exif data from the captured data. Default true since not all popular browsers can't handle Exif yet. This is useful to avoid issues with device orientation and image rotation.
getter/setter pairinherited
renderCount → int
no setterinherited
renderedElements → List<Object>?
no setterinherited
renderedElementsAsync → bool
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedFile → File?
no setterinherited
selectedFileData ↔ Object?
Sets the file data. Accepted formats:
getter/setter pairinherited
selectedFileDataAsArrayBuffer → Uint8List?
no setterinherited
selectedFileDataAsBase64 → String?
no setterinherited
selectedFileDataAsDataURLBase64 → String?
no setterinherited
selectedFileDataAsString → String?
no setterinherited
selectedFileDataAsURLOrDataURLBase64 → String?
no setterinherited
selectedImageClasses ↔ List<String>?
getter/setter pair
selectedImageMaxHeight ↔ int
getter/setter pair
selectedImageMaxWidth ↔ int
getter/setter pair
selectedImageStyle ↔ String?
getter/setter pair
showSelectedImageInButton ↔ bool
getter/setter pair
subUIComponents → List<UIComponent>
Returns a List of sub UIComponent.
no setterinherited
subUIComponentsDeeply → Iterable<UIComponent>
Returns a List of sub UIComponent deeply in the tree.
no setterinherited
text → String?
final
uiRoot → UIRoot?
Returns the UIRoot that is parent of this UIComponent instance, or null if it's not in an UIRoot components tree.
no setterinherited
uiRootComponent → UIRootComponent?
Returns the UIRootComponent that is parent of this UIComponent instance, or null if it's not in an UIRoot components tree.
no setterinherited

Methods

action(String action) → void
inherited
addAcceptFileExtension(String extension) → void
inherited
addEventListener(String type, UIEventListener listener) → void
inherited
addTo(UIElement parent, {UIComponent? parentUIComponent}) → void
inherited
addTrackedEventListener<T extends EventTarget, E extends Event>(T target, EventType<E> type, EventCallback<E> callback) → RegisteredEventListener
inherited
appendAttribute(String? name, dynamic value) → bool
inherited
appendAttributes(Iterable<DOMAttribute> attributes) → bool
inherited
appendClasses(Object? classes1, [Object? classes2]) → void
inherited
appendStyle(Object? style1, [Object? style2, Object? style3]) → void
inherited
appendToContent(List<UINode> nodes) → bool
inherited
applyData(dynamic data) → bool
inherited
callRender({bool clear = false, bool clearPreservedRender = false}) → void
inherited
callRenderAndWait({Duration timeout = const Duration(seconds: 3)}) → Future<bool>
inherited
callRenderAsync() → void
inherited
cancelNavigate() → void
inherited
cancelRegisteredEventListeners() → void
inherited
clear({bool force = false, bool removeFromParent = false}) → void
Clears the component, removing the last rendered content.
inherited
clearAcceptFilesExtensions() → void
inherited
clearAttribute(String? name) → bool
inherited
clearContent() → bool
inherited
clearEventListeners() → void
inherited
clearPreservedRender() → void
Clears previous rendered elements. Only relevant if preserveRender is true.
inherited
click() → void
Calls: content.click
inherited
clone() → UIComponent?
inherited
configure() → void
Called by constructor, to configure this component.
override
configureClasses(Object? classes1, [Object? classes2, Object? componentClasses]) → void
inherited
configureID() → void
inherited
configureStyle(Object? style1, [Object? style2, Object? componentStyle]) → void
inherited
connectDataSource() → void
inherited
containsAcceptFileExtension(String extension) → bool
inherited
createContentElement(bool inline) → HTMLElement
inherited
delete() → void
inherited
deniedAccessRoute() → String?
inherited
deviceSizeChangedFromLastRender({double tolerance = 0.10, bool onlyWidth = false, bool onlyHeight = false}) → bool
inherited
dispose() → void
Disposes this instance and releases all associated resources.
inherited
ensureRendered([bool force = false]) → void
inherited
findChildDeep(FilterElement filter) → List<UIElement>
inherited
findChildrenDeep(String fieldName, {bool resolveUIComponents = true}) → MapEntry<String, Object>?
inherited
findInContentChildDeep(FilterElement filter) → UIElement?
inherited
findUIComponentByChild(UIElement? child) → UIComponent?
inherited
findUIComponentByContent(UIElement? content) → UIComponent?
inherited
findUIComponentByID(String id) → UIComponent?
inherited
fireClickEvent(MouseEvent event, [List? params]) → void
inherited
fireEvent(String type, dynamic event, [List? params]) → void
inherited
focusField(String? fieldName) → bool
inherited
forEachEmptyFieldComponent(ForEachComponent f) → int
inherited
forEachEmptyFieldElement(ForEachElement f) → int
inherited
forEachFieldComponent(ForEachComponent f) → int
inherited
forEachFieldElement(ForEachElement f) → int
inherited
getAllRenderedElements(FilterRendered filter, [bool deep = false]) → List?
inherited
getAttribute(String? name) → String?
inherited
getAudioFileReader() → AudioFileReader?
inherited
getComponentFieldName(Object obj) → String?
inherited
getContentChildren({FilterElement? filter, bool deep = true}) → List<UIElement>
inherited
getElementFieldName(UIElement element, {bool resolveUIComponents = true}) → String?
inherited
getEmptyFields() → List<String>
inherited
getField(String? fieldName, [String? def]) → String?
inherited
getFieldAs<T>(String? fieldName, [T? def]) → T?
inherited
getFieldComponent(String? fieldName, {bool resolveUIComponents = true}) → Object?
inherited
getFieldElementByValue(String? fieldName, String value, {bool resolveUIComponents = true}) → UIElement?
inherited
getFieldElementNonTyped(String? fieldName) → Element?
inherited
getFieldElements(String? fieldName) → List<UIElement>
inherited
getFieldElementTyped<E extends HTMLElement>(String? fieldName, Web<E> webType) → E?
inherited
getFieldExtended<V>(String? fieldName, [V? def]) → V?
inherited
getFields({List<String>? fields, List<String>? ignoreFields, bool resolveUIComponents = true}) → Map<String, String?>
inherited
getFieldsComponents() → List<Object>
inherited
getFieldsComponentsMap({List<String>? fields, List<String>? ignoreFields}) → Map<String, Object>
inherited
getFieldsElements() → List<UIElement>
inherited
getFieldsElementsMap({List<String>? fields, List<String>? ignoreFields, bool resolveUIComponents = true}) → Map<String, UIElement>
inherited
getFieldsExtended({List<String>? fields, List<String>? ignoreFields}) → Map<String, Object?>
inherited
getFieldsGroupByPrefix<K, V>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, K keyAs(String key)?, V? valueAs(String key)?, bool filter(K key, V? value)?}) → Map<K, V?>
inherited
getFieldsGroupCheckedKeys<K>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, K keyAs(String key)?}) → List<K>
inherited
getFieldsGroupChecks<K>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, K keyAs(String key)?, bool filter(K key, bool? value)?}) → Map<K, bool>
inherited
getFieldsGroupEntriesByPrefix<K, V>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, K keyAs(String key)?, V? valueAs(String key)?, bool filter(K key, V? value)?}) → List<MapEntry<K, V?>>
inherited
getFieldsGroupKeysByPrefix<K>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, K keyAs(String key)?, bool filter(K key, Object? value)?}) → List<K>
inherited
getFieldsGroupListByPrefix<K, V>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, K keyAs(String key)?, V? valueAs(String key)?, bool filter(K key, V? value)?}) → Map<K, List<V>>
inherited
getFieldsGroupValuesByPrefix<V>(String groupPrefix, {Map<String, String?>? fields, String keyDelimiter = '_', String keyPart(String key)?, V? valueAs(String key)?, bool filter(Object key, V? value)?}) → List<V>
inherited
getFieldsNames() → List<String>
inherited
getFieldValue() → String?
inherited
getImageFileReader() → ImageFileReader?
inherited
getInputCapture() → Element?
inherited
getInputFile() → File?
inherited
getPreviousRenderedFieldValue(String? fieldName) → dynamic
inherited
getRenderedElement(FilterRendered filter, [bool? deep]) → dynamic
inherited
getRenderedElementById(dynamic id, [bool deep = false]) → dynamic
inherited
getRenderedElementValueById(dynamic id, [bool deep = false]) → dynamic
inherited
getRenderedUIComponentById<T extends UIComponent>(dynamic id, [bool? deep]) → T?
inherited
getRenderedUIComponentByType<T>([bool? deep]) → List<T>
inherited
getRenderedUIComponents([bool? deep]) → Iterable<UIComponent>
inherited
getRenderedUIComponentsByIds<T extends UIComponent>(List ids, [bool? deep]) → List<UIComponent>
inherited
getVideoFileReader() → VideoFileReader?
inherited
hasEmptyField() → bool
inherited
hide() → void
Hide component.
inherited
insertTo(int index, UIElement parent, {UIComponent? parentUIComponent}) → void
inherited
isAccessible() → bool
inherited
isEmptyField(String? fieldName) → bool
inherited
isFileAudio() → bool
inherited
isFileImage() → bool
inherited
isFileVideo() → bool
inherited
markRenderedWithError() → void
Marks current/last render with error.
inherited
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onCaptureFile(HTMLInputElement input, Event event) → void
override
onChildRendered(UIComponent child) → void
inherited
onClickEvent(dynamic event, List? params) → void
inherited
onPreConstruct() → void
Called in the beginning of constructor.
inherited
parseChildElementValue(UIElement? childElement, {UIComponent? childUiComponent, bool allowTextAsValue = true, bool resolveUIComponents = true}) → String?
inherited
posAsyncRender() → void
inherited
posRender() → void
Called after render.
override
preRender() → void
Called before render.
inherited
preRenderClear() → void
inherited
querySelectorAllNonTyped(String? selectors) → List<Element>
Alias to content.querySelectorAll.
inherited
querySelectorAllTyped<T extends UIElement>(String? selectors, Web<T> webType) → List<T>
Alias to content.querySelectorAll.
inherited
querySelectorNonTyped(String? selectors) → Element?
Alias to content.querySelector.
inherited
querySelectorTyped<E extends Element>(String? selectors, Web<E> webType) → E?
Alias to content.querySelector.
inherited
refresh({bool forceRender = false, bool clearPreservedRender = false}) → void
Refreshes the component, calling render.
inherited
refreshDataSource() → void
inherited
refreshIfLocaleChanged() → void
inherited
refreshInternal() → void
inherited
registerClickListener(UIEventListener listener) → void
inherited
registerInUIRoot() → void
Called by constructor to register this component in the UIRoot tree.
inherited
removeAcceptFileExtension(String extension) → bool
inherited
removeEventListener(String type) → void
inherited
render() → dynamic
Renders the elements of this component.
inherited
renderButton() → dynamic
override
renderError(dynamic error) → dynamic
Called when render returns a Future value, to render the content when Future has an error.
inherited
renderHidden() → String
inherited
renderLoading() → dynamic
Called when render returns a Future value, to render the content while loading Future.
inherited
renderTestUI({int ms = 100}) → Future<int>

Available on UIComponent, provided by the TestUIComponentExtension extension

requestRefresh({Duration? delay, bool clearPreservedRender = false}) → void
Requests a refresh using Future.microtask or Future.delayed.
inherited
resolveTextIntl(String text) → String
Resolves text {{intl:key}} messages.
inherited
select(String? selectors) → Element?

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

selectAll(String? selectors) → List<Element>

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

selectAllTyped<E extends Element>(String? selectors, Web<E> webType) → List<E>

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

selectElementNonTyped(String? selectors) → Element?
Alias to content.querySelector.
inherited
selectElementsNonTyped(String? selectors) → List<Element>
Alias to content.querySelectorAll.
inherited
selectElementsNonTypedValues(String? selectors) → Map<String, String?>
Alias to content.querySelectorAll.
inherited
selectElementsTyped<T extends UIElement>(String? selectors, Web<T> webType) → List<T>
Alias to content.querySelectorAll.
inherited
selectElementsTypedValues<T extends UIElement>(String? selectors, Web<T> webType) → Map<String, String?>
Alias to content.querySelectorAll.
inherited
selectElementTyped<E extends UIElement>(String? selectors, Web<E> webType) → E?
Alias to content.querySelector.
inherited
selectExpected(String? selectors) → Element

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

selectExpectedTyped<E extends UIElement>(String? selectors, Web<E> webType) → E

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

selectTyped<E extends UIElement>(String? selectors, Web<E> webType) → E?

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

setAttribute(String? name, dynamic value) → bool
inherited
setAttributes(Iterable<DOMAttribute> attributes) → bool
inherited
setContentNodes(List<UINode> nodes) → bool
inherited
setData(dynamic data) → bool
inherited
setDataEncodingToLatin1() → void
inherited
setDataEncodingToUTF8() → void
inherited
setField(String fieldName, dynamic value) → void
inherited
setFieldValue(String? value) → void
inherited
setID(Object? id) → void
inherited
setNormalButton() → void
setParent(UIElement parent, {UIComponent? parentUIComponent}) → UIElement?
Sets the parent UIElement.
inherited
setWideButton() → void
show() → void
Show component.
inherited
showSelectedImage() → void
simplify({bool trim = true, bool collapseSpaces = true, bool lowerCase = true, String nullValue = ''}) → String

Available on UIComponent?, provided by the TestUIComponentNullableExtension extension

toContentElements(dynamic rendered, {bool append = false, bool parseAttributes = true}) → List<Object>
inherited
toRenderableList(Object? list, [DOMContext<UINode>? domContext]) → List<Object>?
inherited
toString() → String
A string representation of this object.
inherited
trackAllRegisteredEventListeners(List<RegisteredEventListener> registeredEventListener) → void
inherited
trackRegisteredEventListener(RegisteredEventListener registeredEventListener) → void
inherited
untrackRegisteredEventListener(RegisteredEventListener registeredEventListener) → bool
inherited
updateRenderedFieldElementValue(UIElement fieldElem) → void
inherited
updateRenderedFieldValue(String fieldName) → void
inherited
waiteRender({Duration timeout = const Duration(seconds: 3)}) → Future<bool>
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited