BUIRender class
- Inheritance
- Available extensions
Constructors
-
BUIRender(Element? parent, {dynamic source, DOMGenerator<
UINode> ? domGenerator, DataAssets? dataAssets, BUIViewProviderBase? viewProvider, dynamic classes, dynamic style, bool renderOnConstruction = true})
Properties
- clearParent → UIComponentClearParent?
-
finalinherited
- componentInternals → UIComponentInternals
-
no setterinherited
- constructing → bool?
-
no setterinherited
- content → UIElement?
-
no setterinherited
- currentRoute → String?
-
The current route rendered by this component.
no setteroverride
-
currentRouteParameters
→ Map<
String, String> ? -
The current route parameters used to rendered this component.
no setterinherited
- currentTitle ↔ String
-
getter/setter pairinherited
- dataAssets → DataAssets?
-
no setter
- dataSource → DataSource?
-
no setterinherited
- dataSourceCall ↔ DataSourceCall?
-
getter/setter pairinherited
- dataSourceCallString → String
-
no setterinherited
- findRoutes ↔ bool?
-
getter/setter pairinherited
- globalID → int
-
finalinherited
- hasDataSource → bool
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasIntlMessages → bool
-
no setter
- id ↔ dynamic
-
getter/setter pairinherited
- isInDOM → bool
-
no setterinherited
- isIntlLoaded → bool
-
no setter
- 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
-
List of routes (not hidden from menu) that this component can navigateTo.
no setterinherited
-
Returns a Map of routes (not hidden from menu) and respective names.
no setterinherited
-
getter/setter pair
-
no setter
- onChange ↔ EventStream
-
getter/setter pairinherited
-
onChangeRoute
→ EventStream<
String> -
finalinherited
-
onChangeSource
→ EventStream<
BUIRender> -
final
-
onRender
→ EventStream<
UIComponent> -
finalinherited
-
onRenderChildComponent
→ EventStream<
UIComponent> -
final
- parent → UIElement?
-
no setterinherited
- parentUIComponent → UIComponent?
-
The parent UIComponent.
no setterinherited
- preserveRender ↔ bool
-
If
true
will preserve last render in next calls to render.getter/setter pairinherited - preserveRenderCount → int
-
no setterinherited
-
getter/setter pairinherited
- renderContainer ↔ Element?
-
getter/setter pair
- renderCount → int
-
no setterinherited
-
renderDomGenerator
→ DOMGenerator<
UINode> -
final
- renderedElements → List?
-
no setterinherited
- renderedRoot → Element?
-
no setter
- renderedTreeMap → DOMTreeMap?
-
no setter
- renderSource → BUIRenderSource?
-
no setter
- renderViewportElement → DivElement?
-
no setter
-
routes
→ List<
String> -
List of routes that this component can navigateTo.
no setterinherited
-
routesAndNames
→ Map<
String, String> -
Returns a Map of routes and respective names.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- source ↔ dynamic
-
getter/setter pair
-
subUIComponents
→ List<
UIComponent> -
Returns a List of sub UIComponent.
no setterinherited
-
subUIComponentsDeeply
→ List<
UIComponent> -
Returns a List of sub UIComponent deeply in the tree.
no setterinherited
- 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 - viewProvider ↔ BUIViewProviderBase?
-
getter/setter pair
Methods
-
action(
String action) → void -
inherited
-
addTo(
UIElement parent, {UIComponent? parentUIComponent}) → void -
inherited
-
appendAttribute(
String? name, dynamic value) → bool -
inherited
-
appendAttributes(
Iterable< DOMAttribute> attributes) → bool -
inherited
-
appendClasses(
dynamic classes1, [dynamic classes2]) → void -
inherited
-
appendStyle(
dynamic style1, [dynamic style2, dynamic style3]) → void -
inherited
-
appendToContent(
List< UINode> nodes) → bool -
inherited
-
applyData(
dynamic data) → bool -
inherited
-
callRender(
[bool clear = false]) → void -
inherited
-
callRenderAndWait(
{Duration timeout = const Duration(seconds: 3)}) → Future< bool> -
inherited
-
callRenderAsync(
) → void -
inherited
-
canHandleNewRoute(
String route) → bool -
override
-
Returns
true
if this instance can navigate toroute
.inherited -
clear(
{bool force = false, bool removeFromParent = false}) → void -
Clears the component, removing the last rendered content.
inherited
-
clearAttribute(
String? name) → bool -
inherited
-
clearContent(
) → bool -
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.
inherited
-
configureClasses(
dynamic classes1, [dynamic classes2, dynamic componentClasses]) → void -
inherited
-
configureID(
) → void -
inherited
-
configureStyle(
dynamic style1, [dynamic style2, dynamic componentStyle]) → void -
inherited
-
connectDataSource(
) → void -
inherited
-
createContentElement(
bool inline) → UIElement -
inherited
-
delete(
) → void -
inherited
-
deniedAccessRoute(
) → String? -
inherited
-
deniedAccessRouteOfRoute(
String route) → String? -
Should return the route to redirect if
route
is not accessible.inherited -
deviceSizeChangedFromLastRender(
{double tolerance = 0.10, bool onlyWidth = false, bool onlyHeight = false}) → bool -
inherited
-
ensureIntlMessagesLoaded(
) → Future< bool> -
ensureRendered(
[bool force = false]) → void -
inherited
-
findChildDeep(
FilterElement filter) → List< UIElement> -
inherited
-
findChildrenDeep(
String fieldName) → MapEntry< String, Object> ? -
inherited
-
findInContentChildDeep(
FilterElement filter) → UIElement? -
inherited
-
findUIComponentByChild(
UIElement? child) → UIComponent? -
inherited
-
findUIComponentByContent(
UIElement? content) → UIComponent? -
inherited
-
findUIComponentByID(
String id) → UIComponent? -
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) → dynamic -
inherited
-
getComponentFieldName(
Object obj) → String? -
inherited
-
getContentChildren(
{FilterElement? filter, bool deep = true}) → List< UIElement> -
inherited
-
getElementFieldName(
UIElement element) → String? -
inherited
-
getEmptyFields(
) → List< String> -
inherited
-
getField(
String? fieldName, [String? def]) → String? -
inherited
-
getFieldAs<
T> (String? fieldName, [T? def]) → T? -
inherited
-
getFieldComponent(
String? fieldName) → Object? -
inherited
-
getFieldElement<
E extends UIElement> (String? fieldName) → E? -
inherited
-
getFieldElementByValue(
String? fieldName, String value) → UIElement? -
inherited
-
getFieldElements(
String? fieldName) → List< UIElement> -
inherited
-
getFieldExtended<
V> (String? fieldName, [V? def]) → V? -
inherited
-
getFields(
{List< String> ? fields, List<String> ? ignoreFields}) → 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}) → 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
-
getMappedDOMNodeInTreeMap(
dynamic element) → DOMNode? -
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]) → List< UIComponent> -
inherited
-
getRenderedUIComponentsByIds<
T extends UIComponent> (List ids, [bool? deep]) → List< UIComponent> -
inherited
-
getRouteName(
String route) → String? -
Returns a
route
name.override -
hasEmptyField(
) → bool -
inherited
-
hide(
) → void -
Hide component.
inherited
-
insertTo(
int index, UIElement parent, {UIComponent? parentUIComponent}) → void -
inherited
-
isAccessible(
) → bool -
inherited
-
isAccessibleRoute(
String route) → bool -
Should return
true
ifroute
isAccessible.inherited -
isEmptyField(
String? fieldName) → bool -
inherited
-
isRouteHiddenFromMenu(
String route) → bool -
Returns
true
ofroute
should be hidden from menu.override -
markRenderedWithError(
) → void -
Marks current/last render with error.
inherited
-
Changes the current selected
route
, withparameters
, of this UINavigableComponent.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyChangeRoute(
) → void -
inherited
-
notifySourceChange(
) → void -
onChildRendered(
UIComponent child) → void -
override
-
onPreConstruct(
) → void -
Called in the beginning of constructor.
inherited
-
parseChildElementValue(
UIElement? childElement, {UIComponent? childUiComponent, bool allowTextAsValue = true}) → String? -
inherited
-
posAsyncRender(
) → void -
inherited
-
posRender(
) → void -
Called after render.
inherited
-
preRender(
) → void -
Called before render.
inherited
-
preRenderClear(
) → void -
override
-
querySelector<
E extends UIElement> (String? selectors) → E? -
Alias to
content.querySelector
.inherited -
querySelectorAll<
T extends UIElement> (String? selectors) → List< T> -
Alias to
content.querySelectorAll
.inherited -
rebuildSourceFromDOMTreeMap(
{bool withIndent = false, String indent = ' '}) → bool -
refresh(
{bool forceRender = false}) → void -
Refreshes the component, calling render.
inherited
-
refreshDataSource(
) → void -
inherited
-
refreshIfLocaleChanged(
) → void -
inherited
-
refreshInternal(
) → void -
inherited
-
registerEventListener(
String type, UIEventListener listener) → void -
inherited
-
registerInUIRoot(
) → void -
Called by constructor to register this component in the UIRoot tree.
inherited
-
render(
) → dynamic -
Renders the elements of this component.
inherited
-
renderError(
dynamic error) → dynamic -
Called when render returns a
Future
value, to render the content when Future has an error.inherited -
renderLoading(
) → dynamic -
Called when render returns a Future value, to render the content
while loading
Future
.inherited -
renderRoute(
String? route, Map< String, String> ? parameters) → dynamic -
Called to render the
route
withparameters
.override -
renderThumbnail(
{String? renderedHTML, bool includeDocumentStyles = true, String? styles, int? width = 800, int? height = 600}) → Future< ImageElement?> -
requestRefresh(
) → void -
Requests a refresh using Future.microtask.
inherited
-
resolveTextIntl(
String text) → String -
Resolves
text
{{intl:key}}
messages.inherited -
selectElement<
E extends UIElement> (String? selectors) → E? -
Alias to
content.querySelector
.inherited -
selectElements<
T extends UIElement> (String? selectors) → List< T> -
Alias to
content.querySelectorAll
.inherited -
selectElementsValues<
T extends UIElement> (String? selectors) → Map< String, String?> -
Alias to
content.querySelectorAll
.inherited -
setAttribute(
String? name, dynamic value) → bool -
inherited
-
setAttributes(
Iterable< DOMAttribute> attributes) → bool -
inherited
-
setContentNodes(
List< UINode> nodes) → bool -
inherited
-
setCurrentRoute(
String? route) → void -
setData(
dynamic data) → bool -
inherited
-
setField(
String fieldName, dynamic value) → void -
inherited
-
setID(
Object? id) → void -
inherited
-
setParent(
UIElement parent, {UIComponent? parentUIComponent}) → UIElement? -
Sets the
parent
UIElement
.inherited -
setRoutes(
List< String> ? routes) → void -
inherited
-
show(
) → void -
Show component.
inherited
-
toContentElements(
dynamic rendered, {bool append = false, bool parseAttributes = true}) → List -
inherited
-
toRenderableList(
Object? list, [DOMContext< UINode> ? domContext]) → List? -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateRenderedFieldElementValue(
UIElement fieldElem) → void -
inherited
-
updateRenderedFieldValue(
String fieldName) → void -
inherited
-
updateRoutes(
[List< String> ? foundRoutes]) → bool -
override
-
updateSourceFromDOMTreeMap(
) → void -
updateSourcesFromViewProvider(
) → void -
waiteRender(
{Duration timeout = const Duration(seconds: 3)}) → Future< bool> -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
assetPathResolver(
DataAssets? dataAssets, String? url) → String?