{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/furo-ui5-barcode-scanner-dialog.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-barcode-scanner-dialog' component provides barcode scanning functionality for all devices that\nsupport the MediaDevices.getUserMedia() native API. Opening the dialog launches the device camera and scans for known barcode formats.\nInternally, the component uses the zxing-js/library third party OSS. For a list of supported barcode formats, see the\nzxing-js/library documentation. https://github.com/zxing-js/library\n\nIt supports all features from the [SAP ui5 Barcode Scanner Dialog element](https://sap.github.io/ui5-webcomponents/playground/components/BarcodeScannerDialog/).\n\nYou can bind any `string` type, like `furo.fat.String` type or the `google.protobuf.StringValue` type.\n\n```html\n Open Scanner\n \n\n```\n\n## Methods\n**bindData(fieldNode)**\nBind an entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5BarcodeScannerDialog", "members": [ { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "e" } ], "description": "Input change handler\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true } ], "events": [ { "type": { "text": "String" }, "description": " Fires when the scan is completed successfuuly.", "name": "scan-success" }, { "type": { "text": "String" }, "description": " Fires when the scan fails with error.", "name": "scan-error" }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "module": "src/furo-ui5-barcode-scanner-dialog.js" }, "tagName": "furo-ui5-barcode-scanner-dialog", "summary": "data barcode scanner dialog", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5BarcodeScannerDialog", "declaration": { "name": "FuroUi5BarcodeScannerDialog", "module": "src/furo-ui5-barcode-scanner-dialog.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-bool-icon.js", "declarations": [ { "kind": "class", "description": "Displays a icon/symbol for a boolean value\n\nThis component uses the SAP Ui5 icons.\nhttps://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html\n\n```html\n\n```\n\nOnly `@ui5/webcomponents-icons/dist/navigation-down-arrow.js` and `@ui5/webcomponents-icons/dist/navigation-right-arrow.js` are imported.\nIf you set other icons, please do not forget to import them.", "name": "FuroDataBoolIcon", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode\n\nSupported types: `bool`" }, { "kind": "method", "name": "toggle", "description": "Toggles the icon." }, { "kind": "field", "name": "symboltrue", "privacy": "public", "type": { "text": "string" }, "description": "Defines the icon for the true state.", "default": "'navigation-down-arrow'", "attribute": "symboltrue" }, { "kind": "field", "name": "symbolfalse", "privacy": "public", "type": { "text": "string" }, "description": "Defines the icon for the false state.", "default": "'navigation-right-arrow'", "attribute": "symbolfalse" }, { "kind": "field", "name": "field", "type": { "text": "object" }, "default": "{}" }, { "kind": "field", "name": "_ocSymbol", "description": "open close symbol", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "_state", "type": { "text": "boolean" }, "privacy": "private", "default": "false" } ], "attributes": [ { "name": "symboltrue", "type": { "text": "string" }, "description": "Defines the icon for the true state.", "default": "'navigation-down-arrow'", "fieldName": "symboltrue" }, { "name": "symbolfalse", "type": { "text": "string" }, "description": "Defines the icon for the false state.", "default": "'navigation-right-arrow'", "fieldName": "symbolfalse" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-bool-icon", "summary": "Displays a icon for a boolean value", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroDataBoolIcon", "declaration": { "name": "FuroDataBoolIcon", "module": "src/furo-ui5-bool-icon.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-bool-icon", "declaration": { "name": "FuroDataBoolIcon", "module": "src/furo-ui5-bool-icon.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-busy-indicator.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-busy-indicator signals that some operation is going on and that the user must wait.\n\n```html\n\n```\n\nhttps://sap.github.io/ui5-webcomponents/playground/components/BusyIndicator/", "name": "FuroUiBusyIndicator", "members": [ { "kind": "method", "name": "activate", "description": "Sets the busy indicator state to active" }, { "kind": "method", "name": "deactivate", "description": "Sets the busy indicator state to inactive" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true } ], "superclass": { "module": "src/furo-ui5-busy-indicator.js" }, "tagName": "furo-ui5-busy-indicator", "summary": "ui5 busy indicator with methods", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUiBusyIndicator", "declaration": { "name": "FuroUiBusyIndicator", "module": "src/furo-ui5-busy-indicator.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-button.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-button component represents a simple push button. It enables users to trigger actions by clicking or\ntapping the furo-ui5-button, or by pressing certain keyboard keys, such as Enter.\nUsage\nFor the furo-ui5-button UI, you can define text, icon, or both. You can also specify whether the text or the icon is displayed first.\n\n```html\nRegister\n```\n\nYou can choose from a set of predefined types that offer different styling to correspond to the triggered action.\n\nYou can set the furo-ui5-button as enabled or disabled.\nAn enabled ui5-button can be pressed by clicking or tapping it.\nThe button changes its style to provide visual feedback to the user that it is pressed or hovered over with the mouse cursor.\nA disabled furo-ui5-button appears inactive and cannot be pressed.\n\nWhat is different from ui5-button?\nWith flow based programming it's usual to address functions. So we added two convenience functions for\n- disabling => fn-disable\n- enabling => fn-enable\n\nhttps://sap.github.io/ui5-webcomponents/playground/components/Button/", "name": "FuroUi5Button", "members": [ { "kind": "field", "name": "buttonTypeText", "description": "Overridden, because we use a different i18n bundle", "return": { "type": { "text": "*|string" } }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "disable", "description": "Sets the button state to disabled" }, { "kind": "method", "name": "enable", "description": "Sets the button state to enabled" }, { "kind": "method", "name": "show", "description": "shows the button, when it was hidden before" }, { "kind": "method", "name": "hide", "description": "hides the button" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true } ], "superclass": { "module": "src/furo-ui5-button.js" }, "tagName": "furo-ui5-button", "summary": "ui5 button with methods", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Button", "declaration": { "name": "FuroUi5Button", "module": "src/furo-ui5-button.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-card.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-card is a bindable card that represents information in the form of a tile with\nseparate header and content areas.\n\n```html\n \n
Action
\n
content goes here
\n \n```\n\n## How To Use Semantic Colors\nYou can use semantic colors to visualize the status or state. Set the attribute design=\"\" with the following values:\n- Positive (--sapPositiveColor)\n- Negative (--sapNegativeColor)\n- Critical (--sapCriticalColor)\n- Neutral (--sapCriticalColor)\n\n```html\n \n
content goes here
\n \n```", "name": "FuroUi5Card", "slots": [ { "type": { "text": "HTMLElement [0..n]" }, "description": "defines an action, displayed in the right most part of the header. Note: If status is set, the status text will be displayed, you can either have action, or status.", "name": "action" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the content of the card", "name": "content" } ], "members": [ { "kind": "method", "name": "bindHeading", "parameters": [ { "name": "fieldNode", "description": "`string`", "type": { "text": "FieldNode" } } ], "description": "Binds any **scalar** field to set the title of the panel.\n\nSupported types: scalar types e.g. `string`" }, { "kind": "method", "name": "bindIcon", "parameters": [ { "name": "fieldNode", "description": "`string`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to set the icon of the panel.\n\nDo not forget to import the icon you will use in your component.\n\nSupported types: `string`" }, { "kind": "method", "name": "bindSubheading", "parameters": [ { "name": "fieldNode", "description": "`string`", "type": { "text": "FieldNode" } } ], "description": "Binds any **scalar** field to set the subtitle of the panel.\n\nSupported types: scalar types e.g. `string`" }, { "kind": "method", "name": "bindNavNode", "parameters": [ { "name": "fieldNode", "description": "`string`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode with the following signature:\n\n- display_name (`string`)\n- secondary_text (`string`)\n- icon (`string`)" }, { "kind": "method", "name": "_setNavNodeSignatureValues", "description": "update attributes according to the value of furo.navigation.Navigationnode signature", "privacy": "private" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Defines the visual representation in the header of the card. Supports images and icons.\nhttps://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html", "default": "''", "attribute": "icon", "reflects": true }, { "kind": "field", "name": "heading", "privacy": "public", "type": { "text": "string" }, "description": "Defines the title displayed in the ui5-card header.", "default": "''", "attribute": "heading" }, { "kind": "field", "name": "subheading", "privacy": "public", "type": { "text": "string" }, "description": "Defines the subheading displayed in the ui5-card header.", "default": "''", "attribute": "subheading" }, { "kind": "field", "name": "status", "privacy": "public", "type": { "text": "string" }, "description": "Defines the status text displayed in the card header (upper right).\n\nBy enabling the status, actions are not visible.", "default": "''", "attribute": "status" }, { "kind": "field", "name": "headerInteractive", "privacy": "public", "type": { "text": "boolean" }, "description": "Defines if the ui5-card header would be interactive, e.g gets hover effect, gets focused and header-click event is fired, when it is pressed.", "default": "false", "attribute": "header-interactive", "reflects": true }, { "kind": "field", "name": "noContentPadding", "privacy": "public", "type": { "text": "boolean" }, "description": "Shows the content slot area with no padding", "default": "false", "attribute": "no-content-padding", "reflects": true } ], "events": [ { "description": "Fired when the card head is clicked. The header-interactive attribute must be set.", "name": "header-clicked" }, { "description": "Fired when interactive header was clicked.", "name": "header-click" } ], "attributes": [ { "name": "heading", "type": { "text": "string" }, "description": "Defines the title displayed in the ui5-card header.", "default": "''", "fieldName": "heading" }, { "name": "subheading", "type": { "text": "string" }, "description": "Defines the subheading displayed in the ui5-card header.", "default": "''", "fieldName": "subheading" }, { "name": "icon", "type": { "text": "string" }, "description": "Defines the visual representation in the header of the card. Supports images and icons.\nhttps://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html", "default": "''", "fieldName": "icon" }, { "name": "status", "type": { "text": "string" }, "description": "Defines the status text displayed in the card header (upper right).\n\nBy enabling the status, actions are not visible.", "default": "''", "fieldName": "status" }, { "name": "header-interactive", "type": { "text": "boolean" }, "description": "Defines if the ui5-card header would be interactive, e.g gets hover effect, gets focused and header-click event is fired, when it is pressed.", "default": "false", "fieldName": "headerInteractive" }, { "name": "no-content-padding", "type": { "text": "boolean" }, "description": "Shows the content slot area with no padding", "default": "false", "fieldName": "noContentPadding" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-card", "summary": "Ui5 card with data bindings", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Card", "declaration": { "name": "FuroUi5Card", "module": "src/furo-ui5-card.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-card", "declaration": { "name": "FuroUi5Card", "module": "src/furo-ui5-card.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-chart-display.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-chart-display is the render component\nto display charts with apex the apex charts lib (https://github.com/apexcharts/apexcharts.js).\n\n Use `furo-ui5-chart` to connect your data.\n\n ```html\n \n \n \n ```", "name": "FuroUi5ChartDisplay", "members": [ { "kind": "field", "name": "sparkline", "privacy": "public", "type": { "text": "Boolean" }, "description": "Hides all elements of the chart other than the primary graphic.\nUse this to visualize data in very small areas.", "attribute": "sparkline" }, { "kind": "field", "name": "xaxisTitle", "privacy": "public", "type": { "text": "String" }, "description": "Give the x-axis a title which will be displayed below the axis labels by default.", "attribute": "xaxis-title" }, { "kind": "field", "name": "xaxisDatetime", "privacy": "public", "type": { "text": "Boolean" }, "description": "Set this to true if you have datetime, google.type.date or timestamp data on the x-axis", "attribute": "xaxis-datetime" }, { "kind": "field", "name": "zebra", "privacy": "public", "type": { "text": "String" }, "description": "set zebra color like zebra=\"#f3f4f5, #fff\" to get stripes", "attribute": "zebra" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Set the text to display, if no data is given.\n\nIf this option is not set, the default is **No data.**", "attribute": "no-data-text" }, { "kind": "field", "name": "legend", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enables the legend on bottom left with offset 0:0", "attribute": "legend" }, { "kind": "field", "name": "dataLabels", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enable labels with data on every item.", "attribute": "data-labels" }, { "kind": "field", "name": "tooltip", "privacy": "public", "type": { "text": "Boolean" }, "description": "show a tooltip on mouseover", "attribute": "tooltip" }, { "kind": "field", "name": "legendAlign", "privacy": "public", "type": { "text": "String" }, "description": "Aligns the legend to `left` `center` `right`\n\ndefault is **left**", "attribute": "legend-align" }, { "kind": "field", "name": "legendPosition", "privacy": "public", "type": { "text": "String" }, "description": "Set the position of the legend to `top`, `right`, `bottom`, `left`\n\nDefault is **bottom**", "attribute": "legend-position" }, { "kind": "field", "name": "legendOffsetX", "privacy": "public", "type": { "text": "Number" }, "description": "Moves the legend in the **x** direction for n pixels from `legend-position`", "attribute": "legend-offset-x" }, { "kind": "field", "name": "legendOffsetY", "privacy": "public", "type": { "text": "Number" }, "description": "Moves the legend in the **y** direction for n pixels from `legend-position`", "attribute": "legend-offset-y" }, { "kind": "field", "name": "toolbar", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enables the toolbar", "attribute": "toolbar" }, { "kind": "field", "name": "toolbarDownload", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enables the download option in the toolbar (svg,csv,png)", "attribute": "toolbar-download" }, { "kind": "field", "name": "plotHorizontal", "privacy": "public", "type": { "text": "boolean" }, "description": "Enable this to draw the bars horizontally", "attribute": "plot-horizontal" }, { "kind": "field", "name": "grid", "privacy": "public", "type": { "text": "Boolean" }, "description": "Draw the horizontal grid lines", "attribute": "grid" }, { "kind": "field", "name": "chartType", "privacy": "public", "type": { "text": "String" }, "description": "\nline, area, bar are mixable\n\nradar, scatter, heatmap\n\npie donut polarArea radialBar can only consume 1 data series", "attribute": "chart-type" }, { "kind": "field", "name": "stacked", "privacy": "public", "type": { "text": "Boolean" }, "description": "WORK IN PROGRESS\nStacked bar charts are not mixable", "attribute": "stacked" }, { "kind": "field", "name": "titleText", "privacy": "public", "type": { "text": "String" }, "description": "Set the title.", "attribute": "title-text" }, { "kind": "field", "name": "titleAlign", "privacy": "public", "type": { "text": "String" }, "description": "Aligns the title. Possible values are 'left', 'center', 'right'\n\nDefault is **left**", "attribute": "title-align" }, { "kind": "field", "name": "titleOffsetX", "privacy": "public", "type": { "text": "Number" }, "description": "Moves the title for n pixels on the x-axis from the alignment direction", "attribute": "title-offset-x" }, { "kind": "field", "name": "titleOffsetY", "privacy": "public", "type": { "text": "Number" }, "description": "Moves the title for n pixels on the y-axis from the alignment direction", "attribute": "title-offset-y" }, { "kind": "field", "name": "fixedHeight", "privacy": "public", "type": { "text": "Number" }, "description": "Set a fixed height for the plot. Default is auto, this can be useful if you need to control the heights", "attribute": "fixed-height" }, { "kind": "method", "name": "_initChart", "parameters": [ { "name": "apexOptions" } ], "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_registerDataSourceComponents", "parameters": [ { "name": "dataSources" } ], "return": { "type": { "text": "Promise" } }, "privacy": "private" }, { "kind": "method", "name": "_fillInitialData", "privacy": "private" }, { "kind": "field", "name": "apexOptions", "type": { "text": "object" }, "default": "{\n series: [],\n yaxis: [],\n // belize qualitative color palette\n // node_modules/@ui5/webcomponents-theming/dist/themes/sap_fiori_3/css_variables.css\n colors: [\n 'var(--sapChart_OrderedColor_1 , #5899da)',\n 'var(--sapChart_OrderedColor_2 , #e8743b)',\n 'var(--sapChart_OrderedColor_3 , #19a979)',\n 'var(--sapChart_OrderedColor_4 , #ed4a7b)',\n 'var(--sapChart_OrderedColor_5 , #945ecf)',\n 'var(--sapChart_OrderedColor_6 , #13a4b4)',\n 'var(--sapChart_OrderedColor_7 , #525df4)',\n 'var(--sapChart_OrderedColor_8 , #bf399e)',\n 'var(--sapChart_OrderedColor_9 , #6c8893)',\n 'var(--sapChart_OrderedColor_10 ,: #ee6868)',\n 'var(--sapChart_OrderedColor_11 ,: #2f6497)',\n ],\n noData: {\n text: 'No data.',\n align: 'center',\n verticalAlign: 'middle',\n offsetX: 0,\n offsetY: 0,\n style: {\n color: undefined,\n fontSize: '14px',\n fontFamily: undefined,\n },\n },\n chart: {\n // height: 550,\n fontFamily: 'var(--sapFontFamily, Helvetica, Arial, sans-serif)',\n foreColor: 'var(--sapTextColor)',\n type: 'line',\n stacked: false,\n background: 'unset',\n events: {},\n toolbar: {\n show: false, // disable by default\n tools: {\n download: false,\n selection: true,\n zoom: true,\n zoomin: true,\n zoomout: true,\n pan: true,\n reset: true,\n },\n },\n sparkline: {\n enabled: false,\n },\n },\n grid: {\n show: false, // https://apexcharts.com/docs/options/grid/\n // zebra\n // row: {\n // colors: [\"#f3f4f5\", \"#fff\"],\n // }\n },\n dataLabels: {\n enabled: false,\n },\n\n title: {\n // text: 'XYZ - Analysis',\n align: 'left',\n // offsetX: 70,\n },\n stroke: {},\n\n tooltip: {\n enabled: false,\n fixed: {\n enabled: false,\n position: 'topLeft', // topRight, topLeft, bottomRight, bottomLeft\n offsetY: 30,\n offsetX: 160,\n },\n },\n legend: {\n show: false,\n position: 'bottom',\n horizontalAlign: 'left',\n offsetX: 0,\n offsetY: 0,\n formatter: (seriesName, opts) => {\n if (\n opts.w.config.yaxis[opts.seriesIndex] &&\n opts.w.config.yaxis[opts.seriesIndex].legendLabel\n ) {\n return [opts.w.config.yaxis[opts.seriesIndex].legendLabel];\n }\n return [seriesName];\n },\n },\n plotOptions: {},\n xaxis: {\n // type: \"datetime\",\n\n // tickAmount: 6,\n title: {\n text: undefined,\n },\n },\n }" } ], "events": [ { "type": { "text": "Fieldnode" }, "description": " Fired when a marker for this data source was clicked. Note: the event is fired from the furo-ui5-chart", "name": "data-point-clicked" } ], "attributes": [ { "name": "chart-type", "type": { "text": "String" }, "description": "\nline, area, bar are mixable\n\nradar, scatter, heatmap\n\npie donut polarArea radialBar can only consume 1 data series", "fieldName": "chartType" }, { "name": "title-text", "type": { "text": "String" }, "description": "Set the title.", "fieldName": "titleText" }, { "name": "title-align", "type": { "text": "String" }, "description": "Aligns the title. Possible values are 'left', 'center', 'right'\n\nDefault is **left**", "fieldName": "titleAlign" }, { "name": "title-offset-x", "type": { "text": "Number" }, "description": "Moves the title for n pixels on the x-axis from the alignment direction", "fieldName": "titleOffsetX" }, { "name": "title-offset-y", "type": { "text": "Number" }, "description": "Moves the title for n pixels on the y-axis from the alignment direction", "fieldName": "titleOffsetY" }, { "name": "no-data-text", "type": { "text": "String" }, "description": "Set the text to display, if no data is given.\n\nIf this option is not set, the default is **No data.**", "fieldName": "noDataText" }, { "name": "stacked", "type": { "text": "Boolean" }, "description": "WORK IN PROGRESS\nStacked bar charts are not mixable", "fieldName": "stacked" }, { "name": "data-labels", "type": { "text": "Boolean" }, "description": "Enable labels with data on every item.", "fieldName": "dataLabels" }, { "name": "fixed-height", "type": { "text": "Number" }, "description": "Set a fixed height for the plot. Default is auto, this can be useful if you need to control the heights", "fieldName": "fixedHeight" }, { "name": "tooltip", "type": { "text": "Boolean" }, "description": "show a tooltip on mouseover", "fieldName": "tooltip" }, { "name": "legend", "type": { "text": "Boolean" }, "description": "Enables the legend on bottom left with offset 0:0", "fieldName": "legend" }, { "name": "grid", "type": { "text": "Boolean" }, "description": "Draw the horizontal grid lines", "fieldName": "grid" }, { "name": "legend-align", "type": { "text": "String" }, "description": "Aligns the legend to `left` `center` `right`\n\ndefault is **left**", "fieldName": "legendAlign" }, { "name": "legend-position", "type": { "text": "String" }, "description": "Set the position of the legend to `top`, `right`, `bottom`, `left`\n\nDefault is **bottom**", "fieldName": "legendPosition" }, { "name": "legend-offset-x", "type": { "text": "Number" }, "description": "Moves the legend in the **x** direction for n pixels from `legend-position`", "fieldName": "legendOffsetX" }, { "name": "legend-offset-y", "type": { "text": "Number" }, "description": "Moves the legend in the **y** direction for n pixels from `legend-position`", "fieldName": "legendOffsetY" }, { "name": "toolbar", "type": { "text": "Boolean" }, "description": "Enables the toolbar", "fieldName": "toolbar" }, { "name": "toolbar-download", "type": { "text": "Boolean" }, "description": "Enables the download option in the toolbar (svg,csv,png)", "fieldName": "toolbarDownload" }, { "name": "plot-horizontal", "type": { "text": "boolean" }, "description": "Enable this to draw the bars horizontally", "fieldName": "plotHorizontal" }, { "name": "sparkline", "type": { "text": "Boolean" }, "description": "Hides all elements of the chart other than the primary graphic.\nUse this to visualize data in very small areas.", "fieldName": "sparkline" }, { "name": "zebra", "type": { "text": "String" }, "description": "set zebra color like zebra=\"#f3f4f5, #fff\" to get stripes", "fieldName": "zebra" }, { "name": "xaxis-title", "type": { "text": "String" }, "description": "Give the x-axis a title which will be displayed below the axis labels by default.", "fieldName": "xaxisTitle" }, { "name": "xaxis-datetime", "type": { "text": "Boolean" }, "description": "Set this to true if you have datetime, google.type.date or timestamp data on the x-axis", "fieldName": "xaxisDatetime" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-chart-display", "summary": "Display charts with data objects", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ChartDisplay", "declaration": { "name": "FuroUi5ChartDisplay", "module": "src/furo-ui5-chart-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-chart-display", "declaration": { "name": "FuroUi5ChartDisplay", "module": "src/furo-ui5-chart-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-chart.js", "declarations": [ { "kind": "class", "description": "furo-ui5-chart connects data objects (repeaterNodes) with the charting lib.\n\n Use multiple binders if you need more then one series per chart.\n\n ```html\n \n \n \n ```", "name": "FuroUi5Chart", "members": [ { "kind": "field", "name": "axisLabelOpposite", "privacy": "public", "type": { "text": "Boolean" }, "description": "Put the axis label on the opposite site (usually right)", "attribute": "axis-label-opposite" }, { "kind": "field", "name": "axisLabel", "privacy": "public", "type": { "text": "String" }, "description": "Text for the y axis", "attribute": "axis-label" }, { "kind": "field", "name": "axisLabelColor", "privacy": "public", "type": { "text": "String" }, "description": "Custom color for the y axis description text", "attribute": "axis-label-color" }, { "kind": "field", "name": "axisBorder", "privacy": "public", "type": { "text": "Boolean" }, "description": "Show a border on the right side of the y axis descriptions and labels.", "attribute": "axis-border" }, { "kind": "field", "name": "axisBorderColor", "privacy": "public", "type": { "text": "String" }, "description": "Custom color for the border.", "attribute": "axis-border-color" }, { "kind": "field", "name": "axisTicks", "privacy": "public", "type": { "text": "Boolean" }, "description": "Show tick marks on the y axis.", "attribute": "axis-ticks" }, { "kind": "field", "name": "axisTooltip", "privacy": "public", "type": { "text": "Boolean" }, "description": "Show a tooltip with the current value while hovering.", "attribute": "axis-tooltip" }, { "kind": "field", "name": "axisTicksColor", "privacy": "public", "type": { "text": "String" }, "description": "Custom color for the ticks", "attribute": "axis-ticks-color" }, { "kind": "field", "name": "seriesName", "privacy": "public", "type": { "text": "String" }, "description": "Series with same name will get the same y-axis", "attribute": "series-name" }, { "kind": "field", "name": "legendLabel", "privacy": "public", "type": { "text": "String" }, "description": "Label the Series for the legend. This text is also shown on the tooltips. This is useful when you have more then one data series.", "attribute": "legend-label" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "data", "type": { "text": "RepeaterNode" } } ], "description": "Binds a RepeaterNode to the component.\n\nSupported types: repeated types" }, { "kind": "method", "name": "_dataPointSelection", "parameters": [ { "name": "e" }, { "name": "context" }, { "name": "config" } ], "privacy": "private" }, { "kind": "method", "name": "_convertData", "description": "Prepares the data for the according chart display\n\nsome charts want 1 dimensional data (pie, donut) and others expect more dimensions (boxplot,...)", "privacy": "private" }, { "kind": "method", "name": "_initEmptySeries", "privacy": "private" }, { "kind": "method", "name": "_pathGet", "parameters": [ { "name": "root", "description": "Object from which to dereference path from", "type": { "text": "Object" } }, { "name": "path", "description": "Path to read", "type": { "text": "string | !Array" } } ], "description": "Reads a value from a path. If any sub-property in the path is `undefined`,\nthis method returns `undefined` (will never throw.", "return": { "type": { "text": "*" } }, "privacy": "private" }, { "kind": "method", "name": "_split", "parameters": [ { "name": "path" } ], "return": { "type": { "text": "string[]" } }, "privacy": "private" }, { "kind": "field", "name": "strokeWidth", "privacy": "public", "type": { "text": "number" }, "description": "Define the thickness of the lines in px.", "default": "1", "attribute": "chart-stroke-width" }, { "kind": "field", "name": "markerSize", "privacy": "public", "type": { "text": "number" }, "description": "Set the size of the markers (hover state) in px.", "default": "0", "attribute": "chart-marker-size" }, { "kind": "field", "name": "strokeCurve", "privacy": "public", "type": { "text": "string" }, "description": "Define the curve style for line and area charts.\n\n Possible values: `smooth`, `straight`, `stepline`", "default": "'straight'", "attribute": "chart-curve" }, { "kind": "field", "name": "options", "type": { "text": "Object" }, "description": "Apex options", "privacy": "private", "default": "{\n seriesName: undefined,\n legendLabel: undefined, // custom field\n opposite: false,\n axisTicks: {\n show: false,\n borderType: 'solid',\n color: '#666666',\n width: 6,\n offsetX: 0,\n offsetY: 0,\n },\n axisBorder: {\n show: false,\n color: '#666666',\n stroke: 1,\n },\n labels: {\n show: false,\n style: {\n colors: '#666666',\n },\n },\n title: {\n style: {\n color: '#666666',\n },\n },\n tooltip: {\n enabled: false,\n offsetX: 0,\n },\n }" }, { "kind": "field", "name": "dataField", "privacy": "public", "type": { "text": "String" }, "description": "Define the data field or fields here. For most charts this is **the y axis**.\n\nSome charts requires more then one data field (i.e. bubbles want at least 3 fields `data-field=\"data.start.day, data.end.day, data.start.day\"` ).", "attribute": "data-field" }, { "kind": "field", "name": "categoryField", "privacy": "public", "type": { "text": "String" }, "description": "Define the category field here (only 1 field). You can think of this as it is the x axis for your chart.", "attribute": "category-field" }, { "kind": "field", "name": "chartType", "privacy": "public", "type": { "text": "String" }, "description": "**Use this for mixed charts scenarios only**, prefer to define the chart-type on the chart-display.\nSpecify the default type on the display and set the custom type on this binder.", "attribute": "chart-type" }, { "kind": "field", "name": "chartColor", "privacy": "public", "type": { "text": "String" }, "description": "If you need to give an explicit color for the series you can use this attribute.", "attribute": "chart-color" }, { "kind": "field", "name": "xaxis", "privacy": "public", "type": { "text": "String" }, "attribute": "xaxis" } ], "events": [ { "type": { "text": "Fieldnode" }, "description": " Fired when a marker for this data source was clicked", "name": "data-point-clicked" }, { "type": { "text": "data-series" }, "description": " Fired when datasource has updated data", "name": "data-updated" } ], "attributes": [ { "name": "data-field", "type": { "text": "String" }, "description": "Define the data field or fields here. For most charts this is **the y axis**.\n\nSome charts requires more then one data field (i.e. bubbles want at least 3 fields `data-field=\"data.start.day, data.end.day, data.start.day\"` ).", "fieldName": "dataField" }, { "name": "category-field", "type": { "text": "String" }, "description": "Define the category field here (only 1 field). You can think of this as it is the x axis for your chart.", "fieldName": "categoryField" }, { "name": "legend-label", "type": { "text": "String" }, "description": "Label the Series for the legend. This text is also shown on the tooltips. This is useful when you have more then one data series.", "fieldName": "legendLabel" }, { "name": "series-name", "type": { "text": "String" }, "description": "Series with same name will get the same y-axis", "fieldName": "seriesName" }, { "name": "chart-type", "type": { "text": "String" }, "description": "**Use this for mixed charts scenarios only**, prefer to define the chart-type on the chart-display.\nSpecify the default type on the display and set the custom type on this binder.", "fieldName": "chartType" }, { "name": "chart-color", "type": { "text": "String" }, "description": "If you need to give an explicit color for the series you can use this attribute.", "fieldName": "chartColor" }, { "name": "axis-label-opposite", "type": { "text": "Boolean" }, "description": "Put the axis label on the opposite site (usually right)", "fieldName": "axisLabelOpposite" }, { "name": "axis-label", "type": { "text": "String" }, "description": "Text for the y axis", "fieldName": "axisLabel" }, { "name": "axis-label-color", "type": { "text": "String" }, "description": "Custom color for the y axis description text", "fieldName": "axisLabelColor" }, { "name": "axis-border", "type": { "text": "Boolean" }, "description": "Show a border on the right side of the y axis descriptions and labels.", "fieldName": "axisBorder" }, { "name": "axis-border-color", "type": { "text": "String" }, "description": "Custom color for the border.", "fieldName": "axisBorderColor" }, { "name": "axis-ticks", "type": { "text": "Boolean" }, "description": "Show tick marks on the y axis.", "fieldName": "axisTicks" }, { "name": "axis-tooltip", "type": { "text": "Boolean" }, "description": "Show a tooltip with the current value while hovering.", "fieldName": "axisTooltip" }, { "name": "axis-ticks-color", "type": { "text": "String" }, "description": "Custom color for the ticks", "fieldName": "axisTicksColor" }, { "name": "chart-curve", "type": { "text": "string" }, "description": "Define the curve style for line and area charts.\n\n Possible values: `smooth`, `straight`, `stepline`", "default": "'straight'", "fieldName": "strokeCurve" }, { "name": "chart-stroke-width", "type": { "text": "number" }, "description": "Define the thickness of the lines in px.", "default": "1", "fieldName": "strokeWidth" }, { "name": "chart-marker-size", "type": { "text": "number" }, "description": "Set the size of the markers (hover state) in px.", "default": "0", "fieldName": "markerSize" }, { "name": "xaxis", "type": { "text": "String" }, "fieldName": "xaxis" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-chart", "summary": "connect data to a chart", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Chart", "declaration": { "name": "FuroUi5Chart", "module": "src/furo-ui5-chart.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-chart", "declaration": { "name": "FuroUi5Chart", "module": "src/furo-ui5-chart.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-checkbox-input-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-checkbox-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5CheckboxInputLabeled", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "Supported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "attribute": "placeholder" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "placeholder", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "fieldName": "placeholder" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-checkbox-input-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5CheckboxInputLabeled", "declaration": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-checkbox-input-labeled", "declaration": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-checkbox-input.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-checkbox-input' component allows the user to switch true and false for type Bool with data binding.\n\nIt supports all features from the [SAP ui5 checkbox element](https://sap.github.io/ui5-webcomponents/playground/components/CheckBox/).\n\nBindable FieldNodes: `bool` type, `furo.fat.Bool` type or the `google.wrapper.BoolValue` type.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta \t| fat \t| html \t|\n|------\t|-----\t|------\t|\n| 1 \t| 10 \t| 100 \t|\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"disabled\":\"true\"** set the element to disabled\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n\nThe constraint **required** will mark the element as required.", "name": "FuroUi5CheckboxInput", "members": [ { "kind": "method", "name": "check", "description": "Checks the checkbox and updates the value" }, { "kind": "method", "name": "uncheck", "description": "Unhecks the checkbox and updates the value" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.", "privacy": "public" }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the checkbox changes.", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueState", "parameters": [ { "name": "valueState" } ], "description": "Updates the valueState\nui5 checkbox has only 3 states: Warning, Error, and None (default) https://sap.github.io/ui5-webcomponents/playground/components/CheckBox/", "privacy": "private" }, { "kind": "method", "name": "_resetValueState", "description": "reset to previous value state", "privacy": "private" }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "text" }, { "name": "placeholder", "type": { "text": "String" } } ], "description": "overwrite onFnaLabelChanged function\nlabel is mapped to text", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly", "type": { "text": "Boolean" } } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_previousValueState", "type": { "text": "string" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "'None'" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n label: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{}" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "{label: undefined}" }, "privacy": "private", "default": "{\n label: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "{readonly: undefined, disabled: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, text: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n disabled: null,\n text: null,\n indeterminate: null,\n checked: null,\n }" } ], "events": [ { "type": { "text": "Boolean" }, "description": " Fired when the checkbox checked state changes.", "name": "change" }, { "type": { "text": "Boolean" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "module": "src/furo-ui5-checkbox-input.js" }, "tagName": "furo-ui5-checkbox-input", "summary": "data checkbox input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5CheckboxInput", "declaration": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-combobox-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-combobox-labeled`\nThe furo-ui5-combobox-labeled is a composition to easily use a complete data combobox with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5ComboboxLabeled", "slots": [ { "type": { "text": "HTMLElement" }, "description": "defines the value state message that will be displayed as pop up under the input element.", "name": "valueStateMessage" } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-combobox component" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "descFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "attribute": "desc-field-path" }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath" }, { "name": "desc-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "fieldName": "descFieldPath" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-combobox-labeled", "summary": "labeled combobox", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ComboboxLabeled", "declaration": { "name": "FuroUi5ComboboxLabeled", "module": "src/furo-ui5-combobox-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-combobox-labeled", "declaration": { "name": "FuroUi5ComboboxLabeled", "module": "src/furo-ui5-combobox-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-combobox.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-combobox component represents a drop-down menu with a list of the available options and a text input field\nto narrow down the options. It is commonly used to enable users to select an option from a predefined list.\nUse the function bindOptions to bind a RepeaterNode as an option list.\n\n```html\n\n\n```", "name": "FuroUi5Combobox", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `required`,`readonly`,`disabled`, `value-field-path`, `display-field-path`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Overridden bindData of FieldNodeAdapter", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list." }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "Overridden onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "Overridden onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Overridden onFnaOptionsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "Overridden onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "Overridden onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "Overridden onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateOptionList", "parameters": [ { "name": "arr" } ], "description": "Creates new combobox items", "privacy": "private" }, { "kind": "method", "name": "_fireDebouncedEvent", "description": "Fires a debounced search event, that can be used to lazy load options.", "privacy": "private" }, { "kind": "method", "name": "_mapOptionsToSuggestions", "parameters": [ { "name": "repeaterNode" } ], "description": "Maps a RepeaterNode according the mapping definition to an ui5-cb-item.\nSupported fields are:\n- text\n- description", "return": { "type": { "text": "*[]" } }, "privacy": "private" }, { "kind": "method", "name": "_createHandler", "parameters": [ { "name": "wait" }, { "name": "immediate" } ], "description": "Internal create of debounce handler function", "privacy": "private" }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "activeFieldBinding", "type": { "text": "boolean" }, "description": "Flag to indicate if a field is attached\nDefault: false", "default": "false" }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'" }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'" }, { "kind": "field", "name": "_optionList", "type": { "text": "*[]" }, "description": "Internal RepeaterNode\nDefines the ui5-combobox options.", "privacy": "private", "default": "[]" }, { "kind": "field", "name": "wait", "type": { "text": "number" }, "description": "Debounce time in milliseconds\nDefault value: 250", "default": "250" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "A list of privileged attributes. when those attributes are set in furo-ui5-combobox components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n wait: 250,\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n }" }, { "kind": "field", "name": "_debounce", "description": "Debounce function, taken from Underscore.js", "parameters": [ { "name": "func" }, { "name": "wait" }, { "name": "immediate" } ], "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "default": "function debounce(func, wait, immediate) {\n let timeout;\n return function debouncer() {\n const context = this;\n // eslint-disable-next-line prefer-rest-params\n const args = arguments;\n const later = function applyLater() {\n timeout = null;\n if (!immediate) func.apply(context, args);\n };\n const callNow = immediate && !timeout;\n clearTimeout(timeout);\n timeout = setTimeout(later, wait);\n if (callNow) func.apply(context, args);\n };\n }" } ], "events": [ { "name": "search-requested", "type": { "text": "value" }, "description": "Fired when typing in input (debounced, default 250ms)" }, { "type": { "text": "optionNodeList" }, "description": "Fired after the option list was rebuilt.", "name": "options-updated" }, { "type": { "text": "selectedOption" }, "description": "Fired when selection is changed by user interaction", "name": "selection-change" }, { "type": { "text": "selectedOption" }, "description": "Fired after the field value was changed.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/ComboBoxItem.js" }, "tagName": "furo-ui5-combobox", "summary": "data combobox field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Combobox", "declaration": { "name": "FuroUi5Combobox", "module": "src/furo-ui5-combobox.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-context-menu-display.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-context-menu-display is the display element for furo-ui5-context-menu and submenus.\nPlace this component as high as needed in your dom.\n\nYou should not interact with this component directly. Use [`furo-ui5-context-menu`](?t=FuroUi5ContextMenu) to show a context menu.\n\nThere is nothing more to do. The menu creates a transparent \"backdrop\" with absolute positions 0 0 0 0\n\n```html\n \n```", "name": "FuroUi5ContextMenuDisplay", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "hideMenu", "description": "Hides the menu witout selecting anything.\n\nIf you click somewhere on the background, the menu will also disappear." }, { "kind": "method", "name": "triggerNavigation", "parameters": [ { "name": "key" } ], "description": "Interface for the furo navigation pad", "privacy": "private" }, { "kind": "field", "name": "borderDistance", "type": { "text": "number" }, "description": "Distance for the sub menus in pixel. This value is used to calculate if the menu or sub menu should apear on the left or on the right.", "default": "48" }, { "kind": "field", "name": "_repeatsChanged", "privacy": "private" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-context-menu-display", "summary": "context menu", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ContextMenuDisplay", "declaration": { "name": "FuroUi5ContextMenuDisplay", "module": "src/furo-ui5-context-menu-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-context-menu-display", "declaration": { "name": "FuroUi5ContextMenuDisplay", "module": "src/furo-ui5-context-menu-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-context-menu.js", "declarations": [ { "kind": "class", "description": "furo-ui5-context-menu is a context menu or menu element.\n\nA `furo-ui5-context-menu-display` element must be inserted in one of the parent elements of the element where you\nuse the `furo-ui5-context-menu`. The app-shell or even body is a good place for that.\n\n`furo-ui5-context-menu` uses **diplay:inline**, do not forget to change it to display:block if you place it around a block level element.\n\n```html\n \n \n \n```\n\n## Data signature\n\n```yaml\n- type: 'menu.Menuitem #Item signature for a context menu'\n fields:\n icon: 'string:1 #Leading icon of the menu'\n display_name: 'string:2 #String representation of the menu item. Menu item text'\n disabled: 'bool:3 #Display actions as disabled when they can only be used sometimes and under certain conditions.'\n command: 'string:4 #Keyboard command hint'\n leading_divider: 'bool:5 #Item has a leading divider line'\n children: '[] menu.Menuitem:6 #Children of this item'\n```\n\n## Minimal data signature\n\n```yaml\n- type: 'menu.Menuitem #Item signature for a context menu'\n fields:\n id: 'string:1 #Id of the menu item'\n display_name: 'string:2 #String representation of the menu item. Menu item text'\n```", "name": "FuroUi5ContextMenu", "slots": [ { "type": { "text": "HTMLElement" }, "description": "default slot to add an individual context menu opener component (e.g. furo-icon-button).", "name": "" } ], "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "menu" }, { "description": "|| RepeaterNode} menu with `menu.Menuitem` signature", "name": "", "type": { "text": "Fieldnode" } } ], "description": "Bind your menu object." }, { "kind": "method", "name": "setContext", "parameters": [ { "name": "ctx", "description": "Can be anything, will be returned at the menu-item-selected method", "type": { "text": "*" } } ], "description": "Sets the context. Use this if you want to set a Object as context" }, { "kind": "method", "name": "trigger", "parameters": [ { "name": "byKeyboard" } ], "description": "Triggers the context menu. Set by keyboard to true to focus the first element for keyboard navigation" }, { "kind": "method", "name": "triggerContext", "parameters": [ { "name": "context", "type": { "text": "Object" } }, { "name": "byKeyboard" } ], "description": "triggers the menu with context" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "field", "name": "_context", "privacy": "private", "type": { "text": "string" }, "description": "Use this to set a string value as context.", "attribute": "context" } ], "events": [ { "type": { "text": "{context, menuitem}" }, "description": " Fired when a menu item is selected.", "name": "menu-item-selected" } ], "attributes": [ { "name": "context", "type": { "text": "string" }, "description": "Use this to set a string value as context.", "fieldName": "_context" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-context-menu", "summary": "Context menu", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ContextMenu", "declaration": { "name": "FuroUi5ContextMenu", "module": "src/furo-ui5-context-menu.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-context-menu", "declaration": { "name": "FuroUi5ContextMenu", "module": "src/furo-ui5-context-menu.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-date-picker-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-date-picker-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5DatePickerLabeled", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-date-picker-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5DatePickerLabeled", "declaration": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-date-picker-labeled", "declaration": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-date-picker.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-date-picker component allows the user to bind an date object like google.type.Date or a date string\nwith ISO 8061 format like \"2020-12-31\" to the ui5 datepicker and edit it.\n\nIt supports all features from the [SAP ui5 DatePicker element](https://sap.github.io/ui5-webcomponents/playground/components/DatePicker/).\n\nYou can define the formatPattern (e.g. 'dd.MM.yyyy' ) to show the date according to format pattern.\n\nYou can bind a `string`, `furo.type.Date` or `google.type.Date`.\n\n```html\n \n \n```\n\nThe text field can be editable or read-only (readonly property), and it can be enabled or disabled (enabled property).\nTo visualize semantic states, such as \"error\" or \"warning\", the valueState property is provided.\nWhen the user makes changes to the date, the change event is fired, which enables you to react on any date change.\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **min:\"1999-12-31\"** set the minDate for the element (use iso date in the constraint)\n- **max:\"1999-12-31\"** set the maxDate for the element (use iso date in the constraint)\n- **pattern:\"1999-12-31\"** set the pattern for the element\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind a entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5DatePicker", "members": [ { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "privacy": "private" }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `string`, `furo.type.Date`, `google.type.Date`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `furo.type.Date`, `google.type.Date`" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nAttributes that can be se are `value-state`, `placeholder`, `required`,`readonly`,`disabled` `max-date`, `min-date`, `format-pattern`,\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "description": "The format pattern for the date.", "default": "''" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{min: undefined, readonly: undefined, max: undefined, pattern: undefined, placeholder: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{required: undefined}" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{minDate: null, readonly: null, formatPattern: null, disabled: null, maxDate: null, placeholder: null, required: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }" } ], "events": [ { "type": { "text": "Date" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "furo-value-changed" }, { "type": { "text": "Date" }, "description": "-Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/generated/i18n/i18n-defaults.js" }, "tagName": "furo-ui5-date-picker", "summary": "bindable datepicker field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5DatePicker", "declaration": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-date-time-picker-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-date-time-picker-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5DateTimePickerLabeled", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type : `string`, `google.protobuf.Timestamp`, `int32`, `int64`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `google.protobuf.Timestamp`, `int32`, `int64`" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" }, { "kind": "field", "name": "formatPattern", "privacy": "public", "type": { "text": "string" }, "description": "Determines the format, displayed in the input field.", "attribute": "format-pattern" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "format-pattern", "type": { "text": "string" }, "description": "Determines the format, displayed in the input field.", "fieldName": "formatPattern" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-date-time-picker-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5DateTimePickerLabeled", "declaration": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-date-time-picker-labeled", "declaration": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-date-time-picker.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-date-time-picker component allows the user to bind a date string\nwith IOS 8061 standard in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format likes \"2017-01-15T01:30:15.01Z\" to the ui5 date time picker and edit it.\n\nyou can define the formatPattern (e.g. 'dd.MM.yyyy hh:mm aa' ) to show the date according to format pattern. but the data in\nthe payload will still be in format [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) (2017-01-15T01:30:15.01Z)\n\nThe text field can be editable or read-only (readonly property), and it can be enabled or disabled (enabled property).\nTo visualize semantic states, such as \"error\" or \"warning\", the valueState property is provided.\nWhen the user makes changes to the datetime, the change event is fired, which enables you to react on any date change.\n\nYou can bind a `string`, `google.protobuf.Timestamp`, `int32`, `int64`.\n\n`int32`, `int64` will be handled as unix timestamps (seconds since epoc) and can not be *empty*.\n\n```html\n \n \n```\n\nThe field can be editable or read-only (readonly property), and it can be enabled or disabled (enabled property).\nTo visualize semantic states, such as \"error\" or \"warning\", the valueState property is provided.\nWhen the user makes changes to the date, the change event is fired, which enables you to react on any date change.\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **min:\"1999-12-31\"** set the minDate for the element (use iso date in the constraint)\n- **max:\"1999-12-31\"** set the maxDate for the element (use iso date in the constraint)\n- **pattern:\"1999-12-31\"** set the pattern for the element\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind a entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5DateTimePicker", "members": [ { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "v" } ] }, { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ] }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `string`, `google.protobuf.Timestamp`, `int32`, `int64`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `google.protobuf.Timestamp`, `int32`, `int64`" }, { "kind": "method", "name": "readAttributes" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed" }, { "description": "Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/generated/i18n/i18n-defaults.js" }, "tagName": "furo-ui5-date-time-picker", "summary": "furo data datetime picker field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5DateTimePicker", "declaration": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-dialog-display.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-dialog-display will catch furo-ui5-dialog elements, to display it in the dom of his parent element.\n\nThe first furo-ui5-dialog-display will catch the `furo-ui5-dialog-register` request from a underlying furo-ui5-dialog.", "name": "FuroUi5DialogDisplay", "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-dialog-display", "summary": "Display element for furo-ui5-dialog", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5DialogDisplay", "declaration": { "name": "FuroUi5DialogDisplay", "module": "src/furo-ui5-dialog-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-dialog-display", "declaration": { "name": "FuroUi5DialogDisplay", "module": "src/furo-ui5-dialog-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-dialog.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-dialog is a extended ui5-dialog which can attach itself to a parent dom element.\n\nThis is helpful, when you have used z-indexes in one of the parents, which put the original ui5-dialog behind the backdrop.\n\nUse this component like a regular ui5-dialog and do not forget to place the furo-ui5-dialog-display in one of the parent elements.\n\nIt supports all features from the [SAP ui5 Dialog element](https://sap.github.io/ui5-webcomponents/playground/components/Dialog/).\n\n**important:** Place a furo-ui5-dialog-display in any dom parent of the component where you use furo-ui5-dialog. Your app-shell or body is a good place to do that.\n\n```html\n\n

Content

\n
\n\n\n\n```", "name": "FuroUi5Dialog", "members": [ { "kind": "method", "name": "show", "description": "shows the dialog" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true } ], "superclass": { "module": "src/furo-ui5-dialog.js" }, "tagName": "furo-ui5-dialog", "summary": "Dialog element", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Dialog", "declaration": { "name": "FuroUi5Dialog", "module": "src/furo-ui5-dialog.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-dynamic-header.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-dynamic-header`\n Header component with action slot", "name": "FuroUi5DynamicHeader", "members": [ { "kind": "method", "name": "collapse", "description": "Collapses the header content.\nThis method will do nothing, if the header is \"pinned\".", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "expand", "description": "Expands the header content.\nThis method will do nothing, if the header is \"pinned\".", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "bindHeaderText", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Bind any **scalar** field to set the title of the panel.\nSupported types: scalar types" }, { "kind": "method", "name": "bindSecondaryText", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Bind any **scalar** field to set the secondaryText of the panel." }, { "kind": "method", "name": "_toggle" }, { "kind": "method", "name": "_toggleOnKeyup" }, { "kind": "method", "name": "_pinClicked", "parameters": [ { "name": "e" } ], "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "_bodyIsScrolling", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "headerTextLevel", "privacy": "public", "type": { "text": "string" }, "description": "Defines the headerTextLevel of the component.", "default": "'H2'", "attribute": "header-text-level" }, { "kind": "field", "name": "iconSize", "privacy": "public", "type": { "text": "string" }, "description": "Defines the icon-size of the icon / image.\n\nS, M, L, XL", "default": "'S'", "attribute": "icon-size" }, { "kind": "field", "name": "iconShape", "privacy": "public", "type": { "text": "string" }, "description": "Defines the icon-shape of the icon / image.\nSquare | Circle", "default": "'Square'", "attribute": "icon-shape" }, { "kind": "field", "name": "_wheelhandler", "privacy": "private", "parameters": [ { "name": "e" } ] }, { "kind": "field", "name": "_scrollhandler", "privacy": "private" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the headerText of the component.", "attribute": "header-text" }, { "kind": "field", "name": "isFavorite", "privacy": "public", "type": { "text": "boolean" }, "description": "Shows the fovorite icon when set.", "attribute": "is-favorite" }, { "kind": "field", "name": "shadow", "privacy": "public", "type": { "text": "boolean" }, "description": "Draw a shadow, this is useful when you do not have a `tab-container` after your `dynamic-header`", "attribute": "shadow" }, { "kind": "field", "name": "showDropdown", "privacy": "public", "type": { "text": "boolean" }, "description": "Show the dropdown button icon after the header text.", "attribute": "show-dropdown" }, { "kind": "field", "name": "objectIcon", "privacy": "public", "type": { "text": "string" }, "description": "Set this value to display an object icon.", "attribute": "object-icon" }, { "kind": "field", "name": "bigAction", "privacy": "public", "type": { "text": "boolean" }, "description": "Set this attribute to get a bigger action slot.", "attribute": "big-action" }, { "kind": "field", "name": "collapsed", "privacy": "public", "type": { "text": "boolean" }, "description": "Set the collapsed attribute to start in a collapsed state. Header which are pinned by the user in collapsed or expanded state, will override\nthis attribute.", "attribute": "collapsed", "reflects": true }, { "kind": "field", "name": "isPinned", "privacy": "public", "type": { "text": "boolean" }, "description": "Set the is-pinned attribute to disable collapse and exand before unpin.", "attribute": "is-pinned" } ], "events": [ { "name": "pinned", "type": { "text": "CustomEvent" } }, { "name": "unpinned", "type": { "text": "CustomEvent" } }, { "description": "Fired when the variant icon (enable with show-dropdown) was clicked.", "name": "variant-icon-clicked" }, { "description": "Fired when the panel is collapsed.", "name": "collapsed" }, { "description": "Fired when the panel is expanded.", "name": "expanded" } ], "attributes": [ { "name": "header-text", "type": { "text": "string" }, "description": "Defines the headerText of the component.", "fieldName": "headerText" }, { "name": "header-text-level", "type": { "text": "string" }, "description": "Defines the headerTextLevel of the component.", "default": "'H2'", "fieldName": "headerTextLevel" }, { "name": "icon-size", "type": { "text": "string" }, "description": "Defines the icon-size of the icon / image.\n\nS, M, L, XL", "default": "'S'", "fieldName": "iconSize" }, { "name": "icon-shape", "type": { "text": "string" }, "description": "Defines the icon-shape of the icon / image.\nSquare | Circle", "default": "'Square'", "fieldName": "iconShape" }, { "name": "is-favorite", "type": { "text": "boolean" }, "description": "Shows the fovorite icon when set.", "fieldName": "isFavorite" }, { "name": "shadow", "type": { "text": "boolean" }, "description": "Draw a shadow, this is useful when you do not have a `tab-container` after your `dynamic-header`", "fieldName": "shadow" }, { "name": "show-dropdown", "type": { "text": "boolean" }, "description": "Show the dropdown button icon after the header text.", "fieldName": "showDropdown" }, { "name": "object-icon", "type": { "text": "string" }, "description": "Set this value to display an object icon.", "fieldName": "objectIcon" }, { "name": "big-action", "type": { "text": "boolean" }, "description": "Set this attribute to get a bigger action slot.", "fieldName": "bigAction" }, { "name": "collapsed", "type": { "text": "boolean" }, "description": "Set the collapsed attribute to start in a collapsed state. Header which are pinned by the user in collapsed or expanded state, will override\nthis attribute.", "fieldName": "collapsed" }, { "name": "is-pinned", "type": { "text": "boolean" }, "description": "Set the is-pinned attribute to disable collapse and exand before unpin.", "fieldName": "isPinned" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Dynamic Header", "tagName": "furo-ui5-dynamic-header", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "furo-ui5-dynamic-header", "declaration": { "name": "FuroUi5DynamicHeader", "module": "src/furo-ui5-dynamic-header.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-flexible-grid.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-flexible-grid will split your screen contents horizontally (in cols) and put them vertically (left at top)\nwhen the available space is to small.\n\n```html\n \n\n
\n \n
\n \n \n \n \n\n```\n\n## Setting column width\nTo set the width of a column use the `hspan` attribute.\n\n## Fill column to the end of the screen\nTo make a column that uses the available space you have to set a starting point. This can be done with `hstart=\"3\"`\n(begin on cell 3) and the attribute `fill` (fill to the right)\n\n ## full-on-[size]\n To set full width on a specific current size, use `full-on-size-small` , `full-on-size-medium` , `full-on-size-large` ,`full-on-size-xlarge`.\n\n When the available space has the given size, the default hspan are overridden and the full width is used.\n\n ## hstart\n Set the starting point of a filling row with `hstart=\"3\"`.\n\n Available values are `hstart=\"2\"`,...,`hstart=\"9\"`\n\n ## hspan\n Set the horizontal space (the width) with the *hspan* attribute.\n\n Available ranges are from 1 to 9.\n\n `hspan=\"1\"`, `hspan=\"2\"`,...,`hspan=\"9\"`\n\n## Named lines and columns\n**last-col** refers to the last column.\nThere is no line name available", "name": "FuroUi5FlexibleGrid", "slots": [ { "description": "{HTMLElement} - slot to add a component on the left hand side.", "name": "left" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "default slot to add content.", "name": "" } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_checkSize", "parameters": [ { "name": "size" } ], "description": "Form breakpoints according to SAP Fiori Design System\nhttps://experience.sap.com/fiori-design-web/form/", "privacy": "private" }, { "kind": "field", "name": "sizeSmall", "privacy": "public", "type": { "text": "Number" }, "description": "Breakpoint size for small", "attribute": "size-small" } ], "attributes": [ { "name": "size-small", "type": { "text": "Number" }, "description": "Breakpoint size for small", "fieldName": "sizeSmall" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-flexible-grid", "summary": "a grid splitter", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5FlexibleGrid", "declaration": { "name": "FuroUi5FlexibleGrid", "module": "src/furo-ui5-flexible-grid.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-flexible-grid", "declaration": { "name": "FuroUi5FlexibleGrid", "module": "src/furo-ui5-flexible-grid.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-form-field-container.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-form-field-container gives the user a layout to manage\ninput field and labels according to the design specification of SAP Fiori.\n\nExample\n\n```html\n\n Currency / Units (custom)\n \n \n \n \n\n```\n\nThe form and simple form in size L use a two-column layout within the responsive grid layout by default.\nThat means that the form groups are placed next to each other to have all the information on one screen and to\navoid scrolling. In these columns, the labels are positioned in the same row as the corresponding input field or value.\nSo the form groups adopt the Z layout (reading direction in rows, not in columns).\n\nThe label-field ratio is 4:8:0 by default:\n\n4 grid columns of the responsive grid layout are used by the labels.\n8 grid columns of the responsive grid layout are used by fields.\n0 grid columns of the responsive grid layout are used by empty columns.\n\n\nSize M of the form and simple form also has a single-column layout within the responsive grid layout by default.\nHowever, in size M the labels are positioned in the same row as the corresponding input field or value, and form\ngroups are positioned below each other.\n\nThe label-field ratio is 3:9:0 by default:\n\n2 grid columns of the responsive grid layout are used by the labels.\n10 grid columns of the responsive grid layout are used by the fields.\n0 columns of the responsive grid layout are used by empty columns.\n\n\nSize S (Smartphones and Dialogs)\nThe form and simple form use a single-column layout within the responsive grid layout in size S by default.\nThis means that the form groups are positioned below each other in a single column and the labels are positioned\n`above` the fields to avoid truncation of the labels.\n\nThe label-field ratio is 12:12:0 by default:\n\n12 grid columns of the responsive grid layout are used by the labels.\n(A label handles the space of a whole row.)\n12 grid columns of the responsive grid layout are used by the fields.\n(A field handles the space of a whole row.)\n0 grid columns of the responsive grid layout are used by empty columns.\n(There is no empty space on the right of the field.)", "name": "FuroUi5FormFieldContainer", "cssProperties": [ { "type": { "text": "N/A" }, "description": "grid row gap", "name": "--furo-ui5-form-field-container-grid-row-gap", "default": "0" }, { "type": { "text": "N/A" }, "description": "grid column gap", "name": "--furo-ui5-form-field-container-grid-column-gap", "default": "1em" }, { "type": { "text": "N/A" }, "description": "label alignment (start, end)", "name": "--furo-ui5-form-field-container-label-justify-gap", "default": "end" } ], "slots": [ { "type": { "text": "HTMLElement" }, "description": "defines the label to be displayed.", "name": "label" }, { "type": { "text": "HTMLElement" }, "description": "defines the form field to be displayed in the container element.", "name": "" } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_checkSize", "parameters": [ { "name": "size" } ], "description": "Form breakpoints according to SAP Fiori Design System\nhttps://experience.sap.com/fiori-design-web/form/", "privacy": "private" }, { "kind": "method", "name": "_setSizeAttribute", "parameters": [ { "name": "attrValue" } ], "description": "Sets data-size attribute", "privacy": "private" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-form-field-container", "summary": "responsive labels for your input elements", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5FormFieldContainer", "declaration": { "name": "FuroUi5FormFieldContainer", "module": "src/furo-ui5-form-field-container.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-form-field-container", "declaration": { "name": "FuroUi5FormFieldContainer", "module": "src/furo-ui5-form-field-container.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-header-panel.js", "declarations": [ { "kind": "class", "description": "A bindable **header** panel.\n\n**Info**: This component is intended to use as a header panel, if you need panels in your view, consider to use\na ui5-panel directly. That is also the reason that the api does not match with ui5-panel.\n\nThis component is a container which has a header and a content area and is used for grouping and displaying information.\nIt can be collapsed to save space on the screen.\n\n```html\n \n```", "name": "FuroUi5HeaderPanel", "cssProperties": [ { "type": { "text": "#ffffff" }, "description": "Color of the icon", "name": "--furo-ui5-header-panel-icon-color", "default": "--ui5-avatar-initials-color" }, { "type": { "text": "#354a5f" }, "description": "background Color of the icon", "name": "--furo-ui5-header-panel-icon-background-color", "default": "--ui5-avatar-accent6" }, { "type": { "text": "#0854a0" }, "description": "the gradient-start hex-Color of the splitter", "name": "--furo-ui5-header-panel-splitter-start-color", "default": "--sapHighlightColor" }, { "type": { "text": "rgba(8, 84, 16, 0)" }, "description": "the gradient-end rgba-Color of the splitter", "name": "--furo-ui5-header-panel-splitter-end-rgba-color", "default": "rgba(8, 84, 16, 0)" } ], "slots": [ { "type": { "text": "HTMLElement [0..n]" }, "description": "defines an action, displayed in the right most part of the header panel.", "name": "action" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the content of the panel ### Styling The following custom properties and mixins are available for styling:", "name": "" } ], "members": [ { "kind": "method", "name": "bindHeaderText", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Bind any **scalar** field to set the title of the panel.\nSupported types: scalar types" }, { "kind": "method", "name": "bindSecondaryText", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Bind any **scalar** field to set the secondaryText of the panel." }, { "kind": "method", "name": "bindNavNode", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "bind a furo.navigation.Navigationnode field" }, { "kind": "method", "name": "bindIcon", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Bind any **scalar** field to set the title of the panel.\nDo not forget to import the icon you will use in your component." }, { "kind": "method", "name": "toggleCollapse", "description": "toggles the collapse state" }, { "kind": "method", "name": "_setNavNodeSignatureValues", "parameters": [ { "name": "fieldNode" } ], "description": "update attributes according to the value of furo.navigation.Navigationnode signature", "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_setSizeAttribute", "parameters": [ { "name": "attrValue" } ], "description": "Sets data-size attribute", "privacy": "private" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "icon", "default": "''", "attribute": "icon" }, { "kind": "field", "name": "iconSize", "privacy": "public", "type": { "text": "string" }, "description": "size of the icon. Available options are: XS S M L XL. Default is S.", "default": "'S'", "attribute": "icon-size" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "Header Text", "default": "''", "attribute": "header-text" }, { "kind": "field", "name": "headerTextLevel", "privacy": "public", "type": { "text": "string" }, "description": "Set the level of the header text, default is H2", "default": "'H2'", "attribute": "header-text-level" }, { "kind": "field", "name": "secondaryText", "privacy": "public", "type": { "text": "string" }, "description": "sub title", "default": "''", "attribute": "secondary-text" }, { "kind": "field", "name": "collapsed", "privacy": "public", "type": { "text": "boolean" }, "description": "Collapsed", "default": "false", "attribute": "collapsed", "reflects": true }, { "kind": "field", "name": "nonInteractive", "privacy": "public", "type": { "text": "boolean" }, "description": "Disables the toggler tabindex.", "default": "false", "attribute": "non-interactive" }, { "kind": "field", "name": "headerIcon", "privacy": "public", "type": { "text": "string" }, "description": "Set this to have a clickable icon on the header line", "attribute": "header-icon" }, { "kind": "field", "name": "bigAction", "privacy": "public", "type": { "text": "Boolean" }, "description": "Set to true to have a bigger action area (50:50).\n\nThe default ratio for title:action slot is 75:25", "attribute": "big-action" } ], "events": [ { "name": "collapsed", "type": { "text": "Event" }, "description": "Fired when panel is collapsed by user interaction." }, { "name": "expanded", "type": { "text": "Event" }, "description": "Fired when panel is expanded by user interaction." }, { "description": "{buttonRef} Fired when the header icon was clicked.", "name": "header-icon-clicked" } ], "attributes": [ { "name": "header-text", "type": { "text": "string" }, "description": "Header Text", "default": "''", "fieldName": "headerText" }, { "name": "header-icon", "type": { "text": "string" }, "description": "Set this to have a clickable icon on the header line", "fieldName": "headerIcon" }, { "name": "header-text-level", "type": { "text": "string" }, "description": "Set the level of the header text, default is H2", "default": "'H2'", "fieldName": "headerTextLevel" }, { "name": "secondary-text", "type": { "text": "string" }, "description": "sub title", "default": "''", "fieldName": "secondaryText" }, { "name": "icon", "type": { "text": "string" }, "description": "icon", "default": "''", "fieldName": "icon" }, { "name": "icon-size", "type": { "text": "string" }, "description": "size of the icon. Available options are: XS S M L XL. Default is S.", "default": "'S'", "fieldName": "iconSize" }, { "name": "collapsed", "type": { "text": "boolean" }, "description": "Collapsed", "default": "false", "fieldName": "collapsed" }, { "name": "big-action", "type": { "text": "Boolean" }, "description": "Set to true to have a bigger action area (50:50).\n\nThe default ratio for title:action slot is 75:25", "fieldName": "bigAction" }, { "name": "non-interactive", "type": { "text": "boolean" }, "description": "Disables the toggler tabindex.", "default": "false", "fieldName": "nonInteractive" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-header-panel", "summary": "A bindable header panel", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5HeaderPanel", "declaration": { "name": "FuroUi5HeaderPanel", "module": "src/furo-ui5-header-panel.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-header-panel", "declaration": { "name": "FuroUi5HeaderPanel", "module": "src/furo-ui5-header-panel.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-markdown.js", "declarations": [ { "kind": "class", "description": "`furo-markdown`\n Renders given md data with parseMarkdown or loads a md file with `mdsrc=\"source.md\"`", "name": "FuroUi5Markdown", "members": [ { "kind": "field", "name": "mdsrc", "privacy": "public", "type": { "text": "String" }, "description": "source of the md", "attribute": "mdsrc" }, { "kind": "field", "name": "markdown", "privacy": "public", "type": { "text": "String" }, "description": "markdown string", "attribute": "markdown" }, { "kind": "method", "name": "fetchMd", "parameters": [ { "name": "src" } ], "description": "fetch markdown from a url or path", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "parseMarkdown", "parameters": [ { "name": "markdown" } ], "description": "Parse markdown string to html content" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "stringField" } ] }, { "kind": "method", "name": "_parseMarkdown", "parameters": [ { "name": "markdown" } ], "description": "parse markdown string to html content", "return": { "type": { "text": "TemplateResult | TemplateResult" } }, "privacy": "private" }, { "kind": "field", "name": "markdownRendered", "default": "undefined" }, { "kind": "field", "name": "unsafe", "privacy": "public", "type": { "text": "Boolean" }, "description": "allow unsafe md. (writing html, components,...)", "attribute": "unsafe" } ], "attributes": [ { "name": "unsafe", "type": { "text": "Boolean" }, "description": "allow unsafe md. (writing html, components,...)", "fieldName": "unsafe" }, { "name": "mdsrc", "type": { "text": "String" }, "description": "source of the md", "fieldName": "mdsrc" }, { "name": "markdown", "type": { "text": "String" }, "description": "markdown string", "fieldName": "markdown" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "renders markdown data", "tagName": "furo-ui5-markdown", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Markdown", "declaration": { "name": "FuroUi5Markdown", "module": "src/furo-ui5-markdown.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-markdown", "declaration": { "name": "FuroUi5Markdown", "module": "src/furo-ui5-markdown.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-message-container-display.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-message-container-display`\n Renders the contenst of a `furo.MessageContainer` or `google.rpc.Status` message.", "name": "FuroUi5MessageContainerDisplay", "members": [ { "kind": "method", "name": "bindRootNode", "parameters": [ { "name": "fieldNode", "description": "Any custom fieldnode", "type": { "text": "FieldNode" } } ], "description": "Bind your \"root node\" for the messages.\n\nThe state updates from the injected raw messagecontainer are applied to the fields of the root node.", "privacy": "public" }, { "kind": "method", "name": "bindMessageContainer", "parameters": [ { "name": "mcfieldnode" } ], "description": "bindData bind a furo.messagecontainer field node", "privacy": "public" }, { "kind": "method", "name": "_updateDisplay", "parameters": [ { "name": "details" } ], "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "hidden", "privacy": "private", "type": { "text": "boolean" }, "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "noFilter", "privacy": "public", "type": { "text": "Boolean" }, "description": "Removes the filter tabs on top.", "attribute": "no-filter" }, { "kind": "field", "name": "_hideFilterSection", "privacy": "private", "type": { "text": "boolean" }, "description": "helper var to hide the filter head section", "attribute": "_hideFilterSection" }, { "kind": "field", "name": "disableScrolling", "privacy": "public", "type": { "text": "Boolean" }, "description": "Disable the scrolling to the element, when the container receives data.", "attribute": "disable-scrolling" } ], "events": [ { "type": { "text": "Object" }, "description": "fired when a", "name": "message-item-clicked" } ], "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "fieldName": "hidden" }, { "name": "no-filter", "type": { "text": "Boolean" }, "description": "Removes the filter tabs on top.", "fieldName": "noFilter" }, { "name": "_hideFilterSection", "type": { "text": "boolean" }, "description": "helper var to hide the filter head section", "fieldName": "_hideFilterSection" }, { "name": "disable-scrolling", "type": { "text": "Boolean" }, "description": "Disable the scrolling to the element, when the container receives data.", "fieldName": "disableScrolling" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "todo shortdescription", "tagName": "furo-ui5-message-container-display", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MessageContainerDisplay", "declaration": { "name": "FuroUi5MessageContainerDisplay", "module": "src/furo-ui5-message-container-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-message-container-display", "declaration": { "name": "FuroUi5MessageContainerDisplay", "module": "src/furo-ui5-message-container-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-message-strip-display.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-message-strip-display is the render component for the furo-ui5-message-strip component.\nThe display component can be controlled by several furo-ui5-message-strip components.\n\n```\n \n\n \n \n```\n\n## CSS Style Vars\n- margin-top: var(--FuroUi5MediaSizeIndentationTop, 0);\n- margin-bottom: var(--FuroUi5MediaSizeIndentationBottom, 0);", "name": "FuroUi5MessageStripDisplay", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "clearAll", "description": "Removes all strips" }, { "kind": "method", "name": "show", "parameters": [ { "name": "source" }, { "name": "text" } ], "description": "show notification list item.", "privacy": "private" }, { "kind": "field", "name": "headerText", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_messageStrips", "type": { "text": "*[]" }, "privacy": "private", "default": "[]" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-message-strip-display", "summary": "furo ui5 message strip", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MessageStripDisplay", "declaration": { "name": "FuroUi5MessageStripDisplay", "module": "src/furo-ui5-message-strip-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-message-strip-display", "declaration": { "name": "FuroUi5MessageStripDisplay", "module": "src/furo-ui5-message-strip-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-message-strip.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-message-strip component enables the embedding of app-related messages. It displays 4 types of messages,\neach with corresponding semantic color and icon: Information, Positive, Warning and Negative.\nEach message can have a Close button, so that it can be removed from the UI, if needed.\n\nIt should be used together witch furo-ui5-message-strip-display. You can place those two components into different places.\nA good place for placing the furo-ui5-message-strip-display is on the app-shell.\nhttps://experience.sap.com/fiori-design-web/message-strip/\n\n ```html\n \n \n \n ```", "name": "FuroUi5MessageStrip", "members": [ { "kind": "method", "name": "_requestDisplay", "description": "request display message strip.\ntrigger `open-furo-ui5-message-strip-requested` event", "privacy": "private" }, { "kind": "method", "name": "_close", "description": "the event `message-strip-closed` will be sent with payload when the MessageStrip is closed", "privacy": "private" }, { "kind": "method", "name": "showInformation", "parameters": [ { "name": "msg" } ], "description": "shows an information message\nif the param msg is empty, the attribute message is used." }, { "kind": "method", "name": "showSuccess", "parameters": [ { "name": "msg" } ], "description": "shows a success message\nif the param msg is empty, the attribute message is used." }, { "kind": "method", "name": "showWarning", "parameters": [ { "name": "msg" } ], "description": "shows a warning message\nif the param msg is empty, the attribute message is used." }, { "kind": "method", "name": "showError", "parameters": [ { "name": "msg" } ], "description": "shows an error message\nif the param msg is empty, the attribute message is used." }, { "kind": "method", "name": "showGrpcLocalizedMessage", "parameters": [ { "name": "rpcStatus" } ], "description": "shows a google rpc status message (message LocalizedMessage)\nProvides a localized error message that is safe to return to the user\nwhich can be attached to an RPC error.\n\nRendering rules:\n- Every @type LocalizedMessage inside of details[] is displayed with a line break in the message strip.\n- One message strip element is created per RPC status.\n\nExample rpc status:\n\n```json\n{\n \"code\":3,\n \"message\":\"Missing mandatory values\",\n \"details\":[\n {\"@type\":\"type.googleapis.com/google.rpc.LocalizedMessage\",\"locale\":\"en-GB\",\"message\":\"Please register all the mandatory values.\"},\n {\"@type\":\"type.googleapis.com/google.rpc.LocalizedMessage\",\"locale\":\"en-GB\",\"message\":\"If you need help completing the data, call 0800-HELP-FURO.\"},\n {\"@type\":\"type.googleapis.com/google.rpc.BadRequest\",\"field_violations\":[\n {\"field\":\"short_form\",\"description\":\"The country designation (short form) should be set.\"},\n {\"field\":\"id\",\"description\":\"The id should be ISO Alpha-2 code as described in the ISO 3166 international standard\"},\n {\"field\":\"area\",\"description\":\"Please set a value for the field area.\"}]\n }\n ]}\n```\n\nExample message strip display:\n```\n| X Please register all the mandatory values.\n| If you need help completing the data, call 0800-HELP-FURO.\n```\n\nhttps://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto\nhttps://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto" }, { "kind": "field", "name": "hideCloseButton", "privacy": "public", "type": { "text": "boolean" }, "description": "Defines whether the MessageStrip renders close button.", "default": "false", "attribute": "hide-close-button" }, { "kind": "field", "name": "hideIcon", "privacy": "public", "type": { "text": "boolean" }, "description": "Defines whether the MessageStrip will show an icon in the beginning. You can directly provide an icon with the icon slot. Otherwise, the default icon for the type will be used.", "default": "false", "attribute": "hide-icon" }, { "kind": "field", "name": "displayMessage", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_md", "privacy": "private" }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "String" }, "description": "define the width of ui5-messagestrip. e.g. 200px", "attribute": "size" }, { "kind": "field", "name": "message", "privacy": "public", "type": { "text": "String" }, "description": "the text message of the message strip", "attribute": "message" } ], "events": [ { "type": { "text": "{Object} payload" }, "description": " Fired when the MessageStrip is closed", "name": "message-strip-closed" } ], "attributes": [ { "name": "hide-close-button", "type": { "text": "boolean" }, "description": "Defines whether the MessageStrip renders close button.", "default": "false", "fieldName": "hideCloseButton" }, { "name": "hide-icon", "type": { "text": "boolean" }, "description": "Defines whether the MessageStrip will show an icon in the beginning. You can directly provide an icon with the icon slot. Otherwise, the default icon for the type will be used.", "default": "false", "fieldName": "hideIcon" }, { "name": "size", "type": { "text": "String" }, "description": "define the width of ui5-messagestrip. e.g. 200px", "fieldName": "size" }, { "name": "message", "type": { "text": "String" }, "description": "the text message of the message strip", "fieldName": "message" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-message-strip", "summary": "furo ui5 message strip", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MessageStrip", "declaration": { "name": "FuroUi5MessageStrip", "module": "src/furo-ui5-message-strip.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-message-strip", "declaration": { "name": "FuroUi5MessageStrip", "module": "src/furo-ui5-message-strip.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-money-input-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-money-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5MoneyInputLabeled", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types: `google.type.Money`" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-money-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "google.type.Money" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-money-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-money-input-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MoneyInputLabeled", "declaration": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-money-input-labeled", "declaration": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-money-input.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-money-input is a input element composition for FieldNodes of type google.type.Money.\nIt consists of\n- ui5-input of type Number\n- furo-ui5-text-input\n\n You can set currencies dropdown with options in meta or set options attribute as json in element or set currencies as string in element. the three\n ways have priority : currencies > options as attribute > options in meta.\n\n```html\n \n \n \n```\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **required: true** , set the element to required\n\nTags: money input", "name": "FuroUi5MoneyInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type `google.type.Money`", "type": { "text": "FieldNode" } } ], "description": "Binds a fieldNode.\n\nSupported types: `google.type.Money`" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nAttributes that can be se are `required`,`readonly`,`disabled` ,\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Checks if options.flags has an entry `currency_list`\nIn this case the option list is applied to the currency field as suggestion items.\n\nIf you use a static option definition in the type specification (furo), you can\ndefine the list as follows:\n\n```\noptions:\n flags:\n - currency_list\n list:\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: Swiss francs (CHF)\n id: CHF\n selected: false\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: Euro (EUR)\n id: EUR\n selected: false\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: US Dollar (USD)\n id: USD\n selected: false\n```" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "privacy": "private" }, { "kind": "method", "name": "_convertDataToMoneyObj", "parameters": [ { "name": "currency" }, { "name": "amount" }, { "name": "obj" } ] }, { "kind": "method", "name": "_updateField", "parameters": [ { "name": "value" } ], "description": "update amount field\nOne issue with number inputs is that their step size is 1 by default.\nIf you try to enter a number with a decimal (such as \"1.0\"), it will be considered invalid.\nIf you want to enter a value that requires decimals, you'll need to reflect this in the step value\n(e.g. step=\"0.01\" to allow decimals to two decimal places).", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_getElements", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{readonly: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{required: undefined}" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, required: null}" }, "description": "A list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n }" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "Money" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "furo-value-changed" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" }, { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-money-input", "summary": "Binds a entityObject field google.type.Money to a number-input and currency dropdown fields", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MoneyInput", "declaration": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-money-input", "declaration": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-multi-combobox-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-multi-combobox-labeled`\nThe furo-ui5-multi-combobox-labeled is a composition to easily use a complete data multi-combobox with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5MultiComboboxLabeled", "slots": [ { "type": { "text": "HTMLElement" }, "description": "defines the value state message that will be displayed as pop up under the input element.", "name": "valueStateMessage" } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-multi-combobox component" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "idFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid", "default": "'id'", "attribute": "id-field-path" }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.", "default": "'id'", "attribute": "value-field-path" }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "id-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid", "default": "'id'", "fieldName": "idFieldPath" }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath" }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.", "default": "'id'", "fieldName": "valueFieldPath" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-multi-combobox-labeled", "summary": "labeled multi-combobox", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MultiComboboxLabeled", "declaration": { "name": "FuroUi5MultiComboboxLabeled", "module": "src/furo-ui5-multi-combobox-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-multi-combobox-labeled", "declaration": { "name": "FuroUi5MultiComboboxLabeled", "module": "src/furo-ui5-multi-combobox-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-multi-combobox.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-multi-combobox component is used to create a drop-down list. The items inside the furo-ui5-multi-combobox define\nthe available options by using the ui5-mcb-item component. Use the function bindOptions to bind a RepeaterNode as a option list.\n\n```html\n\n\n```", "name": "FuroUi5MultiCombobox", "members": [ { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `required`,`readonly`,`disabled`, `value-field-path`, `display-field-path`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list." }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "repeaterNode", "type": { "text": "RepeaterNode" } } ], "description": "Overridden bindData of FieldNodeAdapter", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "onFnaRepeatedFieldChanged", "parameters": [ { "name": "val" } ], "description": "Overridden onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "Overridden onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Overridden onFnaOptionsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "Overridden onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "Overridden onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "Overridden onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "selectOptionsByIds", "parameters": [ { "name": "ids", "description": "string} must match the data", "type": { "text": "[]" } } ], "description": "Selects an option by id.\nThe id field must be comparable." }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "_updateOptions", "parameters": [ { "name": "list" } ], "description": "Maps and updates array of option", "privacy": "private" }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private" }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the select value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "activeFieldBinding", "type": { "text": "boolean" }, "description": "Flag to indicate if a field is attached\nDefault: false", "default": "false" }, { "kind": "field", "name": "idFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid\ndefault: id\nThis attribute is related to the option list", "default": "'id'" }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'" }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'" }, { "kind": "field", "name": "valueFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.\ndefault: id\nThis attribute is related to the option list. optionList[selected].valueFieldPath ==> bound FieldNode", "default": "'id'" }, { "kind": "field", "name": "boundFieldIdPath", "type": { "text": "string" }, "description": "Defines the id field path of the bound FieldNode.\nPoint-separated path to the field\nMust be set if a data binding is specified with a complex type.\ndefault: id\nThis attribute is related to the bound FieldNode.", "default": "'id'" }, { "kind": "field", "name": "_optionList", "type": { "text": "*[]" }, "description": "Internal RepeaterNode\nDefines the ui5-select options.\nNote: Only one selected option is allowed. If more than one option is defined as selected, the last one would be considered as the selected one.", "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in furo-ui5-multi-combobox components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n 'id-field-path': 'id',\n 'value-field-path': 'id',\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n 'bound-field-id-path': 'id',\n }" } ], "events": [ { "name": "options-updated", "type": { "text": "optionNodeList" }, "description": "Fired after the option list was rebuilt." }, { "type": { "text": "[string]" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents-icons/dist/alert.js" }, "tagName": "furo-ui5-multi-combobox", "summary": "data select field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MultiCombobox", "declaration": { "name": "FuroUi5MultiCombobox", "module": "src/furo-ui5-multi-combobox.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-multi-input-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-multi-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5MultiInputLabeled", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types: repeated string" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-multi-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" }, { "kind": "field", "name": "showValueHelpIcon", "privacy": "public", "type": { "text": "Boolean" }, "description": "Determines whether a value help icon will be should in the end of the input.\n\nPressing the icon will fire `value-help-trigger` event.", "attribute": "show-value-help-icon" } ], "events": [ { "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-multi-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "show-value-help-icon", "type": { "text": "Boolean" }, "description": "Determines whether a value help icon will be should in the end of the input.\n\nPressing the icon will fire `value-help-trigger` event.", "fieldName": "showValueHelpIcon" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-multi-input-labeled", "summary": "labeled textarea field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MultiInputLabeled", "declaration": { "name": "FuroUi5MultiInputLabeled", "module": "src/furo-ui5-multi-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-multi-input-labeled", "declaration": { "name": "FuroUi5MultiInputLabeled", "module": "src/furo-ui5-multi-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-multi-input.js", "declarations": [ { "kind": "class", "description": "A furo-ui5-multi-input field allows the user to enter multiple values, which are displayed as ui5-token.\nhttps://sap.github.io/ui5-webcomponents/playground/components/MultiInput/\n\nSupported type: repeated string\n\n```html\n\n```", "name": "FuroUi5MultiInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: repeated string" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNewDataInjected", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldNewDataInjected", "privacy": "private" }, { "kind": "method", "name": "onFnaRepeatedFieldChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaRepeatedFieldChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "_updateItems", "parameters": [ { "name": "val" } ], "privacy": "private" }, { "kind": "method", "name": "_createUi5Token", "parameters": [ { "name": "text" } ], "privacy": "private" }, { "kind": "method", "name": "_triggerValueChangedEvent", "parameters": [ { "name": "val" } ], "privacy": "private" }, { "kind": "method", "name": "_removeAllItems", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "tmpValue", "type": { "text": "array" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{readonly: undefined, placeholder: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in textarea-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n }" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/Token.js" }, "tagName": "furo-ui5-multi-input", "summary": "repeated strings", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MultiInput", "declaration": { "name": "FuroUi5MultiInput", "module": "src/furo-ui5-multi-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-notification-group-display.js", "declarations": [ { "kind": "class", "description": "Notification display component that works together with furo-ui5-notification.\nBest place the furo-ui5-notification-group-display on the main site. then you only need one furo-ui5-notification-group-display.\nyou can also use more furo-ui5-notification-group-display's for special needs. But You have to be sure the furo-ui5-notification-group-display can receive the notification events.", "name": "FuroUi5NotificationGroupDisplay", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_groupNotifications", "parameters": [ { "name": "c" } ], "description": "group the notification messages\nthe notification message should be an array of the following object signature:\n{\n \"id\": 1,\n \"display_name\": \"\",\n \"heading\": \"heading 1\",\n \"message_priority\": \"High\",\n \"category\": \"warning\", // this attribute will be also used as group heading\n \"category_priority\": \"High\",\n \"actions\": [\n {\n \"icon\":\"accept\",\n \"command\":\"accept\",\n \"text\": \"accept\"\n },\n {\n \"icon\":\"message-error\",\n \"command\":\"reject\",\n \"text\": \"Reject\"\n }\n ],\n \"message\": \"Markdown | Less | Pretty\\n--- | --- | ---\\n*Still* | `renders` | **nicely**\\n1 | 2 | 3\"\n}", "privacy": "private" }, { "kind": "method", "name": "_show", "parameters": [ { "name": "groups" } ], "description": "show notification list item.", "privacy": "private" }, { "kind": "method", "name": "clearAll", "description": "clear all notifications" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "the header text of the notification", "default": "''", "attribute": "header-text" }, { "kind": "field", "name": "target", "privacy": "public", "type": { "text": "Object" }, "description": "the target dom object, which sends the notification event", "attribute": "target" }, { "kind": "field", "name": "collapsed", "privacy": "public", "type": { "text": "Boolean" }, "description": "Defines if the group is collapsed or expanded.", "attribute": "collapsed" }, { "kind": "field", "name": "showCounter", "privacy": "public", "type": { "text": "Boolean" }, "description": "Defines if the items counter would be displayed.", "attribute": "show-counter" }, { "kind": "field", "name": "showClose", "privacy": "public", "type": { "text": "Boolean" }, "description": "Defines if the close button would be displayed.", "attribute": "show-close" } ], "attributes": [ { "name": "header-text", "type": { "text": "string" }, "description": "the header text of the notification", "default": "''", "fieldName": "headerText" }, { "name": "target", "type": { "text": "Object" }, "description": "the target dom object, which sends the notification event", "fieldName": "target" }, { "name": "collapsed", "type": { "text": "Boolean" }, "description": "Defines if the group is collapsed or expanded.", "fieldName": "collapsed" }, { "name": "show-counter", "type": { "text": "Boolean" }, "description": "Defines if the items counter would be displayed.", "fieldName": "showCounter" }, { "name": "show-close", "type": { "text": "Boolean" }, "description": "Defines if the close button would be displayed.", "fieldName": "showClose" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-notification-group-display", "summary": "ui5 notification group display", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5NotificationGroupDisplay", "declaration": { "name": "FuroUi5NotificationGroupDisplay", "module": "src/furo-ui5-notification-group-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-notification-group-display", "declaration": { "name": "FuroUi5NotificationGroupDisplay", "module": "src/furo-ui5-notification-group-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-notification-list-display.js", "declarations": [ { "kind": "class", "description": "Notification display component that works together with furo-ui5-notification.\nDisplays google.rpc.Status messages in a grouped list.\nhttps://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto.\n\nBest place the furo-ui5-notification-list-display on the main site. then you only need one furo-ui5-notification-list-display.\nyou can also use more than one furo-ui5-notification-list-display for special needs.\nBut you have to be sure the furo-ui5-notification-list-display can receive the notification events from furo-ui5-notification.", "name": "FuroUi5NotificationListDisplay", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "parseGrpcStatus", "parameters": [ { "name": "d" } ], "description": "parse grpc status object and set the notification text according to the LocalizedMessage in status.\nhttps://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto." }, { "kind": "method", "name": "parseNotificationMessage", "parameters": [ { "name": "message" } ], "description": "parse notification message and set the ui5 notification properties like priority, actions, heading..\nthe notification message should be a furo.notification type:\n{\n \"id\": 1,\n \"display_name\": \"\",\n \"heading\": \"heading 1\",\n \"message_priority\": \"High\",\n \"category\": \"warning\",\n \"category_priority\": \"High\",\n \"actions\": [\n {\n \"icon\":\"accept\",\n \"command\":\"accept\",\n \"text\": \"accept\"\n },\n {\n \"icon\":\"message-error\",\n \"command\":\"reject\",\n \"text\": \"Reject\"\n }\n ],\n \"message\": \"Markdown | Less | Pretty\\n--- | --- | ---\\n*Still* | `renders` | **nicely**\\n1 | 2 | 3\"\n}" }, { "kind": "method", "name": "_show", "description": "shows grpc status notifications\nimplemented types are:\n- Bad Request with Field Violations\n-" }, { "kind": "method", "name": "_dispatchNotificationCounterUpdates", "parameters": [ { "name": "count" } ] }, { "kind": "method", "name": "_createLocalizedMessageElement", "description": "Creates notification items of type @type: \"type.googleapis.com/google.rpc.LocalizedMessage\"", "return": { "type": { "text": "Promise" } }, "privacy": "private" }, { "kind": "method", "name": "_createHelpElements", "description": "Creates notification items of type @type: \"type.googleapis.com/google.rpc.Help\"", "return": { "type": { "text": "Promise" } }, "privacy": "private" }, { "kind": "method", "name": "_createBadRequestElements", "description": "Creates notification items of type @type: \"type.googleapis.com/google.rpc.BadRequest\"", "return": { "type": { "text": "Promise" } }, "privacy": "private" }, { "kind": "method", "name": "clearAll", "description": "clear all notifications" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "the header text of the notification", "default": "''", "attribute": "header-text" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the text that is displayed when the list contains no items.", "default": "'No messages'", "attribute": "no-data-text" }, { "kind": "field", "name": "_notificationCount", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "groupTitleHelp", "privacy": "public", "type": { "text": "string" }, "description": "Defines the notification group element title for notifications of type\n\"type.googleapis.com/google.rpc.Help\"", "default": "'Help'", "attribute": "group-title-help" }, { "kind": "field", "name": "groupTitleBadRequest", "privacy": "public", "type": { "text": "string" }, "description": "Defines the notification group element title for notifications of type\n\"type.googleapis.com/google.rpc.BadRequest\"", "default": "'Bad Request'", "attribute": "group-title-bad-request" }, { "kind": "field", "name": "groupTitleMessage", "privacy": "public", "type": { "text": "string" }, "description": "Defines the notification group element title for notifications of type\n\"type.googleapis.com/google.rpc.LocalizedMessage\"", "default": "'Information'", "attribute": "group-title-message" }, { "kind": "field", "name": "_md" }, { "kind": "field", "name": "showClose", "privacy": "public", "type": { "text": "Boolean" }, "description": "Defines if the close button would be displayed.", "attribute": "show-close" } ], "events": [ { "name": "notification-counter-update", "type": { "text": "CustomEvent" } }, { "type": { "text": "Number" }, "description": "Fires a notification counter changed. Use this event to show the amount of notifications to the user.", "name": "furo-value-changed" } ], "attributes": [ { "name": "header-text", "type": { "text": "string" }, "description": "the header text of the notification", "default": "''", "fieldName": "headerText" }, { "name": "show-close", "type": { "text": "Boolean" }, "description": "Defines if the close button would be displayed.", "fieldName": "showClose" }, { "name": "no-data-text", "type": { "text": "string" }, "description": "Defines the text that is displayed when the list contains no items.", "default": "'No messages'", "fieldName": "noDataText" }, { "name": "group-title-message", "type": { "text": "string" }, "description": "Defines the notification group element title for notifications of type\n\"type.googleapis.com/google.rpc.LocalizedMessage\"", "default": "'Information'", "fieldName": "groupTitleMessage" }, { "name": "group-title-help", "type": { "text": "string" }, "description": "Defines the notification group element title for notifications of type\n\"type.googleapis.com/google.rpc.Help\"", "default": "'Help'", "fieldName": "groupTitleHelp" }, { "name": "group-title-bad-request", "type": { "text": "string" }, "description": "Defines the notification group element title for notifications of type\n\"type.googleapis.com/google.rpc.BadRequest\"", "default": "'Bad Request'", "fieldName": "groupTitleBadRequest" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-notification-list-display", "summary": "ui5 notification list", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5NotificationListDisplay", "declaration": { "name": "FuroUi5NotificationListDisplay", "module": "src/furo-ui5-notification-list-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-notification-list-display", "declaration": { "name": "FuroUi5NotificationListDisplay", "module": "src/furo-ui5-notification-list-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-notification.js", "declarations": [ { "kind": "class", "description": "furo-ui5-notification should be used together witch furo-ui5-notification-list-display or furo-ui5-notification-group-display. you can place those two components into different places.\nbest place the furo-ui5-notification-list(or group)-display on the main site. then you only need one furo-ui5-notification-list(or group)-display. it can work with n furo-ui5-notification.", "name": "FuroUi5Notification", "members": [ { "kind": "method", "name": "_requestListDisplay", "description": "request to display the notifications", "parameters": [ { "description": "payload", "name": "p", "type": { "text": "Object" } } ], "privacy": "private" }, { "kind": "method", "name": "_requestGroupDisplay", "description": "request to display the notifications in group", "parameters": [ { "description": "payload", "name": "p", "type": { "text": "Object" } } ], "privacy": "private" }, { "kind": "method", "name": "_close", "parameters": [ { "name": "message" } ], "description": "trigger event when notification is closed", "privacy": "private" }, { "kind": "method", "name": "_customAction", "parameters": [ { "name": "command" }, { "name": "message" } ], "description": "trigger events when notification actions are triggered", "privacy": "private" }, { "kind": "method", "name": "parseGrpcStatus", "parameters": [ { "name": "status" }, { "name": "s" } ], "description": "inject a grpc status object\nparse grpc status object and set the label according to the LocalizedMessage in status.\nhttps://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto ." }, { "kind": "method", "name": "injectNotificationCollection", "parameters": [ { "name": "c" } ], "description": "inject an array of notification messages.\nthe notification message should be an array of the following object signature:\n{\n \"id\": 1,\n \"display_name\": \"\",\n \"heading\": \"heading 1\",\n \"message_priority\": \"High\",\n \"category\": \"warning\",\n \"category_priority\": \"High\",\n \"actions\": [\n {\n \"icon\":\"accept\",\n \"command\":\"accept\",\n \"text\": \"accept\"\n },\n {\n \"icon\":\"message-error\",\n \"command\":\"reject\",\n \"text\": \"Reject\"\n }\n ],\n \"message\": \"Markdown | Less | Pretty\\n--- | --- | ---\\n*Still* | `renders` | **nicely**\\n1 | 2 | 3\"\n}" }, { "kind": "method", "name": "parseFieldValidityMessages", "parameters": [ { "name": "fieldViolations" } ], "description": "Parses the output of dataObject.getValidityMessages and\ntransforms the incoming data into a google.rpc.Status message of type google.rpc.BadRequest with\na list of field violations as content" }, { "kind": "field", "name": "dismissButtonText", "type": { "text": "string" }, "default": "'dismiss'" }, { "kind": "field", "name": "text", "privacy": "public", "type": { "text": "String" }, "description": "banner text content. Use *word* to mark as strong. Use \\n to insert a line break.\n\n*HTML tags will be stripped out.*", "attribute": "text" }, { "kind": "field", "name": "payload", "privacy": "public", "type": { "text": "Object" }, "description": "payload. can be a GRPC error or a notification message collection.", "attribute": "payload" }, { "kind": "field", "name": "_type", "privacy": "private", "type": { "text": "string" }, "description": "type of the notification. `grpc` or `notification`", "attribute": "_type" } ], "events": [ { "type": { "text": "{Object} this" }, "description": " Fired when value open banner is requested", "name": "open-furo-ui5-notification-requested" }, { "type": { "text": "{Object} this" }, "description": " Fired when value open banner is requested", "name": "open-furo-ui5-notification-group-requested" }, { "type": { "text": "{Object} payload" }, "description": " Fired when notification is closed.", "name": "notification-closed." }, { "type": { "text": "{Object} payload" }, "description": " Fired when notification custom action is triggered. this is a general action event.", "name": "notification-custom-action" }, { "type": { "text": "{Object} payload" }, "description": " Fired when notification custom action is triggered.", "name": "notification-custom-action-`commandName`" } ], "attributes": [ { "name": "text", "type": { "text": "String" }, "description": "banner text content. Use *word* to mark as strong. Use \\n to insert a line break.\n\n*HTML tags will be stripped out.*", "fieldName": "text" }, { "name": "payload", "type": { "text": "Object" }, "description": "payload. can be a GRPC error or a notification message collection.", "fieldName": "payload" }, { "name": "_type", "type": { "text": "string" }, "description": "type of the notification. `grpc` or `notification`", "fieldName": "_type" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-notification", "summary": "trigger component for notifications", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Notification", "declaration": { "name": "FuroUi5Notification", "module": "src/furo-ui5-notification.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-notification", "declaration": { "name": "FuroUi5Notification", "module": "src/furo-ui5-notification.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-number-input-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-number-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5NumberInputLabeled", "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc." }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-number-input-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5NumberInputLabeled", "declaration": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-number-input-labeled", "declaration": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-number-input.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-number-input component allows the user to enter and edit numbers with data binding.\nIt supports all features from the [SAP ui5 Input element](https://sap.github.io/ui5-webcomponents/playground/components/Input/).\n\nYou can bind any `number` type, any `furo.fat.xxx` number type, `furo.BigDecimal` or the `google.wrapper.xxx` number types.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta | fat | html |\n|------ |----- |------ |\n| 1 | 10 | 100 |\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"required\":\"true\"** set the element to required\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"placeholder\":\"string\"** set the placeholder for the element\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind a entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5NumberInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }" } ], "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input" }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/features/InputSuggestions.js" }, "tagName": "furo-ui5-number-input", "summary": "data number input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5NumberInput", "declaration": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-pagination-bar.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-pagination-bar element loops the hateoas array and finds out the pagination\ninformation like prev, next, first and last\n\n```\n \n```", "name": "FuroUi5PaginationBar", "cssProperties": [ { "type": { "text": "1rem" }, "description": "Right padding definition", "name": "--furo-ui5-pagination-bar-padding-right", "default": "1rem" }, { "type": { "text": "#ffffff" }, "description": "Background color", "name": "--furo-ui5-pagination-bar-background-color", "default": "--sapPageHeader_Background" } ], "slots": [ { "type": { "text": "HTMLElement" }, "description": "Defines the content at the start of the bar", "name": "start" }, { "type": { "text": "HTMLElement" }, "description": "Defines the content in the middle of the bar Tags: pagination", "name": "default" } ], "members": [ { "kind": "method", "name": "inject", "parameters": [ { "name": "hts" } ], "description": "init pagination attributes\nSupported type: furo.Link" }, { "kind": "method", "name": "_disableAll", "privacy": "private" }, { "kind": "method", "name": "getCurrentPage", "parameters": [ { "name": "href" } ], "description": "get current page number via self link: page=xx", "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "privacy": "private" }, { "kind": "field", "name": "currentPage", "privacy": "public", "type": { "text": "number" }, "default": "0", "attribute": "currentPage" }, { "kind": "field", "name": "first", "privacy": "public", "type": { "text": "boolean" }, "attribute": "first" }, { "kind": "field", "name": "prev", "privacy": "public", "type": { "text": "boolean" }, "attribute": "prev" }, { "kind": "field", "name": "next", "privacy": "public", "type": { "text": "boolean" }, "attribute": "next" }, { "kind": "field", "name": "last", "privacy": "public", "type": { "text": "boolean" }, "attribute": "last" } ], "events": [ { "name": "hts-injected", "type": { "text": "CustomEvent" } }, { "description": " Is fired if the pagination button 'sys_first_page' was clicked", "name": "pagination-first" }, { "description": " Is fired if the pagination button 'sys_last_page' was clicked", "name": "pagination-last" }, { "description": " Is fired if the pagination button 'sys_prev_page' was clicked", "name": "pagination-prev" }, { "description": " Is fired if the pagination button 'sys_next_page' was clicked", "name": "pagination-next" } ], "attributes": [ { "name": "currentPage", "type": { "text": "number" }, "default": "0", "fieldName": "currentPage" }, { "name": "first", "type": { "text": "boolean" }, "fieldName": "first" }, { "name": "prev", "type": { "text": "boolean" }, "fieldName": "prev" }, { "name": "next", "type": { "text": "boolean" }, "fieldName": "next" }, { "name": "last", "type": { "text": "boolean" }, "fieldName": "last" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-pagination-bar", "summary": "Pagination Bar", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5PaginationBar", "declaration": { "name": "FuroUi5PaginationBar", "module": "src/furo-ui5-pagination-bar.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-pagination-bar", "declaration": { "name": "FuroUi5PaginationBar", "module": "src/furo-ui5-pagination-bar.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-password-input-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-password-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5PasswordInputLabeled", "slots": [ { "type": { "text": "HTMLElement" }, "description": "defines the icon to be displayed in the input element.", "name": "icon" } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types: string, google.protobuf.StringValue, furo.fat.String" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-password-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-password-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-password-input-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5PasswordInputLabeled", "declaration": { "name": "FuroUi5PasswordInputLabeled", "module": "src/furo-ui5-password-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-password-input-labeled", "declaration": { "name": "FuroUi5PasswordInputLabeled", "module": "src/furo-ui5-password-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-password-input.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-password-input' component allows the user to enter and edit password with data binding.\nIt supports all features from the [SAP ui5 Input element](https://sap.github.io/ui5-webcomponents/playground/components/Input/).\n\nYou can bind any `string` type, like `furo.fat.String` type or the `google.protobuf.StringValue` type.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n** meta \t< fat \t< html \t**\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"required\":\"true\"** set the element to required\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"icon\":\"home\"** set the icon\n - **\"placeholder\":\"string\"** set the placeholder for the element\n - **\"max\":\"number\"** set the maximum number of characters available in the input field.\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **max:\"number\"** set the maximum number of characters available in the input field.\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind a entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5PasswordInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: string, google.protobuf.StringValue, furo.fat.String" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private" }, { "kind": "method", "name": "show", "description": "show password" }, { "kind": "method", "name": "hide", "description": "hide password" }, { "kind": "method", "name": "toggleVisibility", "description": "toggle visibility of the password. (show/hide) password" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'Password'" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n icon: undefined, // updates the icon\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n maxlength: null,\n }" } ], "events": [ { "type": { "text": "`text`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input" }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" }, { "type": { "text": "MouseEvent" }, "description": "Fired when icon is clicked", "name": "icon-clicked" }, { "type": { "text": "void" }, "description": "Fired when the password is showed, after calling the show method.", "name": "password-showed" }, { "type": { "text": "void" }, "description": "Fired when the password is hidden, after calling the hide() method.", "name": "password-hidden" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/features/InputSuggestions.js" }, "tagName": "furo-ui5-password-input", "summary": "data password input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5PasswordInput", "declaration": { "name": "FuroUi5PasswordInput", "module": "src/furo-ui5-password-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-progress-indicator.js", "declarations": [ { "kind": "class", "description": "A furo-ui5-progress-indicator shows the progress of a process in a graphical way. To indicate the progress, the inside of the component is filled with a color..\nhttps://sap.github.io/ui5-webcomponents/playground/components/ProgressIndicator/\n\nSupported type: You can bind any `number` type, any `furo.fat.xxx` number type, `furo.BigDecimal` or the `google.wrapper.xxx` number types\n\n```html\n\n```", "name": "FuroUi5ProgressIndicator", "members": [ { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "__previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/features/InputSuggestions.js" }, "tagName": "furo-ui5-progress-indicator", "summary": "repeated strings", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ProgressIndicator", "declaration": { "name": "FuroUi5ProgressIndicator", "module": "src/furo-ui5-progress-indicator.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-property.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-property`\n Field for type **furo.Property**. This can be used to display \"dynamic\" fields aka properties.\n\n `furo-ui5-property` works with repeated types and non repeating property types.\n\n ```html\n \n ```\n\n **Example data for the data-object looks like this**\n\n ```json\n \"single_type_property\": {\n \"data\": {\n \"@type\": \"google.type.Date\",\n \"day\": 8,\n \"month\": 11,\n \"year\": 2022\n },\n \"display_name\": \"a date\",\n \"id\": \"date\",\n \"code\": \"date\",\n \"meta\": {\n \"fields\": {\n \"data\": {\n \"meta\": {\n \"label\": \"Additional fields\",\n \"hint\": \"this is data\"\n },\n \"constraints\": {\n \"min\": {\n \"value\": \"2019-09-09\",\n \"message\": \"to small\"\n }\n }\n }\n }\n }\n }\n ```", "name": "FuroUi5Property", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "propertyField" } ] }, { "kind": "method", "name": "_createPropComponent", "parameters": [ { "name": "propertyField" } ], "privacy": "private" }, { "kind": "field", "name": "context", "privacy": "public", "type": { "text": "string" }, "description": "Set the context, for the renderers.", "default": "'form'", "attribute": "context" } ], "attributes": [ { "name": "context", "type": { "text": "string" }, "description": "Set the context, for the renderers.", "default": "'form'", "fieldName": "context" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-property", "summary": "????? bind types of type any", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Property", "declaration": { "name": "FuroUi5Property", "module": "src/furo-ui5-property.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-property", "declaration": { "name": "FuroUi5Property", "module": "src/furo-ui5-property.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-propertylist-display.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-propertylist-display` allows the user to show repeated properties (furo.Property) in a readonly mode.\nFor all other types you can use furo-ui5-typerenderer-labeled.\n\nThe type information of the property is used for the display of the individual attributes.\nE.g.\n```\n[\n {\n \"code\": \"c0a7f550-0fbe-4046-8fa9-60c86327b6b1\",\n \"data\": {\n \"@type\": \"type.googleapis.com/furo.StringProperty\",\n \"data\": \"01032020\"\n },\n \"flags\": [],\n \"display_name\": \"Vertragsbeginn\",\n \"id\": \"246d79a0-0a15-43c5-b18f-ac8a4a449df1\",\n \"meta\": {}\n }\n]\n```\n\nYou can bind the furo.Property type (single and repeated).\n\n```html\n \n```", "name": "FuroUi5PropertylistDisplay", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a RepeaterNode of type furo.Property.", "return": { "type": { "text": "boolean" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-typerenderer-labeled", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5PropertylistDisplay", "declaration": { "name": "FuroUi5PropertylistDisplay", "module": "src/furo-ui5-propertylist-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-propertylist-display", "declaration": { "name": "FuroUi5PropertylistDisplay", "module": "src/furo-ui5-propertylist-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-radio-button.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-radio-button' component allows the user to switch true and false for Bool with data binding.\n\nIt supports all features from the [SAP ui5 toggleButton element](https://sap.github.io/ui5-webcomponents/playground/components/ToggleButton/).\n\nYou can bind `bool` type, `furo.fat.Bool` type or the `google.wrapper.BoolValue` type.\n\n```html\n \n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta | fat | html |\n|------ |----- |------ |\n| 1 | 10 | 100 |\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"icon\":\"\"** set the icon\n - **\"value-state\":\"\"** set the value-state\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n\nThe constraint **required** will mark the element as required\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5RadioButton", "members": [ { "kind": "method", "name": "syncGroup", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the toggleButton changes.", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "description": "overwrite onFnaFieldNodeBecameInvalid function" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueState", "parameters": [ { "name": "valueState" } ], "description": "Updates the state", "privacy": "private" }, { "kind": "method", "name": "_resetValueState", "description": "reset to previous value state", "privacy": "private" }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "text" }, { "name": "placeholder" } ], "description": "overwrite onFnaLabelChanged function\nlabel is mapped to text" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_previousValueState", "type": { "text": "string" }, "default": "'None'" }, { "kind": "field", "name": "_tmpFAT", "type": { "text": "object" }, "default": "{ labels: {}, value: false }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "default": "{\n readonly: undefined,\n disabled: undefined,\n label: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "default": "{}" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "default": "{\n name: undefined, // the group name\n label: undefined,\n icon: undefined,\n 'value-state': undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "default": "{\n name: null,\n readonly: null,\n disabled: null,\n text: null,\n icon: null,\n 'value-state': null,\n }" } ], "events": [ { "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "type": { "text": "Boolean" }, "description": "Fired when value changed", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "module": "src/furo-ui5-radio-button.js" }, "tagName": "furo-ui5-radio-button", "summary": "boolean toggle button", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5RadioButton", "declaration": { "name": "FuroUi5RadioButton", "module": "src/furo-ui5-radio-button.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-rating-indicator.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-rating-indicator is used to display a specific number of icons that are used to rate an item.\nAdditionally, it is also used to display the average and overall ratings.\nhttps://sap.github.io/ui5-webcomponents/playground/components/RatingIndicator/\n\nYou can bind any `number` type, any `furo.fat.xxx` number type, `furo.BigDecimal` or the `google.wrapper.xxx` number types.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta | fat | html |\n|------ |----- |------ |\n| 1 | 10 | 100 |\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"disabled\":\"true\"** set the element to disabled\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n\n## Methods\n**bind-data(fieldNode)**\nBind aa entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5RatingIndicator", "members": [ { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `readonly`,`disabled`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n disabled: null,\n }" } ], "events": [ { "type": { "text": "`number`" }, "description": " Fired when the values changes.", "name": "change" }, { "type": { "text": "`number`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "module": "src/furo-ui5-rating-indicator.js" }, "tagName": "furo-ui5-rating-indicator", "summary": "data rating input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5RatingIndicator", "declaration": { "name": "FuroUi5RatingIndicator", "module": "src/furo-ui5-rating-indicator.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-reference-search-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-reference-search-labeled`\nThe furo-ui5-reference-search-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5ReferenceSearchLabeled", "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "clearResultList", "description": "clearResultList clears the result list and the value state", "privacy": "public" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: can be a `scalar` type or any complex type with **{'id','display_name'}** signature." }, { "kind": "method", "name": "setFilter", "parameters": [ { "name": "filter" } ], "description": "sets the filter to the inner furo-ui5-reference-search" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "hint text when result not found by search", "attribute": "no-data-text" }, { "kind": "field", "name": "service", "privacy": "public", "type": { "text": "string" }, "description": "the service name", "default": "''", "attribute": "service" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-reference-search", "default": "''", "attribute": "label" }, { "kind": "field", "name": "method", "privacy": "public", "type": { "text": "string" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "default": "''", "attribute": "method" }, { "kind": "field", "name": "extendedSearcher", "privacy": "public", "type": { "text": "string" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "default": "''", "attribute": "extended-searcher" }, { "kind": "field", "name": "disableSearchList", "privacy": "public", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "attribute": "disable-search-list" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "attribute": "icon" }, { "kind": "field", "name": "searchResponsePath", "privacy": "public", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "attribute": "search-response-path" }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "attribute": "value-field-path" }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "attribute": "display-field-path" }, { "kind": "field", "name": "extendedValueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "attribute": "extended-value-field-path" }, { "kind": "field", "name": "extendedDisplayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "attribute": "extended-display-field-path" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "String" }, "description": "Overrides the hint text from the **specs**.\nUse with caution, normally the specs defines this value.", "attribute": "placeholder" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "Readonly state", "attribute": "readonly" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" } ], "attributes": [ { "name": "service", "type": { "text": "string" }, "description": "the service name", "default": "''", "fieldName": "service" }, { "name": "method", "type": { "text": "string" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "default": "''", "fieldName": "method" }, { "name": "label", "type": { "text": "string" }, "description": "the label for the data-reference-search", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "fieldName": "valueFieldPath" }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "fieldName": "displayFieldPath" }, { "name": "search-response-path", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "fieldName": "searchResponsePath" }, { "name": "extended-value-field-path", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "fieldName": "extendedValueFieldPath" }, { "name": "extended-display-field-path", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "fieldName": "extendedDisplayFieldPath" }, { "name": "placeholder", "type": { "text": "String" }, "description": "Overrides the hint text from the **specs**.\nUse with caution, normally the specs defines this value.", "fieldName": "placeholder" }, { "name": "icon", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "fieldName": "icon" }, { "name": "disable-search-list", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "fieldName": "disableSearchList" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "Readonly state", "fieldName": "readonly" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "extended-searcher", "type": { "text": "string" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "default": "''", "fieldName": "extendedSearcher" }, { "name": "no-data-text", "type": { "text": "String" }, "description": "hint text when result not found by search", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-reference-search", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ReferenceSearchLabeled", "declaration": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-reference-search-labeled", "declaration": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-reference-search.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-reference-search is a search input field with the capability to open and extended search component.\n\nBound data must fullfill the furo.Reference signature. The service, deeplink,... is taken from the spec of your field.\nDo not forget to specify.\n\n *default usage*\n```html\n \n```\n\n *usage with an extended searcher*\n```html\n \n```\n\n *usage example for a non default response*\n```html\n \n```\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **max:\"number\"** set the maximum number of characters available in the input field.\n\nThe constraint **required** will mark the element as required\n\nIf your type has a *reference* type signature ('id','display_name', 'link'), the service, and initial deep link is extracted from\nthe link part of your type.\n\nIf you bind a scalar field, the value which is set in 'valueFieldPath' will be set.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)\n\n## Specs\nDefine a proper default value on the reference type.\n\n```yaml\nlink:\ntype: furo.Link\ndescription: HTS for the initial search (the default works on root resources only)\n__proto:\n number: 3\n__ui: null\nmeta:\n default: |\n {\n \"rel\": \"list\",\n \"href\": \"/contacts\",\n \"method\": \"GET\",\n \"type\": \"contact.Contact\",\n \"service\": \"contact.Contacts\"\n }\n placeholder: \"\"\n hint: \"\"\n label: contact.Reference.link.label\n options:\n flags: []\n list: []\n readonly: false\n repeated: false\n typespecific: null\n\n```\n### API of an extended searcher\n### Searcher Methods\nThe only method you have to implement is **htsIn**. The reference-search will pass its own hts to the extended\nsearcher. A call on qpIn on the searcher will also pass the resulting hts to the extended searcher.\n\n### Extended Searcher Events\nFire a **record-selected** to set the item on the reference-search.\nFire a **escape-filter-panel** to close the extended search.", "name": "FuroUi5ReferenceSearch", "cssProperties": [ { "type": { "text": "#ffffff" }, "description": "background color of the result list", "name": "--furo-ui5-reference-search-list-background", "default": "--surface" } ], "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "This is triggered from the FieldNodeAdapter when the data has changed", "privacy": "private" }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: can be a scalar type or any complex type with 'id','display_name' signature or use\nthe furo.Reference type." }, { "kind": "method", "name": "_updateField", "description": "This is used to update the FieldNodeAdapter", "privacy": "private" }, { "kind": "field", "name": "service", "privacy": "public", "type": { "text": "string" }, "description": "setter for the service", "parameters": [ { "name": "service" } ], "default": "''", "attribute": "service" }, { "kind": "method", "name": "_appendExtendedSearcher", "description": "Appends the searcher", "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "privacy": "private" }, { "kind": "method", "name": "focus", "description": "focuses the input field" }, { "kind": "method", "name": "triggerSearch", "parameters": [ { "name": "term" } ], "description": "triggerSearch search for a term", "privacy": "public" }, { "kind": "method", "name": "_closeList", "description": "Closes the list", "privacy": "private" }, { "kind": "method", "name": "_showList", "description": "Opens the list and selects the last selected item", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "Update the placeholder from the FNA", "privacy": "private" }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "label" } ], "description": "Update the label from the FNA", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "Updates the readonly state from FNA", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "Updates the required constraint from the FNA", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "Updates the error state from FNA", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "Clears the error state from FNA", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updater for the value state and message", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "reset to previous value state\ntodo: check that this will not toggle between information and error", "privacy": "private" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\n\nFollowing attributes can be set:\n- `value-state`\n- `value-state-message`\n- `icon`\n- `placeholder`\n- `label`\n- `required`\n- `readonly`\n- `disabled`\n\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "htsIn", "parameters": [ { "name": "hts" } ], "description": "htsIn sets the HTS for the collection-agent.\n\nThis is only needed if you want to have fine grained control over the hts", "privacy": "public" }, { "kind": "method", "name": "qpIn", "parameters": [ { "name": "qp" } ], "description": "qpIn Use this to set query params manualy", "privacy": "public" }, { "kind": "method", "name": "setFilter", "parameters": [ { "name": "filter" } ], "description": "Sets the filter.\nHint: use the FieldNode._base64 property to send complex objects as a filter and decode it on the server side\nor do btoa(JSON.stringify(FILTER))" }, { "kind": "method", "name": "clearResultList", "description": "clears the result set" }, { "kind": "field", "name": "searchResponsePath", "privacy": "public", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "attribute": "search-response-path" }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "attribute": "value-field-path" }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "attribute": "display-field-path" }, { "kind": "field", "name": "extendedValueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the extended search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "attribute": "extended-value-field-path" }, { "kind": "field", "name": "extendedDisplayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "attribute": "extended-display-field-path" }, { "kind": "field", "name": "maxItemsToDisplay", "privacy": "public", "type": { "text": "number" }, "description": "The maximal number of items to display.\n\nThis value will be set as page-size query-param for the backend.\n\nIf the response contains hts information with rel *next* a \"load more\" button will be displayed at the end\nof the list.", "default": "8", "attribute": "max-items-to-display" }, { "kind": "field", "name": "value", "type": { "text": "object" }, "default": "{ id: '', display_name: '' }" }, { "kind": "field", "name": "minTermLength", "privacy": "public", "type": { "text": "number" }, "description": "The minimal length of search term to trigger a search.", "default": "2", "attribute": "min-term-length" }, { "kind": "field", "name": "debounceTimeout", "privacy": "public", "type": { "text": "number" }, "description": "wait for this time between keystrokes to trigger a search to the service", "default": "250", "attribute": "debounce-timeout" }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Overrides the hint text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "attribute": "placeholder" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "Overrides the label text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "attribute": "label" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "string" }, "description": "hint text when result not found by search", "default": "'no result found'", "attribute": "no-data-text" }, { "kind": "field", "name": "_hasmore", "type": { "text": "string" }, "privacy": "private", "default": "'None'" }, { "kind": "field", "name": "_hasExtendedSearcher", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "disableSearchList", "privacy": "public", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "attribute": "disable-search-list" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "attribute": "icon" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "valueState", "privacy": "public", "type": { "text": "string" }, "description": "Value State of the input field", "default": "'None'", "attribute": "value-state" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n label: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n label: null,\n required: null,\n disabled: null,\n icon: null,\n }" }, { "kind": "field", "name": "method", "privacy": "public", "type": { "text": "String" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "attribute": "method" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "Overrides the required value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "searchOnEnterOnly", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enable this, to avoid the automatic triggering of \"search\".\n\nThe user have to press enter to trigger the search. Min-term-length is respected.", "attribute": "search-on-enter-only" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "Overrides the readonly value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "attribute": "readonly" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "Disable", "attribute": "disabled" }, { "kind": "field", "name": "busy", "privacy": "public", "type": { "text": "Boolean" }, "description": "This is used to activate the loading indicator.", "attribute": "busy" }, { "kind": "field", "name": "extendedSearcher", "privacy": "public", "type": { "text": "String" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "attribute": "extended-searcher" } ], "events": [ { "type": { "text": "`Object` the complete item" }, "description": " Fired when a item was selected from the list.", "name": "item-selected" }, { "type": { "text": "`text`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input" } ], "attributes": [ { "name": "search-response-path", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "fieldName": "searchResponsePath" }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "fieldName": "valueFieldPath" }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "fieldName": "displayFieldPath" }, { "name": "extended-value-field-path", "type": { "text": "string" }, "description": "Path to response value item of the extended search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "fieldName": "extendedValueFieldPath" }, { "name": "extended-display-field-path", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "fieldName": "extendedDisplayFieldPath" }, { "name": "service", "type": { "text": "string" }, "description": "setter for the service", "parameters": [ { "name": "service" } ], "default": "''", "fieldName": "service" }, { "name": "method", "type": { "text": "String" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "fieldName": "method" }, { "name": "icon", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "fieldName": "icon" }, { "name": "disable-search-list", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "fieldName": "disableSearchList" }, { "name": "no-data-text", "type": { "text": "string" }, "description": "hint text when result not found by search", "default": "'no result found'", "fieldName": "noDataText" }, { "name": "required", "type": { "text": "Boolean" }, "description": "Overrides the required value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "fieldName": "required" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Overrides the hint text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "fieldName": "placeholder" }, { "name": "label", "type": { "text": "string" }, "description": "Overrides the label text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "fieldName": "label" }, { "name": "min-term-length", "type": { "text": "number" }, "description": "The minimal length of search term to trigger a search.", "default": "2", "fieldName": "minTermLength" }, { "name": "max-items-to-display", "type": { "text": "number" }, "description": "The maximal number of items to display.\n\nThis value will be set as page-size query-param for the backend.\n\nIf the response contains hts information with rel *next* a \"load more\" button will be displayed at the end\nof the list.", "default": "8", "fieldName": "maxItemsToDisplay" }, { "name": "search-on-enter-only", "type": { "text": "Boolean" }, "description": "Enable this, to avoid the automatic triggering of \"search\".\n\nThe user have to press enter to trigger the search. Min-term-length is respected.", "fieldName": "searchOnEnterOnly" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "Overrides the readonly value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "fieldName": "readonly" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "Disable", "fieldName": "disabled" }, { "name": "busy", "type": { "text": "Boolean" }, "description": "This is used to activate the loading indicator.", "fieldName": "busy" }, { "name": "value-state", "type": { "text": "string" }, "description": "Value State of the input field", "default": "'None'", "fieldName": "valueState" }, { "name": "debounce-timeout", "type": { "text": "number" }, "description": "wait for this time between keystrokes to trigger a search to the service", "default": "250", "fieldName": "debounceTimeout" }, { "name": "extended-searcher", "type": { "text": "String" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "fieldName": "extendedSearcher" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" }, { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-reference-search", "summary": "furo ui5 data reference search", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ReferenceSearch", "declaration": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-reference-search", "declaration": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-relative-time-badge.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-relative-time-badge`\nThe furo-ui5-relative-time-badge is a small non-interactive component which contains relative time\ninformation (i.e. in 2 days, 5 days ago) and color chosen from a list of predefined color schemes.\nIt serves the purpose to attract the user attention to some piece of information.\n\nYou can bind a `string`, `google.protobuf.Timestamp`, `int32`, `int64`, `furo.type.Date` or `google.type.Date`.\n`int32`, `int64` will be handled as unix timestamps (seconds since epoc) and can not be *empty*.\n\n```html\n \n \n```", "name": "FuroUi5RelativeTimeBadge", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Binds a fieldNode to the component\nOverridden bindData of FieldNodeAdapter\n\nSupported types:\n- string (ISO 8061)\n- int32, int64 (unix timestamps (seconds since epoc))\n- google.protobuf.Timestamp\n- google.type.Date\n- furo.type.Date" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "description": "Overridden onFnaFieldValueChanged of FieldNodeAdapter", "privacy": "private" }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "endTime" } ], "description": "Internal relative time format function\nuse of Intl.RelativeTimeFormat", "privacy": "private" }, { "kind": "field", "name": "_colorScheme", "type": { "text": "string" }, "description": "internal value", "privacy": "private", "default": "'1'" }, { "kind": "field", "name": "_dueTime", "type": { "text": "string" }, "description": "internal display value", "privacy": "private", "default": "''" }, { "kind": "field", "name": "_timestampFormatted", "type": { "text": "string" }, "description": "internal title value", "privacy": "private", "default": "''" }, { "kind": "field", "name": "colorSchemePositive", "privacy": "public", "type": { "text": "string" }, "description": "default values", "default": "'1'", "attribute": "color-scheme-positive", "reflects": true }, { "kind": "field", "name": "colorSchemeNegative", "privacy": "public", "type": { "text": "string" }, "description": "Defines the color scheme of the component if the value is NEGATIVE. There are 10 predefined schemes.\nEach scheme applies different values for the background-color and border-color. To use one you can set a\nnumber from \"1\" to \"10\". The colorScheme \"1\" will be set by default.\n\nNote: Color schemes have no visual representation in High Contrast Black (sap_belize_hcb) theme.", "default": "'2'", "attribute": "color-scheme-negative", "reflects": true }, { "kind": "field", "name": "optionStyle", "privacy": "public", "type": { "text": "string" }, "description": "Defines the output style\nlong, short, narrow\nDefault: long", "default": "'long'", "attribute": "option-style" }, { "kind": "field", "name": "optionNumeric", "privacy": "public", "type": { "text": "string" }, "description": "Defines the output format\nalways, auto\nDefault: auto", "default": "'auto'", "attribute": "option-numeric" } ], "attributes": [ { "name": "color-scheme-positive", "type": { "text": "string" }, "description": "default values", "default": "'1'", "fieldName": "colorSchemePositive" }, { "name": "color-scheme-negative", "type": { "text": "string" }, "description": "Defines the color scheme of the component if the value is NEGATIVE. There are 10 predefined schemes.\nEach scheme applies different values for the background-color and border-color. To use one you can set a\nnumber from \"1\" to \"10\". The colorScheme \"1\" will be set by default.\n\nNote: Color schemes have no visual representation in High Contrast Black (sap_belize_hcb) theme.", "default": "'2'", "fieldName": "colorSchemeNegative" }, { "name": "option-style", "type": { "text": "string" }, "description": "Defines the output style\nlong, short, narrow\nDefault: long", "default": "'long'", "fieldName": "optionStyle" }, { "name": "option-numeric", "type": { "text": "string" }, "description": "Defines the output format\nalways, auto\nDefault: auto", "default": "'auto'", "fieldName": "optionNumeric" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "bindable relative time badge", "tagName": "furo-ui5-relative-time-badge", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5RelativeTimeBadge", "declaration": { "name": "FuroUi5RelativeTimeBadge", "module": "src/furo-ui5-relative-time-badge.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-relative-time-badge", "declaration": { "name": "FuroUi5RelativeTimeBadge", "module": "src/furo-ui5-relative-time-badge.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-section.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-section`\nThe object page content according to the SAP Design System Fiori guidelines consists of sections and subsections\narranged in a column layout.\nThe furo-ui5-section is basically a layout manager component to structure object pages. Sections can only\ncontain subsections, not content.\n\n```html\n \n \n \n \n```\n\n```html\n\n \n \n\n```\n\n## Methods\n**bindData(fieldNode)**\nBinds an entity field to the heading. You can use the entity even when no data was received.", "name": "FuroUi5Section", "slots": [ { "type": { "text": "FuroUi5SubSection [0..n]" }, "description": "defines the content of the section.", "name": "default" } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "Furo flow is ready lifecycle method" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "Overridden onFnaFieldValueChanged", "privacy": "private" }, { "kind": "field", "name": "heading", "privacy": "public", "type": { "text": "string" }, "description": "Heading title of the section", "default": "''", "attribute": "heading" }, { "kind": "field", "name": "noborder", "privacy": "public", "type": { "text": "Boolean" }, "description": "Setting this attribute will hide the bottom border", "attribute": "noborder" } ], "attributes": [ { "name": "heading", "type": { "text": "string" }, "description": "Heading title of the section", "default": "''", "fieldName": "heading" }, { "name": "noborder", "type": { "text": "Boolean" }, "description": "Setting this attribute will hide the bottom border", "fieldName": "noborder" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" }, { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-section", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Section", "declaration": { "name": "FuroUi5Section", "module": "src/furo-ui5-section.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-section", "declaration": { "name": "FuroUi5Section", "module": "src/furo-ui5-section.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-segmented-button.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-segmented-button component represents a drop-down list. The items inside define the available\noptions by using the furo-ui5-segmented-button component.\n\n```html\n\n\n```", "name": "FuroUi5SegmentedButton", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Binds a FieldNode to the component.\n\nSupported types:", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode", "description": "The list with the options", "type": { "text": "RepeaterNode" } } ], "description": "Bind a `RepeaterNode` that will be used to build up the option list.\n\nUse `idFieldPath` and `displayFieldPath` if your structrure does not match the following signature:\n\n```json\n[\n { \"id\": 1, \"display_name\": \"option A\"},\n { \"id\": 2, \"display_name\": \"option B\"}\n]\n```" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `readonly`,`disabled`, `value-field-path`, `display-field-path`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Overwrite onFnaOptionsChanged\nNotifies when the options for the field is changed or set.", "privacy": "private" }, { "kind": "method", "name": "selectOptionById", "parameters": [ { "name": "val", "description": "The id", "type": { "text": "Id" } } ], "description": "Selects an option by id" }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private" }, { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "e" } ], "description": "Handler function for the select value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateOptions", "parameters": [ { "name": "list" } ], "description": "Maps and updates array of option", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_tagItemComponent", "type": { "text": "string" }, "description": "Inner component tag", "privacy": "private", "default": "'ui5-segmented-button-item'" }, { "kind": "field", "name": "activeFieldBinding", "type": { "text": "boolean" }, "description": "Flag to indicate if a field is attached\nDefault: false", "default": "false" }, { "kind": "field", "name": "idFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (`bindOptions()`) to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid\ndefault: id", "default": "'id'" }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (`bindOptions()`) to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name", "default": "'display_name'" }, { "kind": "field", "name": "valueFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.\ndefault: id", "default": "'id'" }, { "kind": "field", "name": "_optionList", "type": { "text": "*[]" }, "description": "Internal RepeaterNode\nDefines the ui5-select options.\nNote: Only one selected option is allowed. If more than one option is defined as selected, the last one would be considered as the selected one.", "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in furo-ui5-select components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n 'id-field-path': 'id',\n 'value-field-path': 'id',\n 'display-field-path': 'display_name',\n }" } ], "events": [ { "name": "options-updated", "type": { "text": "optionNodeList" }, "description": "Fired after the option list was rebuilt" }, { "type": { "text": "{*} the value from the value-field. By default the value field is \"id\"" }, "description": " Fired when value has changed from the component inside. **bubbles**", "name": "furo-value-changed" }, { "type": { "text": "selectedOption" }, "description": "Fired when the toggle button was clicked. Payload: - if no option binding is active: ui5-segmented-button-item - if a RepeaterNode is bound: FieldNode", "name": "item-selected" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/SegmentedButtonItem.js" }, "tagName": "furo-ui5-segmented-button", "summary": "segmented button", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SegmentedButton", "declaration": { "name": "FuroUi5SegmentedButton", "module": "src/furo-ui5-segmented-button.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-select-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-select-labeled`\nThe furo-ui5-select-labeled is a composition to easily use a complete data select with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5SelectLabeled", "slots": [ { "type": { "text": "HTMLElement" }, "description": "defines the value state message that will be displayed as pop up under the input element.", "name": "valueStateMessage" } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "setOptions", "parameters": [ { "name": "arr" }, { "description": "raw data array with a id, display_name signature", "name": "rawJson", "optional": true } ], "description": "inject raw data as options", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-select component" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "idFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid", "default": "'id'", "attribute": "id-field-path" }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.", "default": "'id'", "attribute": "value-field-path" }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "id-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid", "default": "'id'", "fieldName": "idFieldPath" }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath" }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.", "default": "'id'", "fieldName": "valueFieldPath" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-select-labeled", "summary": "labeled select", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SelectLabeled", "declaration": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-select-labeled", "declaration": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-select.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-select component is used to create a drop-down list. The items inside the furo-ui5-select define\nthe available options by using the ui5-option component. Use the function bindOptions to bind a RepeaterNode as a option list.\n\n```html\n\n\n```", "name": "FuroUi5Select", "members": [ { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `required`,`readonly`,`disabled`, `value-field-path`, `display-field-path`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list." }, { "kind": "method", "name": "setOptions", "parameters": [ { "name": "arr" }, { "description": "raw data array", "name": "rawJson", "optional": true } ], "description": "inject raw data as options", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Overridden bindData of FieldNodeAdapter", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "Overridden onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "Overridden onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Overridden onFnaOptionsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "Overridden onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "Overridden onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "Overridden onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "selectOptionById", "parameters": [ { "name": "id", "description": "must match the data", "type": { "text": "*" } } ], "description": "Selects an option by id.\nThe id field must be comparable." }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "_updateOptions", "parameters": [ { "name": "list" } ], "description": "Maps and updates array of option", "privacy": "private" }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private" }, { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "e" } ], "description": "Handler function for the select value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "activeFieldBinding", "type": { "text": "boolean" }, "description": "Flag to indicate if a field is attached\nDefault: false", "default": "false" }, { "kind": "field", "name": "idFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid\ndefault: id\nThis attribute is related to the option list", "default": "'id'" }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'" }, { "kind": "field", "name": "valueFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.\ndefault: id\nThis attribute is related to the option list. optionList[selected].valueFieldPath ==> bound FieldNode", "default": "'id'" }, { "kind": "field", "name": "boundFieldIdPath", "type": { "text": "string" }, "description": "Defines the id field path of the bound FieldNode.\nPoint-separated path to the field\nMust be set if a data binding is specified with a complex type.\ndefault: id\nThis attribute is related to the bound FieldNode.", "default": "'id'" }, { "kind": "field", "name": "_optionList", "type": { "text": "*[]" }, "description": "Internal RepeaterNode\nDefines the ui5-select options.\nNote: Only one selected option is allowed. If more than one option is defined as selected, the last one would be considered as the selected one.", "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in furo-ui5-select components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n 'id-field-path': 'id',\n 'value-field-path': 'id',\n 'display-field-path': 'display_name',\n 'bound-field-id-path': 'id',\n }" } ], "events": [ { "name": "options-updated", "type": { "text": "optionNodeList" }, "description": "Fired after the option list was rebuilt." }, { "type": { "text": "selectedOption" }, "description": "Fired when the item of the dropdown list is selected.", "name": "item-selected" }, { "type": { "text": "selectedOption" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/Option.js" }, "tagName": "furo-ui5-select", "summary": "data select field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Select", "declaration": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-show-hide.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-show-hide`\nAnimated content hider", "name": "FuroUi5ShowHide", "members": [ { "kind": "method", "name": "_checkInversedState", "parameters": [ { "name": "bool" } ], "description": "inverses the bool based on hideOnFalse", "return": { "type": { "text": "boolean|*" } }, "privacy": "private" }, { "kind": "method", "name": "hide", "description": "Hides the content.", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "show", "description": "Shows the content.", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toggle", "description": "Toggle the current visibility state..", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "isHidden", "description": "Set is-hiddden to start in a closed state. The name is used by intention, to avoid css trouble with\na global [hidden]{display:none}.", "type": { "text": "boolean" }, "privacy": "public" }, { "kind": "method", "name": "_notify", "parameters": [ { "name": "eventname" }, { "name": "state" } ], "privacy": "private" }, { "kind": "field", "name": "hideOnFalse", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "_clientHeight", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "_hidden", "type": { "text": "boolean" }, "default": "false" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Animated content hider", "tagName": "furo-ui5-show-hide", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "furo-ui5-show-hide", "declaration": { "name": "FuroUi5ShowHide", "module": "src/furo-ui5-show-hide.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-sign-pad.js", "declarations": [ { "kind": "class", "description": "`furo-sign-pad`\n Simple pad to sign or draw something", "name": "FuroUi5SignPad", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "resize", "description": "Trigger this method after a resize." }, { "kind": "method", "name": "disable", "description": "Disables the pad" }, { "kind": "method", "name": "enable", "description": "Enables the pad" }, { "kind": "method", "name": "_setEmpty", "parameters": [ { "name": "b" } ], "privacy": "private" }, { "kind": "method", "name": "clear", "description": "Clears the image. This also updates the bound field." }, { "kind": "method", "name": "putImage", "parameters": [ { "name": "encodedImage", "type": { "text": "imageURL" } } ], "description": "Adds the encoded image to the canvas.\n\nMaybe you want to clear first." }, { "kind": "method", "name": "encodeImage", "description": "Encodes the image using the type and encodingOptions (quality) defined.\nThe encoded image is available in the `image` property." }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "entityField" } ], "description": "bind a entity field" }, { "kind": "method", "name": "_debounce", "parameters": [ { "name": "func" }, { "name": "timeout", "default": "333" } ], "privacy": "private", "return": { "type": { "text": "(function(...[*]): void)|*" } } }, { "kind": "field", "name": "_field", "type": { "text": "object" }, "privacy": "private", "default": "{}" } ], "events": [ { "type": { "text": "Base64" }, "description": "Fired when sign gets new painting, with base encoded image.", "name": "sign-updated" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-sign-pad", "summary": "draw or sign", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SignPad", "declaration": { "name": "FuroUi5SignPad", "module": "src/furo-ui5-sign-pad.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-sign-pad", "declaration": { "name": "FuroUi5SignPad", "module": "src/furo-ui5-sign-pad.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-step-input-labeled.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-step-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n\n```", "name": "FuroUi5StepInputLabeled", "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc." }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-step-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "icon on the right", "default": "''", "attribute": "icon" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" }, { "kind": "field", "name": "step", "privacy": "public", "type": { "text": "Number" }, "description": "Step size", "attribute": "step" }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "Number" }, "description": "Minimal value", "attribute": "min" }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "Number" }, "description": "Maximal value", "attribute": "max" } ], "events": [ { "type": { "text": "Step" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-step-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "icon", "type": { "text": "string" }, "description": "icon on the right", "default": "''", "fieldName": "icon" }, { "name": "step", "type": { "text": "Number" }, "description": "Step size", "fieldName": "step" }, { "name": "min", "type": { "text": "Number" }, "description": "Minimal value", "fieldName": "min" }, { "name": "max", "type": { "text": "Number" }, "description": "Maximal value", "fieldName": "max" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-step-input-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5StepInputLabeled", "declaration": { "name": "FuroUi5StepInputLabeled", "module": "src/furo-ui5-step-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-step-input-labeled", "declaration": { "name": "FuroUi5StepInputLabeled", "module": "src/furo-ui5-step-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-step-input.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-step-input component allows the user to enter and edit numbers with data binding. It consists of an\ninput field and buttons with icons to increase/decrease the value with the predefined step.\nIt supports all features from the [SAP ui5 Input element](https://sap.github.io/ui5-webcomponents/playground/components/StepInput/).\n\nYou can bind any `number` type, any `furo.fat.xxx` number type, `furo.BigDecimal` or the `google.wrapper.xxx` number types.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta | fat | html |\n|------ |----- |------ |\n| 1 | 10 | 100 |\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"required\":\"true\"** set the element to required\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"placeholder\":\"string\"** set the placeholder for the element\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind an entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5StepInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "__previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n }" } ], "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input" }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents-icons/dist/alert.js" }, "tagName": "furo-ui5-step-input", "summary": "data step input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5StepInput", "declaration": { "name": "FuroUi5StepInput", "module": "src/furo-ui5-step-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-subsection.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-subsection`\nThe furo-ui5-subsection component is a containers for actual content. It is envisaged that this component will be\nused within a furo-ui5-section\nSubsections have a progressive disclosure mechanism to show and hide content\n\nhttps://experience.sap.com/fiori-design-web/object-page/#content-area\n\n```html\n \n \n ...\n \n \n \n \n```\n## Methods\n**bindData(fieldNode)**\nBinds an entity field to the heading. You can use the entity even when no data was received.", "name": "FuroUi5Subsection", "slots": [ { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the content of the subsection.", "name": "default" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the content right after the header.", "name": "headline-start" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the content before the action slot.", "name": "headline-end" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the heading bar of the subsection.", "name": "action" }, { "type": { "text": "HTMLElement [0..n]" }, "description": "defines the additional content in the `show more` section.", "name": "more" } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "Furo flow is ready lifecycle method" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "Overridden onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "toggleCollapse", "description": "toggles the collapse state" }, { "kind": "field", "name": "heading", "privacy": "public", "type": { "text": "string" }, "description": "Heading title of the section", "default": "''", "attribute": "heading" }, { "kind": "field", "name": "showMoreDataText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the text that will be displayed for `show more`", "default": "'Show More'", "attribute": "show-more-data-text" }, { "kind": "field", "name": "showLessDataText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the text that will be displayed for `show less`", "default": "'Show Less'", "attribute": "show-less-data-text" }, { "kind": "field", "name": "collapsed", "privacy": "public", "type": { "text": "boolean" }, "description": "Collapsed state of the `read more` section", "default": "false", "attribute": "collapsed", "reflects": true }, { "kind": "field", "name": "hasMoreContent", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "level", "privacy": "public", "type": { "text": "string" }, "description": "Defines the heading level. Available options are: \"H6\" to \"H1\".", "default": "'H4'", "attribute": "level" } ], "attributes": [ { "name": "heading", "type": { "text": "string" }, "description": "Heading title of the section", "default": "''", "fieldName": "heading" }, { "name": "collapsed", "type": { "text": "boolean" }, "description": "Collapsed state of the `read more` section", "default": "false", "fieldName": "collapsed" }, { "name": "show-more-data-text", "type": { "text": "string" }, "description": "Defines the text that will be displayed for `show more`", "default": "'Show More'", "fieldName": "showMoreDataText" }, { "name": "show-less-data-text", "type": { "text": "string" }, "description": "Defines the text that will be displayed for `show less`", "default": "'Show Less'", "fieldName": "showLessDataText" }, { "name": "level", "type": { "text": "string" }, "description": "Defines the heading level. Available options are: \"H6\" to \"H1\".", "default": "'H4'", "fieldName": "level" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" }, { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-subsection", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Subsection", "declaration": { "name": "FuroUi5Subsection", "module": "src/furo-ui5-subsection.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-subsection", "declaration": { "name": "FuroUi5Subsection", "module": "src/furo-ui5-subsection.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-table.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-table` display entities in a ui5-table\n\n```html\n\n \n \n\n Custom Title\n\n\n```\n\n## Attributes which are taken from `ui5-table-column`\n\n**field**\nDefine the field you want to bind. `*` is the root of the repeated field.\n\n**context**\nSet a context for the type renderer. The default value is `cell`.\n\n**renderer**\nSet a specific renderer component for the column. If not set, the renderer is evaluated from the type of the bound field.", "name": "FuroUi5Table", "members": [ { "kind": "method", "name": "_FBPReady", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "data" } ], "description": "Bind a repeated data node." }, { "kind": "method", "name": "focus", "description": "Focuses the header of the table" }, { "kind": "method", "name": "focusLast", "description": "Focuses the last row." }, { "kind": "method", "name": "focusFirst", "description": "Focuses the first row." }, { "kind": "method", "name": "_init", "description": "init data table", "privacy": "private" }, { "kind": "method", "name": "_initRepeatTemplate", "parameters": [ { "name": "fieldPaths" } ] }, { "kind": "method", "name": "_cellMap", "parameters": [ { "name": "fieldPaths" }, { "name": "fields" } ], "description": "ui5 data table cell template", "privacy": "private", "return": { "type": { "text": "TemplateResult|TemplateResult" } } }, { "kind": "method", "name": "_getSpecFieldFromPath", "parameters": [ { "name": "field" }, { "name": "path" } ], "description": "resolves a field specification with the given path", "return": { "type": { "text": "*" } }, "privacy": "private" }, { "kind": "method", "name": "setBusy", "description": "setBusy Sets the busy state", "privacy": "public" }, { "kind": "method", "name": "unsetBusy", "description": "unsetBusy Unsets the busy state", "privacy": "public" }, { "kind": "field", "name": "cols", "type": { "text": "array" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_specs", "privacy": "private" }, { "kind": "field", "name": "data", "type": { "text": "array" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "mode", "privacy": "public", "type": { "text": "string" }, "description": "Defines the mode of the component.\n\nAvailable options are:\n- MultiSelect\n- SingleSelect\n- None", "default": "'None'", "attribute": "mode" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Defines the text that will be displayed when there is no data.\nstring", "attribute": "no-data-text" }, { "kind": "field", "name": "identityPath", "privacy": "public", "type": { "text": "*" }, "description": "string}", "attribute": "identity-path" }, { "kind": "field", "name": "stickyColumnHeader", "privacy": "public", "type": { "text": "Boolean" }, "description": "Determines whether the column headers remain fixed at the top of the page during vertical scrolling as long as the Web Component is in the viewport.", "attribute": "sticky-column-header" }, { "kind": "field", "name": "busy", "privacy": "public", "type": { "text": "Boolean" }, "description": "Busy state", "attribute": "busy" } ], "events": [ { "name": "data-loaded", "type": { "text": "HTMLElement" }, "description": "Fired when the data is loaded into data table. The event detail contains the data table self." }, { "type": { "text": "entity" }, "description": "Fired when the ArrowDown is pressed on the last row. The event detail is the original entity of the row", "name": "arrow-down-on-last-row" }, { "type": { "text": "entity" }, "description": "Fired when the row is selected. The event detail is the original entity of the row.", "name": "tablerow-selected" }, { "type": { "text": "entity" }, "description": "Fired when the ArrowUp is pressed on the first row. The event detail is the original entity of the row", "name": "arrow-up-on-first-row" }, { "type": { "text": "Array with the selected items" }, "description": "Fired when the row selection in MultiSelect mode was changed", "name": "rows-selected" } ], "attributes": [ { "name": "mode", "type": { "text": "string" }, "description": "Defines the mode of the component.\n\nAvailable options are:\n- MultiSelect\n- SingleSelect\n- None", "default": "'None'", "fieldName": "mode" }, { "name": "no-data-text", "type": { "text": "String" }, "description": "Defines the text that will be displayed when there is no data.\nstring", "fieldName": "noDataText" }, { "name": "identity-path", "type": { "text": "*" }, "description": "string}", "fieldName": "identityPath" }, { "name": "sticky-column-header", "type": { "text": "Boolean" }, "description": "Determines whether the column headers remain fixed at the top of the page during vertical scrolling as long as the Web Component is in the viewport.", "fieldName": "stickyColumnHeader" }, { "name": "busy", "type": { "text": "Boolean" }, "description": "Busy state", "fieldName": "busy" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-table", "summary": "Display repeated fields in a table", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Table", "declaration": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-table", "declaration": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-text-input-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-text-input-labeled`\nThe furo-ui5-text-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5TextInputLabeled", "slots": [ { "type": { "text": "HTMLElement" }, "description": "defines the icon to be displayed in the input element.", "name": "icon" }, { "type": { "text": "HTMLElement" }, "description": "Defines the icon to be displayed in the input.", "name": "icon" } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-combobox component" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "descFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "attribute": "desc-field-path" }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath" }, { "name": "desc-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "fieldName": "descFieldPath" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-text-input-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TextInputLabeled", "declaration": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-text-input-labeled", "declaration": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-text-input.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-text-input' component allows the user to enter and edit texts with data binding.\n\nIt supports all features from the [SAP ui5 Input element](https://sap.github.io/ui5-webcomponents/playground/components/Input/).\n\nYou can bind any `string` type, like `furo.fat.String` type or the `google.protobuf.StringValue` type.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n** meta < fat < html **\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"required\":\"true\"** set the element to required\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"icon\":\"home\"** set the icon\n - **\"placeholder\":\"string\"** set the placeholder for the element\n - **\"max\":\"number\"** set the maximum number of characters available in the input field.\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **max:\"number\"** set the maximum number of characters available in the input field.\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bindData(fieldNode)**\nBind an entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5TextInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private" }, { "kind": "method", "name": "_mapOptionsToSuggestions", "parameters": [ { "name": "repeaterNode" } ], "description": "Maps a RepeaterNode according the mapping definition to an ui5-suggestion-item.\nSupported fields are:\n- text\n- description", "return": { "type": { "text": "*[]" } }, "privacy": "private" }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private" }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list.\nThe items are displayed as suggestion items." }, { "kind": "method", "name": "_createHandler", "parameters": [ { "name": "wait" }, { "name": "immediate" } ], "description": "Internal create of debounce handler function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'Text'" }, { "kind": "field", "name": "_optionList", "type": { "text": "{}" }, "description": "Internal pointer to the options RepeaterNode", "privacy": "private", "default": "{}" }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the text of the\noption items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'" }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'" }, { "kind": "field", "name": "wait", "type": { "text": "number" }, "description": "Debounce time in milliseconds\nDefault value: 250", "default": "250" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n icon: undefined, // updates the icon\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n maxlength: null,\n wait: 250,\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n }" }, { "kind": "field", "name": "_debounce", "description": "Debounce function, taken from Underscore.js", "parameters": [ { "name": "func" }, { "name": "wait" }, { "name": "immediate" } ], "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "default": "function debounce(func, wait, immediate) {\n let timeout;\n return function debouncer() {\n const context = this;\n // eslint-disable-next-line prefer-rest-params\n const args = arguments;\n const later = function applyLater() {\n timeout = null;\n if (!immediate) func.apply(context, args);\n };\n const callNow = immediate && !timeout;\n clearTimeout(timeout);\n timeout = setTimeout(later, wait);\n if (callNow) func.apply(context, args);\n };\n }" } ], "events": [ { "name": "search-requested", "type": { "text": "value" }, "description": "Fired when typing in input (debounced, default 250ms)" }, { "type": { "text": "String" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "type": { "text": "String" }, "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input" }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/features/InputSuggestions.js" }, "tagName": "furo-ui5-text-input", "summary": "data text input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TextInput", "declaration": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-textarea-input-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-textarea-input-labeled`\nThe furo-ui5-textarea-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5TextareaInputLabeled", "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-textarea-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "rows", "privacy": "public", "type": { "text": "number" }, "description": "Defines the number of visible text lines for the component.", "default": "0", "attribute": "rows" }, { "kind": "field", "name": "growingMaxLines", "privacy": "public", "type": { "text": "number" }, "description": "Defines the maximum number of lines that the Web Component can grow.", "default": "0", "attribute": "growing-max-lines" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" }, { "kind": "field", "name": "showExceededText", "privacy": "public", "type": { "text": "Boolean" }, "description": "Determines whether the characters exceeding the maximum allowed character count are visible in the furo-ui5-textarea-input.\n\nIf set to false, the user is not allowed to enter more characters than what is set in the maxlength property.\nIf set to true the characters exceeding the maxlength value are selected on paste and the counter below\nthe furo-ui5-textarea-input displays their number.", "attribute": "show-exceeded-text" }, { "kind": "field", "name": "growing", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enables the furo-ui5-textarea to automatically grow and shrink dynamically with its content.", "attribute": "growing" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-textarea-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" }, { "name": "show-exceeded-text", "type": { "text": "Boolean" }, "description": "Determines whether the characters exceeding the maximum allowed character count are visible in the furo-ui5-textarea-input.\n\nIf set to false, the user is not allowed to enter more characters than what is set in the maxlength property.\nIf set to true the characters exceeding the maxlength value are selected on paste and the counter below\nthe furo-ui5-textarea-input displays their number.", "fieldName": "showExceededText" }, { "name": "rows", "type": { "text": "number" }, "description": "Defines the number of visible text lines for the component.", "default": "0", "fieldName": "rows" }, { "name": "growing-max-lines", "type": { "text": "number" }, "description": "Defines the maximum number of lines that the Web Component can grow.", "default": "0", "fieldName": "growingMaxLines" }, { "name": "growing", "type": { "text": "Boolean" }, "description": "Enables the furo-ui5-textarea to automatically grow and shrink dynamically with its content.", "fieldName": "growing" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-textarea-input-labeled", "summary": "labeled textarea field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TextareaInputLabeled", "declaration": { "name": "FuroUi5TextareaInputLabeled", "module": "src/furo-ui5-textarea-input-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-textarea-input-labeled", "declaration": { "name": "FuroUi5TextareaInputLabeled", "module": "src/furo-ui5-textarea-input-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-textarea-input.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-textarea-input' component allows the user to enter and edit texts with data binding.\n\nIt supports all features from the [SAP ui5 Input element](https://sap.github.io/ui5-webcomponents/playground/components/Input/).\n\nYou can bind any `string` type, like `furo.fat.String` type or the `google.protobuf.StringValue` type.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n** meta \t< fat \t< html \t**\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"required\":\"true\"** set the element to required\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"placeholder\":\"string\"** set the placeholder for the element\n - **\"rows\":\"number\"** set the number of rows.\n - **\"growing\":\"true\"** Enables the ui5-textarea to automatically grow and shrink dynamically with its content.\n - **\"show-exceeded-text\":\"true\"** if set to true. the characters exceeding the maxlength value are selected on paste and the counter below the ui5-textarea displays their number. If set to false, the user is not allowed to enter more characters than what is set in the maxlength property.\n - **\"growing-max-lines\":\"number\"** Defines the maximum number of lines that the Web Component can grow.\n - **\"max\":\"number\"** set the maximum number of characters available in the input field.\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **max:\"number\"** set the maximum number of characters available in the input field.\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind a entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-ui5-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5TextareaInput", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n rows: undefined,\n growing: undefined,\n growingMaxLines: undefined,\n showExceededText: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in textarea-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxlength: null,\n rows: null,\n growing: null,\n growingMaxLines: null,\n showExceededText: null,\n }" } ], "events": [ { "type": { "text": "`text`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" }, { "description": " Fired when the value of the ui5-input changes at each keystroke.", "name": "input" }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "module": "src/furo-ui5-textarea-input.js" }, "tagName": "furo-ui5-textarea-input", "summary": "data textarea input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TextareaInput", "declaration": { "name": "FuroUi5TextareaInput", "module": "src/furo-ui5-textarea-input.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-time-picker-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-time-picker-labeled`\nThe furo-ui5-time-picker-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5TimePickerLabeled", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "formatPattern", "privacy": "public", "type": { "text": "String" }, "description": "forwards the format-pattern to the furo-ui5-time-picker component.", "attribute": "format-pattern" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "format-pattern", "type": { "text": "String" }, "description": "forwards the format-pattern to the furo-ui5-time-picker component.", "fieldName": "formatPattern" }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-time-picker-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TimePickerLabeled", "declaration": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-time-picker-labeled", "declaration": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-time-picker.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-time-picker component allows the user to bind a field of type google.type.TimeOfDay.\nRepresents a time of day. The date and time zone are either not significant\nor are specified elsewhere.\n\nhttps://sap.github.io/ui5-webcomponents/playground/components/TimePicker/\n\nSupported format options are pattern-based on Unicode LDML Date Format notation. For more information, see\nUTS #35: Unicode Locale Data Markup Language.\n\nFor example, if the format-pattern is \"hh:mm:ss\", a valid value string is \"11:42:35\" and the same is displayed in the input.\n\nThe text field can be editable or read-only (readonly property), and it can be enabled or disabled (enabled property).\nTo visualize semantic states, such as \"error\" or \"warning\", the valueState property is provided.\nWhen the user makes changes to the time, the change event is fired, which enables you to react on any time change.\n\nYou can bind a `string` or `google.type.TimeOfDay` (https://github.com/googleapis/googleapis/blob/master/google/type/timeofday.proto).\n\n```html\n \n \n```\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n- **placeholder:\"some string\"** set the placeholder for the element\n- **min:\"11:42:35\"** set the minDate for the element (use iso date in the constraint)\n- **max:\"23:59:59\"** set the maxDate for the element (use iso date in the constraint)\n- **pattern:\"HH:mm:ss\"** set the pattern for the element\n\nThe constraint **required** will mark the element as required\n\n## Methods\n**bind-data(fieldNode)**\nBind a entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)", "name": "FuroUi5TimePicker", "members": [ { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "description": "update of the bound FieldNode", "privacy": "private" }, { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "description": "FieldNodeAdapter callback function to\nhandle changes on the model." }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private" }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private" }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes." }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private" }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private" }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }" } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed" }, { "description": "Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "package": "@ui5/webcomponents/dist/generated/i18n/i18n-defaults.js" }, "tagName": "furo-ui5-time-picker", "summary": "furo data time picker field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TimePicker", "declaration": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-toast-display.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-toast-display will catch furo-ui5-toast elements, to display it in the dom of his parent element.\n\nThe first furo-ui5-toast-display on the event path will catch the `furo-ui5-toast-register` request from a underlying furo-ui5-toast.", "name": "FuroUi5ToastDisplay", "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-toast-display", "summary": "Display element for furo-ui5-toast", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ToastDisplay", "declaration": { "name": "FuroUi5ToastDisplay", "module": "src/furo-ui5-toast-display.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-toast-display", "declaration": { "name": "FuroUi5ToastDisplay", "module": "src/furo-ui5-toast-display.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-toast.js", "declarations": [ { "kind": "class", "description": "The furo-ui5-toast is a extended ui5-toast which can attach itself to a parent dom element.\n\nThis is helpful, when you have used z-indexes in one of the parents, which put the original ui5-toast behind the backdrop.\n\nUse this component like a regular ui5-toast and do not forget to place the furo-ui5-toast-display in one of the parent elements.\n\nIt supports all features from the [SAP ui5 Toast element](https://sap.github.io/ui5-webcomponents/playground/components/Toast/).\n\n**important:** Place a furo-ui5-toast-display in any dom parent of the component where you use furo-ui5-toast. Your app-shell or body is a good place to do that.\n\n```html\nContent\n\n\n```", "name": "FuroUi5Toast", "members": [ { "kind": "method", "name": "show", "description": "shows the toast" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true } ], "superclass": { "module": "src/furo-ui5-toast.js" }, "tagName": "furo-ui5-toast", "summary": "Toast element", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Toast", "declaration": { "name": "FuroUi5Toast", "module": "src/furo-ui5-toast.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-toggle-button.js", "declarations": [ { "kind": "class", "description": "The 'furo-ui5-toggle-button' component allows the user to switch true and false for Bool with data binding.\n\nIt supports all features from the [SAP ui5 toggleButton element](https://sap.github.io/ui5-webcomponents/playground/components/ToggleButton/).\n\nYou can bind `bool` type, `furo.fat.Bool` type or the `google.wrapper.BoolValue` type.\n\n```html\n \n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta | fat | html |\n|------ |----- |------ |\n| 1 | 10 | 100 |\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"disabled\":\"true\"** set the element to disabled\n - **\"icon\":\"\"** set the icon\n - **\"design\":\"\"** set the design\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n\nThe constraint **required** will mark the element as required", "name": "FuroUi5ToggleButton", "members": [ { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom." }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the toggleButton changes.", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private" }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private" }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private" }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private" }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private" }, { "kind": "method", "name": "_setDesign", "parameters": [ { "name": "design" } ], "description": "Updates the design", "privacy": "private" }, { "kind": "method", "name": "_resetDesign", "description": "reset to previous value state", "privacy": "private" }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "text" }, { "name": "placeholder" } ], "description": "overwrite onFnaLabelChanged function\nlabel is mapped to text", "privacy": "private" }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private" }, { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_previousDesign", "type": { "text": "string" }, "default": "'Default'" }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n label: undefined,\n }" }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n label: undefined,\n icon: undefined,\n design: undefined,\n }" }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }" }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n disabled: null,\n text: null,\n icon: null,\n design: null,\n }" } ], "events": [ { "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "click" }, { "type": { "text": "Boolean" }, "description": "Fires the value of pressed when value changed.", "name": "furo-value-changed" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "module": "src/furo-ui5-toggle-button.js" }, "tagName": "furo-ui5-toggle-button", "summary": "boolean toggle button", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ToggleButton", "declaration": { "name": "FuroUi5ToggleButton", "module": "src/furo-ui5-toggle-button.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-tree.js", "declarations": [ { "kind": "class", "description": "`furo-tree`\nrenders a tree structure\n\n## Data signature\n\n```yaml\n- type: 'tree.Tree #Navigation tree type with recursive navigation nodes'\n fields:\n root: 'tree.Navigationnode:1 #Root node of the tree'\n id: 'string:2 #[optional] Id of the tree'\n display_name: '- string:3 #[optional] String representation of the tree'\n description: 'string:4 #[optional] description of the tree'\n```\n\n\n```yaml\n- type: 'tree.Navigationnode #Item of the navigationtree'\n fields:\n id: 'string:1 #Id of the node'\n display_name: '- string:2 #String representation of the node'\n children: '[] tree.Navigationnode:3 #Children of this node'\n open: 'bool:4 #node is open or not'\n secondary_text: 'string:5 #[optional] Secondary text of the node'\n description: 'string:6 #[optional] Searchable description of the node'\n icon: 'string:7 #[optional] icon of the node'\n key_words: 'string:8 #[optional] searchable key words of the node'\n has_error: 'bool:9 #[optional] error indicator'\n is_group_label: 'bool:10 #[optional] Mark node as group label'\n```", "name": "FuroUi5Tree", "cssProperties": [ { "type": { "text": "N/A" }, "description": "background color", "name": "--surface", "default": "white" }, { "type": { "text": "N/A" }, "description": "foreground color", "name": "--on-surface", "default": "#333333" }, { "type": { "text": "N/A" }, "description": "tree indention level 1", "name": "--tree-indentation-1", "default": "16px" }, { "type": { "text": "N/A" }, "description": "tree indention level 2", "name": "--tree-indentation-2", "default": "32px" }, { "type": { "text": "N/A" }, "description": "tree indention level 3", "name": "--tree-indentation-3", "default": "48px" }, { "type": { "text": "N/A" }, "description": "tree indention level 4", "name": "--tree-indentation-4", "default": "56px" }, { "type": { "text": "N/A" }, "description": "tree indention level 5", "name": "--tree-indentation-5", "default": "64px" }, { "type": { "text": "N/A" }, "description": "tree indention level 6", "name": "--tree-indentation-6", "default": "72px" }, { "type": { "text": "N/A" }, "description": "tree indention level 7", "name": "--tree-indentation-7", "default": "80px" }, { "type": { "text": "N/A" }, "description": "tree indention level 8", "name": "--tree-indentation-8", "default": "88px" }, { "type": { "text": "N/A" }, "description": "tree indention level 9", "name": "--tree-indentation-9", "default": "92px" }, { "type": { "text": "N/A" }, "description": "tree indention level 10", "name": "--tree-indentation-10", "default": "96px" }, { "type": { "text": "N/A" }, "description": "tree indention level 11", "name": "--tree-indentation-11", "default": "100px" }, { "type": { "text": "N/A" }, "description": "tree indention level 12", "name": "--tree-indentation-12", "default": "104px" } ], "members": [ { "kind": "method", "name": "collapseFocused", "description": "collapses the focused element. If it is closed the parent will be focused." }, { "kind": "method", "name": "expandFocused", "description": "expands the focused node, if it is opened the first child will be focused" }, { "kind": "method", "name": "expandFocusedRecursive", "description": "expands the focused node recursive" }, { "kind": "method", "name": "collapseFocusedRecursive", "description": "collapses the focused node recursive" }, { "kind": "method", "name": "selectFocused", "description": "selects the focused element." }, { "kind": "method", "name": "search", "parameters": [ { "name": "term" } ], "description": "Search in the visible nodes", "return": { "type": { "text": "[]" } } }, { "kind": "method", "name": "searchOpenTree" }, { "kind": "method", "name": "resetSearch", "description": "Disables the search mode and clears the term" }, { "kind": "method", "name": "_updateSearchmatchAttributesOnItems", "privacy": "private" }, { "kind": "method", "name": "focusParent", "description": "Focuses the parent tree node without selecting it.\n\nThe tree item will also scrollIntoViewIfNeeded() (on all platforms which support this method)." }, { "kind": "method", "name": "focusPrevious", "description": "focus the previous visible node.\n\nThe tree item will also scrollIntoViewIfNeeded() (on all platforms which support this method)." }, { "kind": "method", "name": "qpIn", "parameters": [ { "name": "qpObject" } ], "description": "Selects the node which is defined on `qp`\n\nUse this, if you do not have a location object." }, { "kind": "method", "name": "locationIn", "parameters": [ { "name": "locationObject" } ], "description": "Inject a location object, which contains a query param property to select the current node.", "return": { "type": { "text": "*|boolean" } } }, { "kind": "method", "name": "selectById", "parameters": [ { "name": "nodeID" } ] }, { "kind": "method", "name": "selectPrev", "description": "select the previous visible item" }, { "kind": "method", "name": "expandNodeRecursive", "description": "expands the currently selected node recursive" }, { "kind": "method", "name": "expandAll" }, { "kind": "method", "name": "collapseAll" }, { "kind": "method", "name": "collapseNodeRecursive", "description": "expands the currently selected node recursive" }, { "kind": "method", "name": "toggle", "description": "toggles the currently selected node" }, { "kind": "method", "name": "addSubNode", "parameters": [ { "name": "rawNode" } ] }, { "kind": "method", "name": "deleteNode" }, { "kind": "method", "name": "selectNext", "description": "select the next visible item" }, { "kind": "method", "name": "triggerNavigation", "parameters": [ { "name": "key" } ] }, { "kind": "method", "name": "focusFirst", "description": "Focuses the first node in the tree without selecting it.\n\nUse selectFocused to select the focused node.\n\nThe tree item will also scrollIntoViewIfNeeded() (on all platforms which support this method)." }, { "kind": "method", "name": "focusLast", "description": "Focuses the last node in the tree without selecting it.\n\nUse selectFocused to select the focused node.\n\nThe tree item will also scrollIntoViewIfNeeded() (on all platforms which support this method)." }, { "kind": "method", "name": "focusNext", "description": "focuses the next visible tree node.\n\nThe tree item will also scrollIntoViewIfNeeded() (on all platforms which support this method)." }, { "kind": "method", "name": "focus", "description": "focuses the tree itself. You can use this in combination with keyboard navigation (furo-navigation-pad)" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "treeNode", "description": "Fieldnode", "type": { "text": "NavigationNode|Tree" } } ], "description": "Binds a FieldNode.\n\nSupported types: everything with a `tree.Tree` or `tree.Navigationnode` signature." }, { "kind": "method", "name": "_setTitle", "parameters": [ { "name": "treeNode" } ], "privacy": "private" }, { "kind": "method", "name": "focusSelected", "description": "Focuses the currently selected tree item.\n\nThe tree item will also scrollIntoViewIfNeeded() (on all platforms which support this method)." }, { "kind": "method", "name": "_init", "description": "convert the tree to a flat tree", "privacy": "private" }, { "kind": "method", "name": "_initFocusAndSelectEvents", "privacy": "private" }, { "kind": "method", "name": "_buildFlatTree", "parameters": [ { "name": "tree" } ], "privacy": "private" }, { "kind": "method", "name": "_parseTreeRecursive", "parameters": [ { "name": "tree" }, { "name": "level" }, { "name": "maxdepth" } ], "privacy": "private" }, { "kind": "field", "name": "_flatTree", "type": { "text": "Array" }, "description": "Flat list representation of the tree", "privacy": "private", "default": "[]" }, { "kind": "field", "name": "tabindex", "privacy": "public", "type": { "text": "number" }, "description": "Sets the tabindex", "default": "0", "attribute": "tabindex", "reflects": true }, { "kind": "field", "name": "_searchTerm", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "expandDepth", "privacy": "public", "type": { "text": "number" }, "description": "Sets the maximal expand level relative from the current node.\n\nExpanding is a expensive operation.", "default": "2", "attribute": "expand-depth" }, { "kind": "field", "name": "_searchIsActive", "privacy": "private", "type": { "text": "boolean" }, "description": "indicator for searching. Maybe you want style your item depending on this attribute", "default": "false", "attribute": "searching", "reflects": true }, { "kind": "field", "name": "depth", "privacy": "public", "type": { "text": "Number" }, "description": "Maximal depth for the tree. Default is infinite.", "attribute": "depth" }, { "kind": "field", "name": "qp", "privacy": "public", "type": { "text": "String" }, "description": "Query param to watch. Set `qp` to have a deep linkable tree.\n\nIf you set this attribute, the node-selected event will only be fired on `fn-qp-in` or `fn-select-by-id`.\n\nIf you select an item the `qp-change-request` will be fired instead. With the qp-change-request event, you should update the url.\nA `furo-location` should watch the url and update the location on the tree, which will trigger a node-selected event.\n\n```html\n\n\n\n\n```", "attribute": "qp" }, { "kind": "field", "name": "rootAsHeader", "privacy": "public", "type": { "text": "Boolean" }, "description": "Set this flag if you do not want a header-text section.", "attribute": "root-as-header" }, { "kind": "field", "name": "hideRootNode", "privacy": "public", "type": { "text": "Boolean" }, "description": "Set this flag if you do not want to see the root node", "attribute": "hide-root-node" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "String" }, "description": "Override display name from root object", "attribute": "header-text" }, { "kind": "field", "name": "secondaryText", "privacy": "public", "type": { "text": "String" }, "description": "Override description from root object.", "attribute": "secondary-text" }, { "kind": "field", "name": "focused", "privacy": "public", "type": { "text": "Boolean" }, "description": "indicates that the element is focused", "attribute": "focused", "reflects": true } ], "events": [ { "type": { "text": "focused field" }, "description": " Fired when", "name": "node-focused" }, { "type": { "text": "focused field" }, "description": " Fired when", "name": "branch-focused" }, { "description": " Fired when", "name": "leaf-focused" }, { "type": { "text": "selected field" }, "description": " Fired when the item gets selected, does not fire when you work with query params", "name": "node-selected" }, { "type": { "text": "Object {\"this.qp\": this._selectedField.id._value}" }, "description": " Fired when qp mode is enabled. Nodes are only selectable with qpIn or selectById", "name": "qp-change-requested" }, { "type": { "text": "selected field" }, "description": " Fired when", "name": "branch-selected" }, { "type": { "text": "selected field" }, "description": " Fired when", "name": "leaf-selected" }, { "description": " Fired when a node is opened", "name": "node-opened" }, { "description": " Fired when a node is closed", "name": "node-closed" }, { "description": " Fired when nodes are expanded recursive", "name": "nodes-expanded" }, { "description": " Fired when nodes are collapsed recursive.", "name": "nodes-collapsed" } ], "attributes": [ { "name": "depth", "type": { "text": "Number" }, "description": "Maximal depth for the tree. Default is infinite.", "fieldName": "depth" }, { "name": "expand-depth", "type": { "text": "number" }, "description": "Sets the maximal expand level relative from the current node.\n\nExpanding is a expensive operation.", "default": "2", "fieldName": "expandDepth" }, { "name": "qp", "type": { "text": "String" }, "description": "Query param to watch. Set `qp` to have a deep linkable tree.\n\nIf you set this attribute, the node-selected event will only be fired on `fn-qp-in` or `fn-select-by-id`.\n\nIf you select an item the `qp-change-request` will be fired instead. With the qp-change-request event, you should update the url.\nA `furo-location` should watch the url and update the location on the tree, which will trigger a node-selected event.\n\n```html\n\n\n\n\n```", "fieldName": "qp" }, { "name": "tabindex", "type": { "text": "number" }, "description": "Sets the tabindex", "default": "0", "fieldName": "tabindex" }, { "name": "root-as-header", "type": { "text": "Boolean" }, "description": "Set this flag if you do not want a header-text section.", "fieldName": "rootAsHeader" }, { "name": "hide-root-node", "type": { "text": "Boolean" }, "description": "Set this flag if you do not want to see the root node", "fieldName": "hideRootNode" }, { "name": "header-text", "type": { "text": "String" }, "description": "Override display name from root object", "fieldName": "headerText" }, { "name": "secondary-text", "type": { "text": "String" }, "description": "Override description from root object.", "fieldName": "secondaryText" }, { "name": "searching", "type": { "text": "boolean" }, "description": "indicator for searching. Maybe you want style your item depending on this attribute", "default": "false", "fieldName": "_searchIsActive" }, { "name": "focused", "type": { "text": "Boolean" }, "description": "indicates that the element is focused", "fieldName": "focused" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-tree", "summary": "tree navigation menu", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Tree", "declaration": { "name": "FuroUi5Tree", "module": "src/furo-ui5-tree.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-tree", "declaration": { "name": "FuroUi5Tree", "module": "src/furo-ui5-tree.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-typerenderer-labeled.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-typerenderer-labeled`\nThe furo-ui5-typerenderer-labeled is a composition to easily use a display field with label according\nto the design specification of SAP Fiori Design System.", "name": "FuroUi5TyperendererLabeled", "members": [ { "kind": "method", "name": "focus", "description": "focus Focuses the field", "privacy": "public", "parameters": [ { "name": "null" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds the fieldNode to the component\nbinding set can be customised here otherwise the standard bindData in the ui5-data-input will be used" }, { "kind": "field", "name": "label", "privacy": "private", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "attribute": "label" }, { "kind": "field", "name": "valueState", "privacy": "private", "type": { "text": "string" }, "description": "Value State", "default": "'None'", "attribute": "value-state", "reflects": true }, { "kind": "field", "name": "context", "privacy": "public", "type": { "text": "string" }, "description": "Set the render context. Default is **display**, the type renderer set of @furo/ui5 supports\n**cell**, **form**, **celledit**", "default": "'display'", "attribute": "context" }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "Disabled State", "attribute": "disabled", "reflects": true } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "fieldName": "label" }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full" }, { "name": "value-state", "type": { "text": "string" }, "description": "Value State", "default": "'None'", "fieldName": "valueState" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "Disabled State", "fieldName": "disabled" }, { "name": "context", "type": { "text": "string" }, "description": "Set the render context. Default is **display**, the type renderer set of @furo/ui5 supports\n**cell**, **form**, **celledit**", "default": "'display'", "fieldName": "context" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-typerenderer-labeled", "summary": "labeled input field", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TyperendererLabeled", "declaration": { "name": "FuroUi5TyperendererLabeled", "module": "src/furo-ui5-typerenderer-labeled.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-typerenderer-labeled", "declaration": { "name": "FuroUi5TyperendererLabeled", "module": "src/furo-ui5-typerenderer-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-z-grid.js", "declarations": [ { "kind": "class", "description": "`z-grid`\nis a grid which places your elements in a **z** pattern.\nIt creates a grid which can be imagined as a grid with cells of the size *8rem x 8rem*.~\n\nThe size on the x-axis can vary a little bit, according to the the available space.\n\n\nThis component is nestable.\n\n```html\n\n \n \n \n \n\n \n \n \n \n \n```\n\n\n ## sizes\n The sizes are calculated from the available space that the grid becomes from its parent.\n\n ### Sizes are calculated as following\n\n ```\n | small | medium | large | xlarge |\n | | | | |\n | 0...599 | 600...1023 | 1024...1439 | 1440...nnnn |\n\n ```\n\n ## hspan\n Set the horizontal space (the width) with the *hspan* attribute.\n\n Available ranges are from 1 to 9 and full.\n\n To tell a element that it has to use the full width use `hspan=\"full\"` or use the alias `full` or `full-width`.\n\n `hspan=\"1\"`, `hspan=\"2\"`,...,`hspan=\"9\"`, `hspan=\"full\"`\n\n ## vspan\n Set the vertical space (the height) with the *vspan* attribute.\n\n Available ranges are from 1 to 9.\n\n `vspan=\"1\"`, `vspan=\"2\"`,...,`vspan=\"9\"`\n\n ## newline\n To force a placement on a new line use `newline`\n\n ## padding\n Set the attribute *padding* to add paddings according to the size of the furo-z-grid automatically.\n\n :host([size='size-s']) ==> **0.25rem 1rem;**\n\n :host([size='size-m'] ==> **0.25rem 2rem;**\n\n :host([size='size-l'] ==> **1rem 2rem;**\n\n :host([size='size-xl'] ==> **1rem 3rem;**\n\n ## full-on-[size]\n To set full width on a specific current size, use `full-on-size-small` , `full-on-size-medium` , `full-on-size-large` ,`full-on-size-xlarge`.\n\n When the available space has the given size, the default hspan are overridden and the full width is used.\n\n ## hide-on-[size]\n To hide a element on a specific current size, use `hide-on-size-small` , `hide-on-size-medium` , `hide-on-size-large` ,`hide-on-size-xlarge`.\n\n ## show-on-[size]\n To show a element only on a specific current size, use `show-on-size-small` , `show-on-size-medium` , `show-on-size-large` ,`show-on-size-xlarge`.\n\n ## custom span sizes on different sizes (hspan-on-[size])\n To set a specific width (hspan) on a specific current size, use `hspan-on-size-small=\"1...9\"` , `hspan-on-size-medium=\"1...9\"` , `hspan-on-size-large=\"1...9\"` , `hspan-on-size-xlarge=\"1...9\"` .\n\n ## Ohter attributes\n\n The attributes *full* and *full-width* are aliases for `hspan=\"full\"`.\n\n## Named lines and columns\n**last-col** refers to the last column.\n**last-row** refers to the last line/row.", "name": "FuroUi5ZGrid", "cssProperties": [ { "type": { "text": "N/A" }, "description": "card content height with vspan=1, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "4rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=2, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "8rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=3, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "12rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=4, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "16rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=5, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "20rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=6, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "24rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=7, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "28rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=8, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "32rem" }, { "type": { "text": "N/A" }, "description": "card content height with vspan=9, --furo-ui5-cardContentHeight is calculated by span * 2 - cardHeaderHeight", "name": "--furo-ui5-cardContentHeight", "default": "36rem" } ], "slots": [ { "type": { "text": "HTMLElement [0..n]" }, "description": "default slot to add content.", "name": "" } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_checkSize", "parameters": [ { "name": "size" } ], "description": "Form breakpoints according to SAP Fiori Design System\nhttps://experience.sap.com/fiori-design-web/form/", "privacy": "private" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-z-grid", "summary": "grid with a z pattern", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ZGrid", "declaration": { "name": "FuroUi5ZGrid", "module": "src/furo-ui5-z-grid.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-z-grid", "declaration": { "name": "FuroUi5ZGrid", "module": "src/furo-ui5-z-grid.js" } } ] }, { "kind": "javascript-module", "path": "src/ui5-reference-search-item.js", "declarations": [ { "kind": "class", "description": "`reference-search-item`\nRepeated item to display the search result set", "name": "Ui5ReferenceSearchItem", "members": [ { "kind": "method", "name": "injectItem", "parameters": [ { "name": "item" } ], "description": "Inject of the item\ndata of inner text of the element is defined with the attribute\ndisplay-field (default value: display_name)" }, { "kind": "method", "name": "deselect" }, { "kind": "method", "name": "preselect" }, { "kind": "method", "name": "select" }, { "kind": "field", "name": "_item", "type": { "text": "object" }, "default": "{}" }, { "kind": "field", "name": "displayField", "type": { "text": "string" }, "default": "'display_name'" } ], "events": [ { "type": { "text": "item" }, "description": " Fired when item is selected", "name": "item-selected" } ], "superclass": { "module": "src/ui5-reference-search-item.js" }, "tagName": "ui5-reference-search-item", "summary": "representation of a result item", "customElement": true } ], "exports": [ { "kind": "js", "name": "Ui5ReferenceSearchItem", "declaration": { "name": "Ui5ReferenceSearchItem", "module": "src/ui5-reference-search-item.js" } }, { "kind": "custom-element-definition", "name": "ui5-reference-search-item", "declaration": { "name": "Ui5ReferenceSearchItem", "module": "src/ui5-reference-search-item.js" } } ] }, { "kind": "javascript-module", "path": "src/directives/nl2br.js", "declarations": [ { "kind": "class", "description": "", "name": "DirectiveNl2br", "members": [], "superclass": { "name": "Directive", "package": "lit/directive.js" } }, { "kind": "variable", "name": "nl2br" } ], "exports": [ { "kind": "js", "name": "DirectiveNl2br", "declaration": { "name": "DirectiveNl2br", "module": "src/directives/nl2br.js" } }, { "kind": "js", "name": "nl2br", "declaration": { "name": "nl2br", "module": "src/directives/nl2br.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/furo-ui5-filtered-table.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-filtered-table` is a table which work with `furo-ui5-views`. It accepts field orders and a set of visible fields.\n\nIt works like a `furo-ui5-table` but has the ability to reorder the columns. The only action you have to take is to set\nthe `id` attribute on the `ui5-table-column`. The id must match to the `field_name` attribute on the table_settings.\n\n```html\n \n id\n display_name\n```", "name": "FuroUi5FilteredTable", "members": [ { "kind": "method", "name": "_cellMap", "parameters": [ { "name": "fields" } ], "description": "ui5 data table cell template", "privacy": "private", "return": { "type": { "text": "TemplateResult|TemplateResult" } }, "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "_initRepeatTemplate", "parameters": [ { "name": "fieldPaths" } ], "privacy": "private", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "setOrderBy", "parameters": [ { "name": "sort" } ], "description": "This is only used to set the order icons on the table headers. You have to use a `furo-ui5-views-column-header` in the\nheader slot for this.\n\n```html\n${i18n.t('activity_nr')}\n \n```\n\nThe value comes from the event `order-by-changed`, which is emited by the component `furo-ui5-views-table-settings`." }, { "kind": "method", "name": "setColumns", "parameters": [ { "name": "sortedlist" } ], "description": "setColumns sets the column order and the visible columns", "privacy": "public" }, { "kind": "field", "name": "_colheaders", "type": { "text": "{}" }, "description": "Parkplatz", "privacy": "private", "default": "{}" }, { "kind": "method", "name": "_FBPReady", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "data" } ], "description": "Bind a repeated data node.", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "focus", "description": "Focuses the header of the table", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "focusLast", "description": "Focuses the last row.", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "focusFirst", "description": "Focuses the first row.", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "_init", "description": "init data table", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "_getSpecFieldFromPath", "parameters": [ { "name": "field" }, { "name": "path" } ], "description": "resolves a field specification with the given path", "return": { "type": { "text": "*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "setBusy", "description": "setBusy Sets the busy state", "privacy": "public", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "method", "name": "unsetBusy", "description": "unsetBusy Unsets the busy state", "privacy": "public", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "cols", "type": { "text": "array" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "_specs", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "data", "type": { "text": "array" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "mode", "privacy": "public", "type": { "text": "string" }, "description": "Defines the mode of the component.\n\nAvailable options are:\n- MultiSelect\n- SingleSelect\n- None", "default": "'None'", "attribute": "mode", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Defines the text that will be displayed when there is no data.\nstring", "attribute": "no-data-text", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "identityPath", "privacy": "public", "type": { "text": "*" }, "description": "string}", "attribute": "identity-path", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "stickyColumnHeader", "privacy": "public", "type": { "text": "Boolean" }, "description": "Determines whether the column headers remain fixed at the top of the page during vertical scrolling as long as the Web Component is in the viewport.", "attribute": "sticky-column-header", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "kind": "field", "name": "busy", "privacy": "public", "type": { "text": "Boolean" }, "description": "Busy state", "attribute": "busy", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } } ], "superclass": { "name": "FuroUi5Table", "module": "/src/furo-ui5-table.js" }, "summary": "table with flexible columns", "tagName": "furo-ui5-filtered-table", "customElement": true, "attributes": [ { "name": "mode", "type": { "text": "string" }, "description": "Defines the mode of the component.\n\nAvailable options are:\n- MultiSelect\n- SingleSelect\n- None", "default": "'None'", "fieldName": "mode", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "name": "no-data-text", "type": { "text": "String" }, "description": "Defines the text that will be displayed when there is no data.\nstring", "fieldName": "noDataText", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "name": "identity-path", "type": { "text": "*" }, "description": "string}", "fieldName": "identityPath", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "name": "sticky-column-header", "type": { "text": "Boolean" }, "description": "Determines whether the column headers remain fixed at the top of the page during vertical scrolling as long as the Web Component is in the viewport.", "fieldName": "stickyColumnHeader", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "name": "busy", "type": { "text": "Boolean" }, "description": "Busy state", "fieldName": "busy", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } } ], "events": [ { "name": "data-loaded", "type": { "text": "HTMLElement" }, "description": "Fired when the data is loaded into data table. The event detail contains the data table self.", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "type": { "text": "entity" }, "description": "Fired when the ArrowDown is pressed on the last row. The event detail is the original entity of the row", "name": "arrow-down-on-last-row", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "type": { "text": "entity" }, "description": "Fired when the row is selected. The event detail is the original entity of the row.", "name": "tablerow-selected", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "type": { "text": "entity" }, "description": "Fired when the ArrowUp is pressed on the first row. The event detail is the original entity of the row", "name": "arrow-up-on-first-row", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } }, { "type": { "text": "Array with the selected items" }, "description": "Fired when the row selection in MultiSelect mode was changed", "name": "rows-selected", "inheritedFrom": { "name": "FuroUi5Table", "module": "src/furo-ui5-table.js" } } ] } ], "exports": [ { "kind": "js", "name": "FuroUi5FilteredTable", "declaration": { "name": "FuroUi5FilteredTable", "module": "src/furo-ui5-views/furo-ui5-filtered-table.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-filtered-table", "declaration": { "name": "FuroUi5FilteredTable", "module": "src/furo-ui5-views/furo-ui5-filtered-table.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/furo-ui5-views-column-header.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-views-column-header`\n\n Displays a sort direction icon in the table header.\n\n ```html\n${i18n.t('activity_nr')}\n \n```", "name": "FuroUi5ViewsColumnHeader", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "showSort", "parameters": [ { "name": "descending" } ], "description": "set the sort indicator" }, { "kind": "method", "name": "clear", "description": "remove the sorting" }, { "kind": "field", "name": "_icon", "privacy": "public", "type": { "text": "string" }, "default": "'sort-ascending'", "attribute": "_icon" }, { "kind": "field", "name": "_hidesort", "privacy": "public", "type": { "text": "boolean" }, "description": "Description", "attribute": "_hidesort" } ], "attributes": [ { "name": "_hidesort", "type": { "text": "boolean" }, "description": "Description", "fieldName": "_hidesort" }, { "name": "_icon", "type": { "text": "string" }, "default": "'sort-ascending'", "fieldName": "_icon" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Shows a sort direction icon", "tagName": "furo-ui5-views-column-header", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ViewsColumnHeader", "declaration": { "name": "FuroUi5ViewsColumnHeader", "module": "src/furo-ui5-views/furo-ui5-views-column-header.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-views-column-header", "declaration": { "name": "FuroUi5ViewsColumnHeader", "module": "src/furo-ui5-views/furo-ui5-views-column-header.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/furo-ui5-views-filter-settings.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-views-filter-settings` contains the dialog for the filter settings for a `furo-ui5-views`.", "name": "FuroUi5ViewsFilterSettings", "members": [ { "kind": "method", "name": "bindFilter", "parameters": [ { "name": "fieldnode" } ], "description": "Bind the filter DO.", "privacy": "public" }, { "kind": "method", "name": "bindSettings", "parameters": [ { "name": "fieldnode" } ], "description": "Bind the settings DO from `furo-ui5-views`.", "privacy": "public" }, { "kind": "method", "name": "show", "description": "Opens the filter dialog.", "privacy": "public" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "colheaderField", "privacy": "public", "type": { "text": "string" }, "description": "Title for the field column.", "default": "'Field'", "attribute": "colheader-field" }, { "kind": "field", "name": "colheaderPosition", "privacy": "public", "type": { "text": "string" }, "description": "Title for the position column.", "default": "'Position'", "attribute": "colheader-position" }, { "kind": "field", "name": "colheaderValue", "privacy": "public", "type": { "text": "string" }, "description": "Title for the value column.", "default": "'Value'", "attribute": "colheader-value" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "type": { "text": "string" }, "description": "Placeholder text for the searcher.", "default": "'Search'", "attribute": "placeholder-search" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "Title for the dialog.", "default": "'Adapt Filter'", "attribute": "filtersettings-header-text" } ], "attributes": [ { "name": "colheader-field", "type": { "text": "string" }, "description": "Title for the field column.", "default": "'Field'", "fieldName": "colheaderField" }, { "name": "colheader-position", "type": { "text": "string" }, "description": "Title for the position column.", "default": "'Position'", "fieldName": "colheaderPosition" }, { "name": "colheader-value", "type": { "text": "string" }, "description": "Title for the value column.", "default": "'Value'", "fieldName": "colheaderValue" }, { "name": "placeholder-search", "type": { "text": "string" }, "description": "Placeholder text for the searcher.", "default": "'Search'", "fieldName": "placeholderSearch" }, { "name": "filtersettings-header-text", "type": { "text": "string" }, "description": "Title for the dialog.", "default": "'Adapt Filter'", "fieldName": "headerText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "filter dialog", "tagName": "furo-ui5-views-filter-settings", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ViewsFilterSettings", "declaration": { "name": "FuroUi5ViewsFilterSettings", "module": "src/furo-ui5-views/furo-ui5-views-filter-settings.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-views-filter-settings", "declaration": { "name": "FuroUi5ViewsFilterSettings", "module": "src/furo-ui5-views/furo-ui5-views-filter-settings.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/furo-ui5-views-table-settings.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-views-table-settings` contains the dialog for the table settings for a `furo-ui5-views`.", "name": "FuroUi5ViewsTableSettings", "members": [ { "kind": "method", "name": "show", "description": "show", "privacy": "public" }, { "kind": "method", "name": "bindSettings", "parameters": [ { "name": "e", "description": "complete event" } ], "description": "Bind the settings component from `furo-ui5-views`.", "privacy": "public" }, { "kind": "method", "name": "moveNode", "parameters": [ { "name": "fromIndex" }, { "name": "toIndex" } ], "privacy": "private" }, { "kind": "method", "name": "_updateSettings", "description": "update the current settings", "privacy": "private" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "Title of the dialog.", "default": "'View Settings'", "attribute": "tablesettings-header-text" }, { "kind": "field", "name": "tabColumnsLabel", "privacy": "public", "type": { "text": "string" }, "description": "Label for the column tab.", "default": "'Columns'", "attribute": "tab-columns-label" }, { "kind": "field", "name": "tabSortLabel", "privacy": "public", "type": { "text": "string" }, "description": "Label for the sorter tab.", "default": "'Sort'", "attribute": "tab-sort-label" }, { "kind": "field", "name": "okButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Label for the OK button.", "default": "'Ok'", "attribute": "ok-button-text" }, { "kind": "field", "name": "cancelButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Label for the cancel button.", "default": "'Cancel'", "attribute": "cancel-button-text" }, { "kind": "field", "name": "colheaderField", "privacy": "public", "type": { "text": "string" }, "description": "Titel for the field column.", "default": "'Field'", "attribute": "colheader-field" }, { "kind": "field", "name": "colheaderPosition", "privacy": "public", "type": { "text": "string" }, "description": "Titel for the Position column.", "default": "'Position'", "attribute": "colheader-position" }, { "kind": "field", "name": "labelEmptySelect", "privacy": "public", "type": { "text": "string" }, "description": "Text for the \"pleace select\" dropdown entry.", "default": "'Sort By'", "attribute": "label-empty-select" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "type": { "text": "string" }, "description": "Placeholder for the searcher field.", "default": "'Search'", "attribute": "placeholder-search" }, { "kind": "field", "name": "rowType", "privacy": "public", "type": { "text": "string" }, "description": "Define the type for a row", "attribute": "row-type" }, { "kind": "field", "name": "requiredFields", "privacy": "public", "type": { "text": "string" }, "description": "Define fields that are required for your business logic. Required fields are always requested from the server\neven when they are not displayed.", "attribute": "required-fields" }, { "kind": "field", "name": "sortable", "privacy": "public", "type": { "text": "boolean" }, "description": "Set this to true to enable the sorting view in the dialog.", "attribute": "sortable" } ], "attributes": [ { "name": "row-type", "type": { "text": "string" }, "description": "Define the type for a row", "fieldName": "rowType" }, { "name": "required-fields", "type": { "text": "string" }, "description": "Define fields that are required for your business logic. Required fields are always requested from the server\neven when they are not displayed.", "fieldName": "requiredFields" }, { "name": "sortable", "type": { "text": "boolean" }, "description": "Set this to true to enable the sorting view in the dialog.", "fieldName": "sortable" }, { "name": "tablesettings-header-text", "type": { "text": "string" }, "description": "Title of the dialog.", "default": "'View Settings'", "fieldName": "headerText" }, { "name": "tab-columns-label", "type": { "text": "string" }, "description": "Label for the column tab.", "default": "'Columns'", "fieldName": "tabColumnsLabel" }, { "name": "tab-sort-label", "type": { "text": "string" }, "description": "Label for the sorter tab.", "default": "'Sort'", "fieldName": "tabSortLabel" }, { "name": "ok-button-text", "type": { "text": "string" }, "description": "Label for the OK button.", "default": "'Ok'", "fieldName": "okButtonText" }, { "name": "cancel-button-text", "type": { "text": "string" }, "description": "Label for the cancel button.", "default": "'Cancel'", "fieldName": "cancelButtonText" }, { "name": "colheader-field", "type": { "text": "string" }, "description": "Titel for the field column.", "default": "'Field'", "fieldName": "colheaderField" }, { "name": "colheader-position", "type": { "text": "string" }, "description": "Titel for the Position column.", "default": "'Position'", "fieldName": "colheaderPosition" }, { "name": "label-empty-select", "type": { "text": "string" }, "description": "Text for the \"pleace select\" dropdown entry.", "default": "'Sort By'", "fieldName": "labelEmptySelect" }, { "name": "placeholder-search", "type": { "text": "string" }, "description": "Placeholder for the searcher field.", "default": "'Search'", "fieldName": "placeholderSearch" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "table settings dialog", "tagName": "furo-ui5-views-table-settings", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ViewsTableSettings", "declaration": { "name": "FuroUi5ViewsTableSettings", "module": "src/furo-ui5-views/furo-ui5-views-table-settings.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-views-table-settings", "declaration": { "name": "FuroUi5ViewsTableSettings", "module": "src/furo-ui5-views/furo-ui5-views-table-settings.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/furo-ui5-views.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-views` allows you to manage custom views. This includes filter settings and table orders.\n\nTab orders are not implemented at the moment.\n\nThe user settings are stored in the `local storage`, session data in the `session storage`. Feel free to extend the `furo-ui5-views`\ncomponent to store the settings anywhere else by overriding the `saveData` method.\n\n`furo-ui5-views` manages the view data\n\n\n```html\n\n\n\n\n \n\n \n ...\n \n```\nInject the default\n\n## Specs\n\nYou have to import the furo-ui5-specs or add the following muspec to your spec project.\n\n*.furo*\n```yaml\ndependencies:\n- \"https://github.com/theNorstroem/furo-ui5-specs.git v1.0.0\"\n```\n\n*µSpecs*\n```yaml\n- type: 'furo.view.PersonalView #'\n fields:\n id: 'string:1 #'\n views: '[] furo.view.ViewSettings:2'\n\n- type: 'furo.view.ViewSettings #'\n fields:\n id: 'string:1 #id'\n name: 'string:2 #Textual identifier'\n is_favorite: 'bool:3'\n is_standard: 'bool:4'\n auto_apply: 'bool:5'\n created_by: 'string:6'\n editable: 'bool:7 #'\n filter_settings: '[] furo.view.FilterItem:8'\n filter_object: 'google.protobuf.Any:9 #Contains the filter Object'\n table_settings: '[] furo.view.TableColumn:10'\n order_by: 'string:11 # sort order, comma separated list of field names'\n group_by: 'string:11 # group by'\n\n\n- type: 'furo.view.FilterItem #Filter object'\n fields:\n field_name: 'string:1'\n show: 'bool:2 #show hide'\n\n- type: 'furo.view.TableColumnSortRow #TableColumn '\n fields:\n id: 'string:1'\n display_name: 'string:2 #'\n descending: 'bool:3 #'\n options: '[] furo.Optionitem:4'\n\n- type: 'furo.view.TableColumn #TableColumn '\n fields:\n field_name: 'string:1'\n show: 'bool:2 #show hide'\n sortable: 'bool:3 # set this to true if the field is sortable'\n groupable: 'bool:4 # set this to true if the field is groupable'\n label: 'string:5 # set this to true if the field is groupable'\n\n- type: 'furo.view.SaveAsDialog #Filter object'\n fields:\n name: '* string:1'\n is_favorite: 'bool:3'\n is_standard: 'bool:4'\n auto_apply: 'bool:5'\n```\n\nDescribe the filterable fields and sortable table columns.\n\n*sample data*\n```js\nexport const Settings = {\n \"views\": [\n {\n \"id\": \"default\",\n \"name\": \"Standard\",\n \"is_favorite\": true,\n \"is_standard\": true,\n \"auto_apply\": true,\n \"created_by\": \"Furo\",\n \"editable\": false,\n \"filter_settings\": [\n\n\n {\n \"field_name\": \"description\",\n \"show\": true\n },\n {\n \"field_name\": \"start\",\n \"show\": true\n },\n {\n \"field_name\": \"end\",\n \"show\": true\n },\n {\n \"field_name\": \"members\",\n \"show\": true\n }\n ],\n \"filter_object\": {\n \"description\": null,\n \"start\": null,\n \"end\": null,\n \"members\": null\n },\n \"table_settings\": [\n {\n \"field_name\": \"id\",\n \"show\": false,\n \"sortable\" : true\n },\n {\n \"field_name\": \"display_name\",\n \"show\": true,\n \"sortable\" : true\n },\n {\n \"field_name\": \"description\",\n \"show\": true,\n \"sortable\" : true\n },\n {\n \"field_name\": \"start\",\n \"show\": false\n },\n {\n \"field_name\": \"end\",\n \"show\": false\n },\n {\n \"field_name\": \"members\",\n \"show\": true,\n \"sortable\" : true\n }\n ],\n \"order_by\": \"\",\n \"group_by\": \"\"\n }\n ]\n}\n\n```", "name": "FuroUi5Views", "members": [ { "kind": "method", "name": "showAt", "parameters": [ { "name": "ref" } ], "description": "show opens the view", "privacy": "public" }, { "kind": "method", "name": "setFilterRef", "parameters": [ { "name": "ref" } ], "description": "set the ref to the filter form" }, { "kind": "method", "name": "injectDefault", "parameters": [ { "name": "data" } ], "description": "Inject the default settings. This is a set of predefined filters and columns." }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "_updateFilterForm", "privacy": "private" }, { "kind": "method", "name": "loadData", "description": "Loads the stored data. Extend and override, if you need another storage mechanism.\nThe data is stored in local storage under the defined view-id.", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "saveData", "parameters": [ { "name": "data" } ], "description": "Stores the settings. Extend and override, if you need another storage mechanism.\nThe data is stored in local storage under the defined view-id.", "return": { "type": { "text": "string" } } }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "description": "Title of the dialog for \"views\"", "default": "'My Views'", "attribute": "header-text" }, { "kind": "field", "name": "saveAsHeaderText", "privacy": "public", "type": { "text": "string" }, "description": "Title of the \"save as\" dialog.", "default": "'Save View'", "attribute": "save-as-header-text" }, { "kind": "field", "name": "checkoxSetDefault", "privacy": "public", "type": { "text": "string" }, "description": "Checkbox label for set as default on save as dialog.", "default": "'Set as Default'", "attribute": "checkbox-set-default" }, { "kind": "field", "name": "checkoxApplyAutomatically", "privacy": "public", "type": { "text": "string" }, "description": "Checkbox label for apply automatically on save as dialog.", "default": "'Apply Automatically'", "attribute": "checkbox-apply-automatically" }, { "kind": "field", "name": "manageButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Button label to open the manage view dialog.", "default": "'Manage'", "attribute": "manage-button-text" }, { "kind": "field", "name": "saveButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Button label for save.", "default": "'Save'", "attribute": "save-button-text" }, { "kind": "field", "name": "saveAsButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Button label for save as.", "default": "'Save As'", "attribute": "save-as-button-text" }, { "kind": "field", "name": "cancelButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Button label for cancel action.", "default": "'Cancel'", "attribute": "cancel-button-text" }, { "kind": "field", "name": "manageViewHeaderText", "privacy": "public", "type": { "text": "string" }, "description": "Title of the manage-view dialog.", "default": "'Manage Views'", "attribute": "manage-view-header-text" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "type": { "text": "string" }, "description": "placeholder for search fields.", "default": "'Search'", "attribute": "placeholder-search" }, { "kind": "field", "name": "colheaderDefault", "privacy": "public", "type": { "text": "string" }, "description": "Column header for \"default\".", "default": "'Default'", "attribute": "colheader-default" }, { "kind": "field", "name": "colheaderApply", "privacy": "public", "type": { "text": "string" }, "description": "Column header for \"apply automatically\".", "default": "'Apply Automatically'", "attribute": "colheader-apply" }, { "kind": "field", "name": "colheaderCreator", "privacy": "public", "type": { "text": "string" }, "description": "Column header for \"created by\".", "default": "'Created By'", "attribute": "colheader-creator" }, { "kind": "field", "name": "colheaderView", "privacy": "public", "type": { "text": "string" }, "description": "Column header for \"view name\".", "default": "'View'", "attribute": "colheader-view" }, { "kind": "field", "name": "okButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Button label for \"Ok\" action", "default": "'Ok'", "attribute": "ok-button-text" }, { "kind": "field", "name": "viewId", "privacy": "public", "type": { "text": "string" }, "description": "This is the id vor the view, this key is used to store the search filters in the session storage.", "attribute": "view-id" } ], "events": [ { "name": "search-triggered", "type": { "text": "Event" } } ], "attributes": [ { "name": "view-id", "type": { "text": "string" }, "description": "This is the id vor the view, this key is used to store the search filters in the session storage.", "fieldName": "viewId" }, { "name": "header-text", "type": { "text": "string" }, "description": "Title of the dialog for \"views\"", "default": "'My Views'", "fieldName": "headerText" }, { "name": "save-as-header-text", "type": { "text": "string" }, "description": "Title of the \"save as\" dialog.", "default": "'Save View'", "fieldName": "saveAsHeaderText" }, { "name": "checkbox-set-default", "type": { "text": "string" }, "description": "Checkbox label for set as default on save as dialog.", "default": "'Set as Default'", "fieldName": "checkoxSetDefault" }, { "name": "checkbox-apply-automatically", "type": { "text": "string" }, "description": "Checkbox label for apply automatically on save as dialog.", "default": "'Apply Automatically'", "fieldName": "checkoxApplyAutomatically" }, { "name": "manage-button-text", "type": { "text": "string" }, "description": "Button label to open the manage view dialog.", "default": "'Manage'", "fieldName": "manageButtonText" }, { "name": "save-button-text", "type": { "text": "string" }, "description": "Button label for save.", "default": "'Save'", "fieldName": "saveButtonText" }, { "name": "save-as-button-text", "type": { "text": "string" }, "description": "Button label for save as.", "default": "'Save As'", "fieldName": "saveAsButtonText" }, { "name": "cancel-button-text", "type": { "text": "string" }, "description": "Button label for cancel action.", "default": "'Cancel'", "fieldName": "cancelButtonText" }, { "name": "manage-view-header-text", "type": { "text": "string" }, "description": "Title of the manage-view dialog.", "default": "'Manage Views'", "fieldName": "manageViewHeaderText" }, { "name": "placeholder-search", "type": { "text": "string" }, "description": "placeholder for search fields.", "default": "'Search'", "fieldName": "placeholderSearch" }, { "name": "colheader-default", "type": { "text": "string" }, "description": "Column header for \"default\".", "default": "'Default'", "fieldName": "colheaderDefault" }, { "name": "colheader-apply", "type": { "text": "string" }, "description": "Column header for \"apply automatically\".", "default": "'Apply Automatically'", "fieldName": "colheaderApply" }, { "name": "colheader-creator", "type": { "text": "string" }, "description": "Column header for \"created by\".", "default": "'Created By'", "fieldName": "colheaderCreator" }, { "name": "colheader-view", "type": { "text": "string" }, "description": "Column header for \"view name\".", "default": "'View'", "fieldName": "colheaderView" }, { "name": "ok-button-text", "type": { "text": "string" }, "description": "Button label for \"Ok\" action", "default": "'Ok'", "fieldName": "okButtonText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Manage views", "tagName": "furo-ui5-views", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5Views", "declaration": { "name": "FuroUi5Views", "module": "src/furo-ui5-views/furo-ui5-views.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-views", "declaration": { "name": "FuroUi5Views", "module": "src/furo-ui5-views/furo-ui5-views.js" } } ] }, { "kind": "javascript-module", "path": "src/lib/Events.js", "declarations": [ { "kind": "class", "description": "", "name": "Events", "members": [ { "kind": "method", "name": "buildChangeEvent", "static": true, "parameters": [ { "name": "detail" } ], "description": "Creates an universal `furo-value-changed` event\nAll extended ui5 components should use this builder function to create\nthe change event", "return": { "type": { "text": "Event" } } } ] } ], "exports": [ { "kind": "js", "name": "Events", "declaration": { "name": "Events", "module": "src/lib/Events.js" } } ] }, { "kind": "javascript-module", "path": "src/lib/MediaSize.js", "declarations": [ { "kind": "class", "description": "# MediaSize resolver\n\nReturns the **media size** from S to XXL according to the screen width.\n\nUse this to set style vars according to the current media size.\n\n\n## Usage\n\nApply the media-size attribute to your main-stage or component.\n\n```js\nwindow.addEventListener('resize', MediaSize.DebounceBuilder(() => {\n this.setAttribute(\"media-size\", MediaSize.GetMediaSize())\n }, MediaSize.HANDLE_RESIZE_DEBOUNCE_RATE)\n);\n// initial size\nthis.setAttribute(\"media-size\", MediaSize.GetMediaSize())\n\n```\n\nSet media-size related values for your variables.\n```css\n :host([media-size='XXL']) {\n --FuroUi5MediaSizeIndentation: 2rem 3rem 1rem 3rem;\n --FuroUi5MediaSizeIndentationTop: 2rem;\n --FuroUi5MediaSizeIndentationRight: 3rem;\n --FuroUi5MediaSizeIndentationBottom: 1;\n --FuroUi5MediaSizeIndentationLeft: 3rem;\n }\n\n:host([media-size='XL']) {\n --FuroUi5MediaSizeIndentation: 2rem 3rem 1rem 3rem;\n --FuroUi5MediaSizeIndentationTop: 2rem;\n --FuroUi5MediaSizeIndentationRight: 3rem;\n --FuroUi5MediaSizeIndentationBottom: 1;\n --FuroUi5MediaSizeIndentationLeft: 3rem;\n }\n\n:host([media-size='L']) {\n --FuroUi5MediaSizeIndentation: 1rem 2rem 0 2rem;\n --FuroUi5MediaSizeIndentationTop: 1rem;\n --FuroUi5MediaSizeIndentationRight: 2rem;\n --FuroUi5MediaSizeIndentationBottom: 0;\n --FuroUi5MediaSizeIndentationLeft: 2rem;\n }\n\n:host([media-size='M']) {\n --FuroUi5MediaSizeIndentation: 0.625rem 2rem 0 2rem;\n --FuroUi5MediaSizeIndentationTop: 0.625rem;\n --FuroUi5MediaSizeIndentationRight: 2rem;\n --FuroUi5MediaSizeIndentationBottom: 0;\n --FuroUi5MediaSizeIndentationLeft: 2rem;\n }\n\n:host([media-size='S']) {\n --FuroUi5MediaSizeIndentation: 0.625rem 1rem 0 1rem;\n --FuroUi5MediaSizeIndentationTop: 0.625rem;\n --FuroUi5MediaSizeIndentationRight: 1rem;\n --FuroUi5MediaSizeIndentationBottom: 0;\n --FuroUi5MediaSizeIndentationLeft: 1rem;\n }\n```", "name": "MediaSize", "members": [ { "kind": "field", "name": "HANDLE_RESIZE_DEBOUNCE_RATE", "static": true, "description": "Default debounce rate for resize updates.", "return": { "type": { "text": "number" } }, "readonly": true }, { "kind": "method", "name": "GetMediaSize", "static": true, "description": "Returns the media size.\n\nSizes:\nS,M,L,XL,XXl", "return": { "type": { "text": "String" } } }, { "kind": "field", "name": "BREAKPOINTS", "static": true, "readonly": true }, { "kind": "field", "name": "BREAKPOINTS_MAP", "static": true, "readonly": true }, { "kind": "method", "name": "DebounceBuilder", "static": true, "parameters": [ { "name": "func" }, { "name": "delay" } ], "description": "Generates a debounced function.", "return": { "type": { "text": "(function(...[*]): void)|*" } } } ] } ], "exports": [ { "kind": "js", "name": "MediaSize", "declaration": { "name": "MediaSize", "module": "src/lib/MediaSize.js" } } ] }, { "kind": "javascript-module", "path": "src/lib/Ui5LabelDataBinding.js", "declarations": [ { "kind": "class", "description": "Helper class for binding ui5 labeled elements", "name": "Ui5LabelDataBinding", "members": [ { "kind": "method", "name": "bindData", "static": true, "parameters": [ { "name": "element" }, { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "bind data for labeled element" }, { "kind": "method", "name": "isFatType", "static": true, "parameters": [ { "name": "field" } ], "description": "check whether it is a fat type", "return": { "type": { "text": "boolean" } } } ] } ], "exports": [ { "kind": "js", "name": "Ui5LabelDataBinding", "declaration": { "name": "Ui5LabelDataBinding", "module": "src/lib/Ui5LabelDataBinding.js" } } ] }, { "kind": "javascript-module", "path": "src/lib/init.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/lib/localeData.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/lib/ui5-icons.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/spaces/furo-ui5-launchpad-navigation.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-launchpad-navigation`\n\nIs used to navigate between spaces and pages.", "name": "FuroUi5LaunchpadNavigation", "members": [ { "kind": "method", "name": "_checkInitialTab", "parameters": [ { "name": "tab" } ], "description": "check if the current tab is selected", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "method", "name": "focus", "description": "focus Focuses the first tab", "privacy": "public" }, { "kind": "method", "name": "bindSpaces", "parameters": [ { "name": "fn" } ] }, { "kind": "method", "name": "_update", "parameters": [ { "name": "fn" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "_currentTab" } ], "events": [ { "description": "{Object} Fired when a page was selected. The object contains the page:id", "name": "page-selected" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Spaces navigation tabs", "tagName": "furo-ui5-launchpad-navigation", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5LaunchpadNavigation", "declaration": { "name": "FuroUi5LaunchpadNavigation", "module": "src/spaces/furo-ui5-launchpad-navigation.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-launchpad-navigation", "declaration": { "name": "FuroUi5LaunchpadNavigation", "module": "src/spaces/furo-ui5-launchpad-navigation.js" } } ] }, { "kind": "javascript-module", "path": "src/spaces/furo-ui5-launchpad-page-renderer.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-launchpad-page-renderer`\n Renders a page of a space.\n\n > **Hint**: when you build a custom tile, do not forget to trigger the tile-clicked event.", "name": "FuroUi5LaunchpadPageRenderer", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "injectPage", "parameters": [ { "name": "rawPage" } ], "description": "injectPage to render a page", "privacy": "public" }, { "kind": "method", "name": "focus", "description": "focus Focuses the first tile in the first section", "privacy": "public" } ], "events": [ { "type": { "text": "PointerEvent" }, "description": "Fired from the default tiles inside of the rendered pages.", "name": "tile-clicked" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "tile renderer", "tagName": "furo-ui5-launchpad-page-renderer", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5LaunchpadPageRenderer", "declaration": { "name": "FuroUi5LaunchpadPageRenderer", "module": "src/spaces/furo-ui5-launchpad-page-renderer.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-launchpad-page-renderer", "declaration": { "name": "FuroUi5LaunchpadPageRenderer", "module": "src/spaces/furo-ui5-launchpad-page-renderer.js" } } ] }, { "kind": "javascript-module", "path": "src/spaces/furo-ui5-launchpad-section-renderer.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-launchpad-section-renderer`\n Renders a section of a page", "name": "FuroUi5LaunchpadSectionRenderer", "members": [ { "kind": "method", "name": "bindSection", "parameters": [ { "name": "fieldNode" } ], "description": "bindSection Bind a fieldnode of type launchpad.Section", "privacy": "public" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "focus", "description": "focus Focuses the first tile in the first section", "privacy": "public" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "section renderer for a tile page", "tagName": "furo-ui5-launchpad-section-renderer", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5LaunchpadSectionRenderer", "declaration": { "name": "FuroUi5LaunchpadSectionRenderer", "module": "src/spaces/furo-ui5-launchpad-section-renderer.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-launchpad-section-renderer", "declaration": { "name": "FuroUi5LaunchpadSectionRenderer", "module": "src/spaces/furo-ui5-launchpad-section-renderer.js" } } ] }, { "kind": "javascript-module", "path": "src/spaces/furo-ui5-launchpad-tile-grid.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-launchpad-tile-grid`\n Layout component used in sections.", "name": "FuroUi5LaunchpadTileGrid", "members": [ { "kind": "method", "name": "_FBPReady" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "tile layout component", "tagName": "furo-ui5-launchpad-tile-grid", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5LaunchpadTileGrid", "declaration": { "name": "FuroUi5LaunchpadTileGrid", "module": "src/spaces/furo-ui5-launchpad-tile-grid.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-launchpad-tile-grid", "declaration": { "name": "FuroUi5LaunchpadTileGrid", "module": "src/spaces/furo-ui5-launchpad-tile-grid.js" } } ] }, { "kind": "javascript-module", "path": "src/subcomponents/furo-ui5-context-menu-item.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-context-menu-item` is a helper component for `furo-ui5-context-menu`.\n\nIt is not intended for direct usage", "name": "FuroUi5ContextMenuItem", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "menuNode" } ], "description": "Bind a single menu node with a `menu.Menuitem` signature." }, { "kind": "method", "name": "_openSub", "parameters": [ { "name": "byKeyboard", "description": "Boolean" } ], "description": "send event to open the submenu", "privacy": "private" }, { "kind": "method", "name": "_closeSub", "description": "The submenu item was set from the _openSub() event response", "privacy": "private" }, { "kind": "method", "name": "_selectItem", "description": "Select the item, furo-ui5-context-menu callback will be called", "privacy": "private" }, { "kind": "method", "name": "select", "parameters": [ { "name": "key" } ], "description": "selects the item if it does not have child elements", "privacy": "private" }, { "kind": "method", "name": "_mouseSelect", "description": "Open the item if it have children", "privacy": "private" }, { "kind": "method", "name": "index", "parameters": [ { "name": "i" } ], "description": "store the index for mouseover focus" }, { "kind": "method", "name": "setFocused", "description": "mark item as focused" }, { "kind": "method", "name": "unsetFocused", "description": "mark item as unfocused" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "'border'" }, { "kind": "field", "name": "focused", "privacy": "public", "type": { "text": "Boolean" }, "description": "focused state", "attribute": "focused", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "disabled state", "attribute": "disabled", "reflects": true } ], "events": [ { "type": { "text": "index" }, "description": " Fired when hovered with mouse", "name": "mousefocus" }, { "type": { "text": "menu: this.menuitem, initiator: this" }, "description": " Fired when submenu should be opened", "name": "opensub-requested" }, { "type": { "text": "item" }, "description": " Fired when item was selected", "name": "item-selected" } ], "attributes": [ { "name": "focused", "type": { "text": "Boolean" }, "description": "focused state", "fieldName": "focused" }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "disabled state", "fieldName": "disabled" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-context-menu-item", "summary": "context menu item", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ContextMenuItem", "declaration": { "name": "FuroUi5ContextMenuItem", "module": "src/subcomponents/furo-ui5-context-menu-item.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-context-menu-item", "declaration": { "name": "FuroUi5ContextMenuItem", "module": "src/subcomponents/furo-ui5-context-menu-item.js" } } ] }, { "kind": "javascript-module", "path": "src/subcomponents/furo-ui5-context-submenu.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-context-submenu` is a helper component for `furo-ui5-context-menu`.\n\nUse [`furo-ui5-context-menu`](?t=FuroUi5ContextMenu) to show a context menu.", "name": "FuroUi5ContextSubmenu", "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "init", "parameters": [ { "name": "e" }, { "name": "display" }, { "name": "byKeyboard" } ] }, { "kind": "method", "name": "hideMenu" }, { "kind": "method", "name": "triggerNavigation", "parameters": [ { "name": "key" } ], "description": "Interface for the furo navigation pad" }, { "kind": "field", "name": "borderDistance", "type": { "text": "number" }, "default": "48" }, { "kind": "field", "name": "depth", "privacy": "public", "type": { "text": "Number" }, "description": "Depth of the submenu", "attribute": "depth" } ], "attributes": [ { "name": "depth", "type": { "text": "Number" }, "description": "Depth of the submenu", "fieldName": "depth" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-context-submenu", "summary": "helper", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5ContextSubmenu", "declaration": { "name": "FuroUi5ContextSubmenu", "module": "src/subcomponents/furo-ui5-context-submenu.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-context-submenu", "declaration": { "name": "FuroUi5ContextSubmenu", "module": "src/subcomponents/furo-ui5-context-submenu.js" } } ] }, { "kind": "javascript-module", "path": "src/subcomponents/furo-ui5-message-container-item.js", "declarations": [ { "kind": "class", "description": "`furo-ui5-message-container-item`\ntodo Describe your element", "name": "FuroUi5MessageContainerItem", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldnode" } ], "description": "bindData Bind a fielNode", "privacy": "public" }, { "kind": "method", "name": "filter", "parameters": [ { "name": "kind" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "hidden", "privacy": "public", "type": { "text": "boolean" }, "attribute": "hidden", "reflects": true } ], "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "fieldName": "hidden" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "todo shortdescription", "tagName": "furo-ui5-message-container-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5MessageContainerItem", "declaration": { "name": "FuroUi5MessageContainerItem", "module": "src/subcomponents/furo-ui5-message-container-item.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-message-container-item", "declaration": { "name": "FuroUi5MessageContainerItem", "module": "src/subcomponents/furo-ui5-message-container-item.js" } } ] }, { "kind": "javascript-module", "path": "src/subcomponents/furo-ui5-table-row.js", "declarations": [ { "kind": "class", "description": "# INTERNAL COMPONENT\nThis is a helper component to send `tablerow-selected` event by clicking the row or pressing the enter on the row.", "name": "FuroUi5TableRow", "members": [ { "kind": "method", "name": "focus", "description": "focus this row" }, { "kind": "method", "name": "setData", "parameters": [ { "name": "d" } ] }, { "kind": "method", "name": "_select" }, { "kind": "method", "name": "_arrowDownPressed", "parameters": [ { "name": "event" } ] }, { "kind": "method", "name": "_arrowUpPressed" }, { "kind": "field", "name": "_data", "type": { "text": "object" }, "default": "{}" } ], "events": [ { "name": "ui5-selection-requested", "type": { "text": "Event" } }, { "name": "tablerow-selected", "type": { "text": "CustomEvent" } }, { "name": "arrow-down-on-last-row", "type": { "text": "CustomEvent" } }, { "name": "arrow-up-on-first-row", "type": { "text": "CustomEvent" } } ], "superclass": { "module": "src/subcomponents/furo-ui5-table-row.js" }, "tagName": "furo-ui5-table-row", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TableRow", "declaration": { "name": "FuroUi5TableRow", "module": "src/subcomponents/furo-ui5-table-row.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-table-row", "declaration": { "name": "FuroUi5TableRow", "module": "src/subcomponents/furo-ui5-table-row.js" } } ] }, { "kind": "javascript-module", "path": "src/subcomponents/furo-ui5-tree-item.js", "declarations": [ { "kind": "class", "description": "`furo-tree-item`\n/**\n# INTERNAL COMPONENT\nThis is a helper component to send `tablerow-selected` event by clicking the row or pressing the enter on the row.", "name": "FuroUi5TreeItem", "cssProperties": [ { "type": { "text": "N/A" }, "description": "tree indention level 1", "name": "--tree-indentation-1", "default": "16px" }, { "type": { "text": "N/A" }, "description": "tree indention level 2", "name": "--tree-indentation-2", "default": "32px" }, { "type": { "text": "N/A" }, "description": "tree indention level 3", "name": "--tree-indentation-3", "default": "48px" }, { "type": { "text": "N/A" }, "description": "tree indention level 4", "name": "--tree-indentation-4", "default": "56px" }, { "type": { "text": "N/A" }, "description": "tree indention level 5", "name": "--tree-indentation-5", "default": "64px" }, { "type": { "text": "N/A" }, "description": "tree indention level 6", "name": "--tree-indentation-6", "default": "72px" }, { "type": { "text": "N/A" }, "description": "tree indention level 7", "name": "--tree-indentation-7", "default": "80px" }, { "type": { "text": "N/A" }, "description": "tree indention level 8", "name": "--tree-indentation-8", "default": "88px" }, { "type": { "text": "N/A" }, "description": "tree indention level 9", "name": "--tree-indentation-9", "default": "92px" }, { "type": { "text": "N/A" }, "description": "tree indention level 10", "name": "--tree-indentation-10", "default": "96px" }, { "type": { "text": "N/A" }, "description": "tree indention level 11", "name": "--tree-indentation-11", "default": "100px" }, { "type": { "text": "N/A" }, "description": "tree indention level 12", "name": "--tree-indentation-12", "default": "104px" } ], "members": [ { "kind": "method", "name": "search", "parameters": [ { "name": "event" } ] }, { "kind": "method", "name": "_updateItem" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private" }, { "kind": "method", "name": "__addSearchListeners", "description": "add listeners for search matches and non matches", "privacy": "private" }, { "kind": "method", "name": "__addNodeSelectedListener" }, { "kind": "method", "name": "__addNodeFocusedListener", "description": "bring the focused element in the visible part of the screen (scroll)", "privacy": "private" }, { "kind": "field", "name": "hidden", "privacy": "public", "type": { "text": "boolean" }, "description": "Description", "default": "true", "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "isGroupLabel", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "is-group-label", "reflects": true }, { "kind": "field", "name": "indentation", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "_icon", "type": { "text": "string" }, "default": "'border'" }, { "kind": "field", "name": "focused", "privacy": "public", "type": { "text": "boolean" }, "attribute": "focused", "reflects": true }, { "kind": "field", "name": "searchmatch", "privacy": "public", "type": { "text": "boolean" }, "attribute": "searchmatch", "reflects": true }, { "kind": "field", "name": "inedit", "privacy": "public", "type": { "text": "boolean" }, "attribute": "inedit", "reflects": true }, { "kind": "field", "name": "haserror", "privacy": "public", "type": { "text": "boolean" }, "attribute": "haserror", "reflects": true }, { "kind": "field", "name": "selected", "privacy": "public", "type": { "text": "boolean" }, "attribute": "selected", "reflects": true }, { "kind": "field", "name": "noicon", "privacy": "public", "type": { "text": "boolean" }, "attribute": "noicon" } ], "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "description": "Description", "default": "true", "fieldName": "hidden" }, { "name": "focused", "type": { "text": "boolean" }, "fieldName": "focused" }, { "name": "searchmatch", "type": { "text": "boolean" }, "fieldName": "searchmatch" }, { "name": "inedit", "type": { "text": "boolean" }, "fieldName": "inedit" }, { "name": "haserror", "type": { "text": "boolean" }, "fieldName": "haserror" }, { "name": "selected", "type": { "text": "boolean" }, "fieldName": "selected" }, { "name": "noicon", "type": { "text": "boolean" }, "fieldName": "noicon" }, { "name": "is-group-label", "type": { "text": "boolean" }, "default": "false", "fieldName": "isGroupLabel" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "furo-ui5-tree-item", "summary": "tree item", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5TreeItem", "declaration": { "name": "FuroUi5TreeItem", "module": "src/subcomponents/furo-ui5-tree-item.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-tree-item", "declaration": { "name": "FuroUi5TreeItem", "module": "src/subcomponents/furo-ui5-tree-item.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-bool.js", "declarations": [ { "kind": "class", "description": "`cell-bool`\nThe cell-bool component displays a FieldNode of type `bool` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellBool", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type bool, furo.fat.Bool, google.wrapper.BoolValue", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-bool", "summary": "cell display renderer for `bool`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellBool", "declaration": { "name": "CellBool", "module": "src/typerenderer/cell-bool.js" } }, { "kind": "custom-element-definition", "name": "cell-bool", "declaration": { "name": "CellBool", "module": "src/typerenderer/cell-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-double.js", "declarations": [ { "kind": "class", "description": "`cell-double`\nThe cell-double component displays a FieldNode of type `double` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellDouble", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-double", "summary": "cell display renderer for `double`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellDouble", "declaration": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } }, { "kind": "custom-element-definition", "name": "cell-double", "declaration": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-float.js", "declarations": [ { "kind": "class", "description": "`cell-float`\nThe cell-float component displays a FieldNode of type `float` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFloat", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell", "summary": "cell display renderer for `float`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFloat", "declaration": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "custom-element-definition", "name": "cell-float", "declaration": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-bigdecimal.js", "declarations": [ { "kind": "class", "description": "The `cell-furo-bigdecimal` component displays a FieldNode of type `furo.BigDecimal` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat", "name": "CellFuroBigdecimal", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } } ], "superclass": { "name": "CellFloat", "module": "/src/typerenderer/cell-float.js" }, "tagName": "cell-furo-bigdecimal", "summary": "cell display renderer for type `furo.BigDecimal`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroBigdecimal", "declaration": { "name": "CellFuroBigdecimal", "module": "src/typerenderer/cell-furo-bigdecimal.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-bigdecimal", "declaration": { "name": "CellFuroBigdecimal", "module": "src/typerenderer/cell-furo-bigdecimal.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-bool.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-bool`\nThe cell-furo-fat-bool component displays a FieldNode of type `furo.fat.bool` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatBool", "members": [ { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private", "inheritedFrom": { "name": "CellBool", "module": "src/typerenderer/cell-bool.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type bool, furo.fat.Bool, google.wrapper.BoolValue", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellBool", "module": "src/typerenderer/cell-bool.js" } } ], "superclass": { "name": "CellBool", "module": "/src/typerenderer/cell-bool.js" }, "tagName": "cell-furo-fat-bool", "summary": "cell display renderer for `furo.fat.Bool`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroFatBool", "declaration": { "name": "CellFuroFatBool", "module": "src/typerenderer/cell-furo-fat-bool.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-bool", "declaration": { "name": "CellFuroFatBool", "module": "src/typerenderer/cell-furo-fat-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-double.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-double`\nThe cell-furo-fat-double component displays a FieldNode of type `furo.fat.Double` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatDouble", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } } ], "superclass": { "name": "CellDouble", "module": "/src/typerenderer/cell-double.js" }, "tagName": "cell-furo-fat-double", "summary": "cell display renderer for `furo.fat.Double`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroFatDouble", "declaration": { "name": "CellFuroFatDouble", "module": "src/typerenderer/cell-furo-fat-double.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-double", "declaration": { "name": "CellFuroFatDouble", "module": "src/typerenderer/cell-furo-fat-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-float.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-float`\nThe cell-furo-fat-float component displays a FieldNode of type `furo.fat.Float` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatFloat", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } } ], "superclass": { "name": "CellFloat", "module": "/src/typerenderer/cell-float.js" }, "tagName": "cell-furo-fat-float", "summary": "cell display renderer for `furo.fat.Float`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroFatFloat", "declaration": { "name": "CellFuroFatFloat", "module": "src/typerenderer/cell-furo-fat-float.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-float", "declaration": { "name": "CellFuroFatFloat", "module": "src/typerenderer/cell-furo-fat-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-int32.js", "declarations": [ { "kind": "class", "description": "`cell-int32`\nThe cell-int32 component displays a FieldNode of type `furo.fat.Int32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatInt32", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ], "superclass": { "name": "CellInt32", "module": "/src/typerenderer/cell-int32.js" }, "tagName": "cell-furo-fat-int32", "summary": "cell display renderer for `furo.fat.Int32`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroFatInt32", "declaration": { "name": "CellFuroFatInt32", "module": "src/typerenderer/cell-furo-fat-int32.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-int32", "declaration": { "name": "CellFuroFatInt32", "module": "src/typerenderer/cell-furo-fat-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-int64.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-int64`\nThe cell-furo-fat-int64 component displays a FieldNode of type `furo.fat.int64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatInt64", "superclass": { "name": "CellFuroFatInt32", "module": "/src/typerenderer/cell-furo-fat-int32.js" }, "tagName": "cell-furo-fat-int64", "summary": "cell display renderer for `furo.fat.Int64`", "customElement": true, "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellFuroFatInt64", "declaration": { "name": "CellFuroFatInt64", "module": "src/typerenderer/cell-furo-fat-int64.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-int64", "declaration": { "name": "CellFuroFatInt64", "module": "src/typerenderer/cell-furo-fat-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-string.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-string`\nThe cell-furo-fat-string component displays a FieldNode of type `furo.fat.String` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatString", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_updateMeta" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-furo-fat-string", "summary": "cell display renderer for `furo.fat.String`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroFatString", "declaration": { "name": "CellFuroFatString", "module": "src/typerenderer/cell-furo-fat-string.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-string", "declaration": { "name": "CellFuroFatString", "module": "src/typerenderer/cell-furo-fat-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-uint32.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-uint32`\nThe cell-furo-fat-uint32 component displays a FieldNode of type `furo.fat.Uint32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatUint32", "superclass": { "name": "CellFuroFatInt32", "module": "/src/typerenderer/cell-furo-fat-int32.js" }, "tagName": "cell-furo-fat-uint32", "summary": "cell display renderer for `furo.fat.Uint32`", "customElement": true, "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellFuroFatUint32", "declaration": { "name": "CellFuroFatUint32", "module": "src/typerenderer/cell-furo-fat-uint32.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-uint32", "declaration": { "name": "CellFuroFatUint32", "module": "src/typerenderer/cell-furo-fat-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-fat-uint64.js", "declarations": [ { "kind": "class", "description": "`cell-furo-fat-uint64`\nThe cell-furo-fat-uint64 component displays a FieldNode of type `furo.fat.uint64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroFatUint64", "superclass": { "name": "CellFuroFatInt64", "module": "/src/typerenderer/cell-furo-fat-int64.js" }, "tagName": "cell-furo-fat-uint64", "summary": "cell display renderer for `furo.fat.Uint64`", "customElement": true, "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellFuroFatUint64", "declaration": { "name": "CellFuroFatUint64", "module": "src/typerenderer/cell-furo-fat-uint64.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-fat-uint64", "declaration": { "name": "CellFuroFatUint64", "module": "src/typerenderer/cell-furo-fat-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-integerproperty.js", "declarations": [ { "kind": "class", "description": "`cell-furo-integerproperty`\nThe cell-furo-integerproperty component displays a FieldNode of type `furo.Integerproperty` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroIntegerproperty", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ], "superclass": { "name": "CellInt32", "module": "/src/typerenderer/cell-int32.js" }, "tagName": "cell-furo-integerproperty", "summary": "cell display renderer for `furo.Integerproperty`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroIntegerproperty", "declaration": { "name": "CellFuroIntegerproperty", "module": "src/typerenderer/cell-furo-integerproperty.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-integerproperty", "declaration": { "name": "CellFuroIntegerproperty", "module": "src/typerenderer/cell-furo-integerproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-link.js", "declarations": [ { "kind": "class", "description": "`cell-furo-link`\nThe cell-furo-link component displays a FieldNode of type `furo.Link` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroLink", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-furo-link", "summary": "cell display renderer for `furo.Link`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroLink", "declaration": { "name": "CellFuroLink", "module": "src/typerenderer/cell-furo-link.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-link", "declaration": { "name": "CellFuroLink", "module": "src/typerenderer/cell-furo-link.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-numberproperty.js", "declarations": [ { "kind": "class", "description": "`cell-furo-numberproperty`\nThe cell-furo-numberrproperty component displays a FieldNode of type `furo.Numberproperty` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroNumberproperty", "superclass": { "name": "CellFuroIntegerproperty", "module": "/src/typerenderer/cell-furo-integerproperty.js" }, "tagName": "cell-furo-numberproperty", "summary": "cell display renderer for `furo.Numberproperty`", "customElement": true, "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellFuroNumberproperty", "declaration": { "name": "CellFuroNumberproperty", "module": "src/typerenderer/cell-furo-numberproperty.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-numberproperty", "declaration": { "name": "CellFuroNumberproperty", "module": "src/typerenderer/cell-furo-numberproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-property-repeated.js", "declarations": [ { "kind": "class", "description": "`cell-furo-property-repeats`\nThe cell-furo-property-repeats component displays a FieldNode of type `furo.Property` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroPropertyRepeated", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe cell-furo-property-repeats is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_updateFieldList" }, { "kind": "field", "name": "elementList", "type": { "text": "array" }, "default": "[]" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "attribute": "noDataText" } ], "attributes": [ { "name": "noDataText", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-furo-property-repeated", "summary": "cell display renderer for `[] furo.Property`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroPropertyRepeated", "declaration": { "name": "CellFuroPropertyRepeated", "module": "src/typerenderer/cell-furo-property-repeated.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-property-repeated", "declaration": { "name": "CellFuroPropertyRepeated", "module": "src/typerenderer/cell-furo-property-repeated.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-property.js", "declarations": [ { "kind": "class", "description": "`cell-furo-property`\nThe cell-furo-property component displays a FieldNode of type `furo.Property` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroProperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe cell-furo-property is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_waitForType", "parameters": [ { "name": "field", "type": { "text": "FieldNode" } } ], "description": "furo.Property wait for @type information\nregisters event listener and creates the component as soon as the @type information is available.", "privacy": "private" }, { "kind": "method", "name": "_createConcreteType", "description": "Creates the concrete type specific renderer", "privacy": "private" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "default": "''", "attribute": "noDataText" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" } ], "attributes": [ { "name": "noDataText", "type": { "text": "string" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "default": "''", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-furo-property", "summary": "cell display renderer for `furo.Property`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroProperty", "declaration": { "name": "CellFuroProperty", "module": "src/typerenderer/cell-furo-property.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-property", "declaration": { "name": "CellFuroProperty", "module": "src/typerenderer/cell-furo-property.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-reference.js", "declarations": [ { "kind": "class", "description": "`cell-furo-reference`\nThe cell-furo-reference component displays a FieldNode of type `furo.Reference` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroReference", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatCell", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-furo-reference", "summary": "cell display renderer for `furo.Reference`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroReference", "declaration": { "name": "CellFuroReference", "module": "src/typerenderer/cell-furo-reference.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-reference", "declaration": { "name": "CellFuroReference", "module": "src/typerenderer/cell-furo-reference.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-stringoptionproperty.js", "declarations": [ { "kind": "class", "description": "`cell-furo-stringoptionproperty`\nThe cell-furo-numberrproperty component displays a FieldNode of type `furo.Stringoptionproperty` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroStringoptionproperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellString", "module": "src/typerenderer/cell-string.js" } } ], "superclass": { "name": "CellFuroStringproperty", "module": "/src/typerenderer/cell-furo-stringproperty.js" }, "tagName": "cell-furo-stringoptionproperty", "summary": "cell display renderer for `furo.Stringoptionproperty`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroStringoptionproperty", "declaration": { "name": "CellFuroStringoptionproperty", "module": "src/typerenderer/cell-furo-stringoptionproperty.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-stringoptionproperty", "declaration": { "name": "CellFuroStringoptionproperty", "module": "src/typerenderer/cell-furo-stringoptionproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-stringproperty.js", "declarations": [ { "kind": "class", "description": "`cell-furo-stringproperty`\nThe cell-furo-stringproperty component displays a FieldNode of type `furo.Stringproperty` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroStringproperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellString", "module": "src/typerenderer/cell-string.js" } } ], "superclass": { "name": "CellString", "module": "/src/typerenderer/cell-string.js" }, "tagName": "cell-furo-stringproperty", "summary": "cell display renderer for `furo.Stringproperty`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroStringproperty", "declaration": { "name": "CellFuroStringproperty", "module": "src/typerenderer/cell-furo-stringproperty.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-stringproperty", "declaration": { "name": "CellFuroStringproperty", "module": "src/typerenderer/cell-furo-stringproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-type-date.js", "declarations": [ { "kind": "class", "description": "`cell-furo-type-date`\nThe cell-furo-type-date component displays a FieldNode of type `furo.type.Date` in read only mode.\n\nif the field `display_name` is set, the component will use that value for the display.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroTypeDate", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellGoogleTypeDate", "module": "src/typerenderer/cell-google-type-date.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellGoogleTypeDate", "module": "src/typerenderer/cell-google-type-date.js" } }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldNode" }, { "name": "date" } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 31.12.2021", "return": { "type": { "text": "string" } }, "privacy": "private", "inheritedFrom": { "name": "CellGoogleTypeDate", "module": "src/typerenderer/cell-google-type-date.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellGoogleTypeDate", "module": "src/typerenderer/cell-google-type-date.js" } } ], "superclass": { "name": "CellGoogleTypeDate", "module": "/src/typerenderer/cell-google-type-date.js" }, "tagName": "cell-furo-type-date", "summary": "cell display renderer for `furo.type.Date`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroTypeDate", "declaration": { "name": "CellFuroTypeDate", "module": "src/typerenderer/cell-furo-type-date.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-type-date", "declaration": { "name": "CellFuroTypeDate", "module": "src/typerenderer/cell-furo-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-furo-type-money.js", "declarations": [ { "kind": "class", "description": "`cell-furo-type-money`\nThe cell-furo-type-money component displays a FieldNode of type `furo.type.Money` in read only mode.\n\nif the field `display_name` is set, the component will use that value for the display.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellFuroTypeMoney", "members": [ { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } }, { "kind": "method", "name": "_convertTypeToNumber", "static": true, "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "return": { "type": { "text": "number" } }, "privacy": "private", "inheritedFrom": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } }, { "kind": "field", "name": "_valueObject", "type": { "text": "{amount: number}" }, "privacy": "private", "default": "{ amount: Number.NaN }", "inheritedFrom": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } } ], "superclass": { "name": "CellGoogleTypeMoney", "module": "/src/typerenderer/cell-google-type-money.js" }, "tagName": "cell-furo-type-money", "summary": "cell display renderer for `furo.type.Money`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellFuroTypeMoney", "declaration": { "name": "CellFuroTypeMoney", "module": "src/typerenderer/cell-furo-type-money.js" } }, { "kind": "custom-element-definition", "name": "cell-furo-type-money", "declaration": { "name": "CellFuroTypeMoney", "module": "src/typerenderer/cell-furo-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-any.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-any`\nThe cell-google-protobuf-any component is a wrapper displays of type `google.protobuf.Any` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufAny", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe cell-google-protobuf-any is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_waitForType", "parameters": [ { "name": "field", "type": { "text": "FieldNode" } } ], "description": "google.protobuf.Any wait for @type information\nregisters event listener and creates the component as soon as the @type information is available.", "privacy": "private" }, { "kind": "method", "name": "_createContreteType", "description": "Creates the concrete type specific renderer", "privacy": "private" }, { "kind": "method", "name": "_warning", "description": "warns if diynamic component is not imported", "privacy": "private" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-protobuf-any", "summary": "cell display renderer for `google.protobuf.Any`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufAny", "declaration": { "name": "CellGoolgeProtobufAny", "module": "src/typerenderer/cell-google-protobuf-any.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-any", "declaration": { "name": "CellGoolgeProtobufAny", "module": "src/typerenderer/cell-google-protobuf-any.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-boolvalue.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-boolvalue`\nThe cell-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.BoolValue` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufBoolvalue", "superclass": { "name": "CellBool", "module": "/src/typerenderer/cell-bool.js" }, "tagName": "cell-google-protobuf-boolvalue", "summary": "cell display renderer for `google.protobuf.BoolValue`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type bool, furo.fat.Bool, google.wrapper.BoolValue", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellBool", "module": "src/typerenderer/cell-bool.js" } }, { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private", "inheritedFrom": { "name": "CellBool", "module": "src/typerenderer/cell-bool.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufBoolvalue", "declaration": { "name": "CellGoolgeProtobufBoolvalue", "module": "src/typerenderer/cell-google-protobuf-boolvalue.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-boolvalue", "declaration": { "name": "CellGoolgeProtobufBoolvalue", "module": "src/typerenderer/cell-google-protobuf-boolvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-doublevalue.js", "declarations": [ { "kind": "class", "description": "`cell-double`\nThe cell-double component displays a FieldNode of type `google.protobuf.DoubleValue` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoogleProtobufDoublevalue", "superclass": { "name": "CellDouble", "module": "/src/typerenderer/cell-double.js" }, "tagName": "cell-google-protobuf-doublevalue", "summary": "cell display renderer for `google.protobuf.DoubleValue`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellDouble", "module": "src/typerenderer/cell-double.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoogleProtobufDoublevalue", "declaration": { "name": "CellGoogleProtobufDoublevalue", "module": "src/typerenderer/cell-google-protobuf-doublevalue.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-doublevalue", "declaration": { "name": "CellGoogleProtobufDoublevalue", "module": "src/typerenderer/cell-google-protobuf-doublevalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-floatvalue.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-floatvalue`\nThe cell-google-protobuf-floatvalue component displays a FieldNode of type `google.protobuf.FloatValue` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufFloatvalue", "superclass": { "name": "CellFloat", "module": "/src/typerenderer/cell-float.js" }, "tagName": "cell-google-protobuf-", "summary": "cell display renderer for `google.protobuf.`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "CellFloat", "module": "src/typerenderer/cell-float.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufFloatvalue", "declaration": { "name": "CellGoolgeProtobufFloatvalue", "module": "src/typerenderer/cell-google-protobuf-floatvalue.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-floatvalue", "declaration": { "name": "CellGoolgeProtobufFloatvalue", "module": "src/typerenderer/cell-google-protobuf-floatvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-int32value.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-boolvalue`\nThe cell-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Int32Value` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufIn32value", "superclass": { "name": "CellInt32", "module": "/src/typerenderer/cell-int32.js" }, "tagName": "cell-google-protobuf-int32value", "summary": "cell display renderer for `google.protobuf.Int32Value`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufIn32value", "declaration": { "name": "CellGoolgeProtobufIn32value", "module": "src/typerenderer/cell-google-protobuf-int32value.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-int32value", "declaration": { "name": "CellGoolgeProtobufIn32value", "module": "src/typerenderer/cell-google-protobuf-int32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-int64value.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-boolvalue`\nThe cell-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Int64Value` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufIn64value", "superclass": { "name": "CellInt64", "module": "/src/typerenderer/cell-int64.js" }, "tagName": "cell-google-protobuf-int64value", "summary": "cell display renderer for `google.protobuf.Int64Value`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufIn64value", "declaration": { "name": "CellGoolgeProtobufIn64value", "module": "src/typerenderer/cell-google-protobuf-int64value.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-int64value", "declaration": { "name": "CellGoolgeProtobufIn64value", "module": "src/typerenderer/cell-google-protobuf-int64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-stringvalue.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-stringvalue`\nThe cell-google-protobuf-stringvalue component displays a FieldNode of type `google.protobuf.StringValue` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoogleProtobufStringvalue", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_updateValue", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-protobuf-stringvalue", "summary": "cell display renderer for `google.protobuf.StringValue`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoogleProtobufStringvalue", "declaration": { "name": "CellGoogleProtobufStringvalue", "module": "src/typerenderer/cell-google-protobuf-stringvalue.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-stringvalue", "declaration": { "name": "CellGoogleProtobufStringvalue", "module": "src/typerenderer/cell-google-protobuf-stringvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-timestamp.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-timestamp`\nThe cell-google-protobuf-timestamp component displays a FieldNode of type `google.prtobuf.Timestamp` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoogleProtobufTimestamp", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldValue" }, { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 15.01.2017, 02:30:15", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-protobuf-timestamp", "summary": "cell display renderer for `google.protobuf.Timestamp`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoogleProtobufTimestamp", "declaration": { "name": "CellGoogleProtobufTimestamp", "module": "src/typerenderer/cell-google-protobuf-timestamp.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-timestamp", "declaration": { "name": "CellGoogleProtobufTimestamp", "module": "src/typerenderer/cell-google-protobuf-timestamp.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-uint32value.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-boolvalue`\nThe cell-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Uint32Value` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufUin32value", "superclass": { "name": "CellUint32", "module": "/src/typerenderer/cell-uint32.js" }, "tagName": "cell-google-protobuf-uint32value", "summary": "cell display renderer for `google.protobuf.Uint32Value`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufUin32value", "declaration": { "name": "CellGoolgeProtobufUin32value", "module": "src/typerenderer/cell-google-protobuf-uint32value.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-uint32value", "declaration": { "name": "CellGoolgeProtobufUin32value", "module": "src/typerenderer/cell-google-protobuf-uint32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-protobuf-uint64value.js", "declarations": [ { "kind": "class", "description": "`cell-google-protobuf-boolvalue`\nThe cell-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Uint64Value` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeProtobufUin64value", "superclass": { "name": "CellUint64", "module": "/src/typerenderer/cell-uint64.js" }, "tagName": "cell-google-protobuf-uint64value", "summary": "cell display renderer for `google.protobuf.Uint64Value`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellGoolgeProtobufUin64value", "declaration": { "name": "CellGoolgeProtobufUin64value", "module": "src/typerenderer/cell-google-protobuf-uint64value.js" } }, { "kind": "custom-element-definition", "name": "cell-google-protobuf-uint64value", "declaration": { "name": "CellGoolgeProtobufUin64value", "module": "src/typerenderer/cell-google-protobuf-uint64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-type-color.js", "declarations": [ { "kind": "class", "description": "`cell-google-type-color`\nThe cell-google-type-color component displays a FieldNode of type `google.type.Color` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoolgeTypeColor", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_updateValue", "description": "update value properties rgb", "privacy": "private" }, { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private" }, { "kind": "field", "name": "_red", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_green", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_blue", "type": { "text": "string" }, "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-type-color", "summary": "cell display renderer for `google.type.Color`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoolgeTypeColor", "declaration": { "name": "CellGoolgeTypeColor", "module": "src/typerenderer/cell-google-type-color.js" } }, { "kind": "custom-element-definition", "name": "cell-google-type-color", "declaration": { "name": "CellGoolgeTypeColor", "module": "src/typerenderer/cell-google-type-color.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-type-date.js", "declarations": [ { "kind": "class", "description": "`cell-google-type-date`\nThe cell-google-type-date component displays a FieldNode of type `google.type.Date` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoogleTypeDate", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldNode" }, { "name": "date" } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 31.12.2021", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-type-date", "summary": "cell display renderer for `google.type.Date`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoogleTypeDate", "declaration": { "name": "CellGoogleTypeDate", "module": "src/typerenderer/cell-google-type-date.js" } }, { "kind": "custom-element-definition", "name": "cell-google-type-date", "declaration": { "name": "CellGoogleTypeDate", "module": "src/typerenderer/cell-google-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-type-money.js", "declarations": [ { "kind": "class", "description": "`cell-google-type-money`\nThe cell-google-type-money component displays a FieldNode of type `google.type.Money` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoogleTypeMoney", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_convertTypeToNumber", "static": true, "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "return": { "type": { "text": "number" } }, "privacy": "private" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_valueObject", "type": { "text": "{amount: number}" }, "privacy": "private", "default": "{ amount: Number.NaN }" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-type-money", "summary": "cell display renderer for `google.type.Money`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoogleTypeMoney", "declaration": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } }, { "kind": "custom-element-definition", "name": "cell-google-type-money", "declaration": { "name": "CellGoogleTypeMoney", "module": "src/typerenderer/cell-google-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-google-type-timeofday.js", "declarations": [ { "kind": "class", "description": "`cell-google-type-timeofday`\nThe cell-google-type-timeofday component displays a FieldNode of type `google.type.TimeOfDay` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellGoogleTypeTimeofday", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_convertDayTimeToString", "static": true, "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "convert date object to String according to local time string\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString\nExample output: 1:15:30 AM by en-US", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-google-type-timeofday", "summary": "cell display renderer for `google.type.TimeOfDay`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellGoogleTypeTimeofday", "declaration": { "name": "CellGoogleTypeTimeofday", "module": "src/typerenderer/cell-google-type-timeofday.js" } }, { "kind": "custom-element-definition", "name": "cell-google-type-timeofday", "declaration": { "name": "CellGoogleTypeTimeofday", "module": "src/typerenderer/cell-google-type-timeofday.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-int32.js", "declarations": [ { "kind": "class", "description": "`cell-int32`\nThe cell-int32 component displays a FieldNode of type `int32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellInt32", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-int32", "summary": "cell display renderer for `int32`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellInt32", "declaration": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "custom-element-definition", "name": "cell-int32", "declaration": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-int64.js", "declarations": [ { "kind": "class", "description": "`cell-int64`\nThe cell-int64 component displays a FieldNode of type `int64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellInt64", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatCell", "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-int64", "summary": "cell display renderer for `int64`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellInt64", "declaration": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "custom-element-definition", "name": "cell-int64", "declaration": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-string.js", "declarations": [ { "kind": "class", "description": "`cell-string`\nThe cell-string component displays a FieldNode of type `string` in read only mode.\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellString", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "cell-string", "summary": "cell display renderer for `string`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CellString", "declaration": { "name": "CellString", "module": "src/typerenderer/cell-string.js" } }, { "kind": "custom-element-definition", "name": "cell-string", "declaration": { "name": "CellString", "module": "src/typerenderer/cell-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-uint32.js", "declarations": [ { "kind": "class", "description": "`cell-uint32`\nThe cell-uint32 component displays a FieldNode of type `uint32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellUint32", "superclass": { "name": "CellInt32", "module": "/src/typerenderer/cell-int32.js" }, "tagName": "cell-uint32", "summary": "cell display renderer for `uint32`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt32", "module": "src/typerenderer/cell-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellUint32", "declaration": { "name": "CellUint32", "module": "src/typerenderer/cell-uint32.js" } }, { "kind": "custom-element-definition", "name": "cell-uint32", "declaration": { "name": "CellUint32", "module": "src/typerenderer/cell-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/cell-uint64.js", "declarations": [ { "kind": "class", "description": "`cell-uint64`\nThe cell-uint64 component displays a FieldNode of type `uint64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery cell-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CellUint64", "superclass": { "name": "CellInt64", "module": "/src/typerenderer/cell-int64.js" }, "tagName": "cell-uint64", "summary": "cell display renderer for `uint64`", "customElement": true, "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "method", "name": "_formatCell", "privacy": "private", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "CellInt64", "module": "src/typerenderer/cell-int64.js" } } ] } ], "exports": [ { "kind": "js", "name": "CellUint64", "declaration": { "name": "CellUint64", "module": "src/typerenderer/cell-uint64.js" } }, { "kind": "custom-element-definition", "name": "cell-uint64", "declaration": { "name": "CellUint64", "module": "src/typerenderer/cell-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-bool.js", "declarations": [ { "kind": "class", "description": "`celledit-bool` is a `celledit` context renderer.\n\nIt uses furo-ui5-checkbox-input as the renderer", "name": "CelleditBool", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "check", "description": "Checks the checkbox and updates the value", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "uncheck", "description": "Unhecks the checkbox and updates the value", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.", "privacy": "public", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the checkbox changes.", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_setValueState", "parameters": [ { "name": "valueState" } ], "description": "Updates the valueState\nui5 checkbox has only 3 states: Warning, Error, and None (default) https://sap.github.io/ui5-webcomponents/playground/components/CheckBox/", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_resetValueState", "description": "reset to previous value state", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "text" }, { "name": "placeholder", "type": { "text": "String" } } ], "description": "overwrite onFnaLabelChanged function\nlabel is mapped to text", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly", "type": { "text": "Boolean" } } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "string" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "'None'", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{}" }, "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "{label: undefined}" }, "privacy": "private", "default": "{\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "{readonly: undefined, disabled: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, text: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n disabled: null,\n text: null,\n indeterminate: null,\n checked: null,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ], "superclass": { "name": "FuroUi5CheckboxInput", "module": "/src/furo-ui5-checkbox-input.js" }, "tagName": "celledit-bool", "summary": "celledit renderer for `bool`", "customElement": true, "events": [ { "type": { "text": "Boolean" }, "description": " Fired when the checkbox checked state changes.", "name": "change", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "type": { "text": "Boolean" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditBool", "declaration": { "name": "CelleditBool", "module": "src/typerenderer/celledit-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-double.js", "declarations": [ { "kind": "class", "description": "`celledit-double` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditDouble", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-double", "summary": "celledit renderer for `double`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditDouble", "declaration": { "name": "CelleditDouble", "module": "src/typerenderer/celledit-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-float.js", "declarations": [ { "kind": "class", "description": "`celledit-float` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFloat", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-float", "summary": "celledit renderer for `float`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFloat", "declaration": { "name": "CelleditFloat", "module": "src/typerenderer/celledit-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-bigdecimal.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditFuroBigdecimal", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-bigdecimal", "summary": "celledit renderer for type `furo.BigDecimal`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroBigdecimal", "declaration": { "name": "CelleditFuroBigdecimal", "module": "src/typerenderer/celledit-furo-bigdecimal.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-bool.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-bool` is a `celledit` context renderer.\n\nIt uses furo-ui5-checkbox-input as the renderer", "name": "CelleditFuroFatBool", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "check", "description": "Checks the checkbox and updates the value", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "uncheck", "description": "Unhecks the checkbox and updates the value", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.", "privacy": "public", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the checkbox changes.", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_setValueState", "parameters": [ { "name": "valueState" } ], "description": "Updates the valueState\nui5 checkbox has only 3 states: Warning, Error, and None (default) https://sap.github.io/ui5-webcomponents/playground/components/CheckBox/", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_resetValueState", "description": "reset to previous value state", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "text" }, { "name": "placeholder", "type": { "text": "String" } } ], "description": "overwrite onFnaLabelChanged function\nlabel is mapped to text", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly", "type": { "text": "Boolean" } } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "string" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "'None'", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{}" }, "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "{label: undefined}" }, "privacy": "private", "default": "{\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "{readonly: undefined, disabled: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, text: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n disabled: null,\n text: null,\n indeterminate: null,\n checked: null,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ], "superclass": { "name": "CelleditBool", "module": "/src/typerenderer/celledit-bool.js" }, "tagName": "celledit-furo-fat-bool", "summary": "celledit renderer for `bool`", "customElement": true, "events": [ { "type": { "text": "Boolean" }, "description": " Fired when the checkbox checked state changes.", "name": "change", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "type": { "text": "Boolean" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatBool", "declaration": { "name": "CelleditFuroFatBool", "module": "src/typerenderer/celledit-furo-fat-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-double.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-double` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroFatDouble", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-fat-double", "summary": "celledit renderer for `furo.fat.Double`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatDouble", "declaration": { "name": "CelleditFuroFatDouble", "module": "src/typerenderer/celledit-furo-fat-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-float.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-float` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroFatFloat", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-fat-float", "summary": "celledit renderer for `furo.fat.Float`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatFloat", "declaration": { "name": "CelleditFuroFatFloat", "module": "src/typerenderer/celledit-furo-fat-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-int32.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-int32` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroFatInt32", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-fat-int32", "summary": "celledit renderer for `furo.fat.Int32`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatInt32", "declaration": { "name": "CelleditFuroFatInt32", "module": "src/typerenderer/celledit-furo-fat-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-int64.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-int64` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroFatInt64", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-fat-int64", "summary": "celledit renderer for `furo.fat.Int64`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatInt64", "declaration": { "name": "CelleditFuroFatInt64", "module": "src/typerenderer/celledit-furo-fat-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-string.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-string` is a `celledit` context renderer.\n\nIt uses furo-ui5-text-input as the renderer", "name": "CelleditFuroFatString", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_mapOptionsToSuggestions", "parameters": [ { "name": "repeaterNode" } ], "description": "Maps a RepeaterNode according the mapping definition to an ui5-suggestion-item.\nSupported fields are:\n- text\n- description", "return": { "type": { "text": "*[]" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list.\nThe items are displayed as suggestion items.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_createHandler", "parameters": [ { "name": "wait" }, { "name": "immediate" } ], "description": "Internal create of debounce handler function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'Text'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_optionList", "type": { "text": "{}" }, "description": "Internal pointer to the options RepeaterNode", "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the text of the\noption items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "wait", "type": { "text": "number" }, "description": "Debounce time in milliseconds\nDefault value: 250", "default": "250", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n icon: undefined, // updates the icon\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n maxlength: null,\n wait: 250,\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_debounce", "description": "Debounce function, taken from Underscore.js", "parameters": [ { "name": "func" }, { "name": "wait" }, { "name": "immediate" } ], "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "default": "function debounce(func, wait, immediate) {\n let timeout;\n return function debouncer() {\n const context = this;\n // eslint-disable-next-line prefer-rest-params\n const args = arguments;\n const later = function applyLater() {\n timeout = null;\n if (!immediate) func.apply(context, args);\n };\n const callNow = immediate && !timeout;\n clearTimeout(timeout);\n timeout = setTimeout(later, wait);\n if (callNow) func.apply(context, args);\n };\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ], "superclass": { "name": "CelleditString", "module": "/src/typerenderer/celledit-string.js" }, "tagName": "celledit-furo-fat-string", "summary": "celledit renderer for `furo.fat.String`", "customElement": true, "events": [ { "name": "search-requested", "type": { "text": "value" }, "description": "Fired when typing in input (debounced, default 250ms)", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatString", "declaration": { "name": "CelleditFuroFatString", "module": "src/typerenderer/celledit-furo-fat-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-uint32.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-uint32` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroFatUint32", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-fat-uint32", "summary": "celledit renderer for `furo.fat.Uint32`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatUint32", "declaration": { "name": "CelleditFuroFatUint32", "module": "src/typerenderer/celledit-furo-fat-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-fat-uint64.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-fat-uint64` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroFatUint64", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-fat-uint64", "summary": "celledit renderer for `furo.fat.Uint64`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroFatUint64", "declaration": { "name": "CelleditFuroFatUint64", "module": "src/typerenderer/celledit-furo-fat-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-integerproperty.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-integerproperty` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroIntegerproperty", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-integerproperty", "summary": "celledit renderer for `furo.Integerproperty`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroIntegerproperty", "declaration": { "name": "CelleditFuroIntegerproperty", "module": "src/typerenderer/celledit-furo-integerproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-link.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-link`\nThe celledit-furo-link component displays a FieldNode of type `furo.Link` in read only mode.\n\nEvery celledit-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CelleditFuroLink", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "celledit-furo-link", "summary": "celledit renderer for `furo.Link`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CelleditFuroLink", "declaration": { "name": "CelleditFuroLink", "module": "src/typerenderer/celledit-furo-link.js" } }, { "kind": "custom-element-definition", "name": "celledit-furo-link", "declaration": { "name": "CelleditFuroLink", "module": "src/typerenderer/celledit-furo-link.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-numberproperty.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-numberproperty` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditFuroNumberproperty", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-furo-inumberproperty", "summary": "celledit renderer for `furo.INumberproperty`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroNumberproperty", "declaration": { "name": "CelleditFuroNumberproperty", "module": "src/typerenderer/celledit-furo-numberproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-property-repeated.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-property-repeats`\nThe celledit-furo-property-repeats component displays a FieldNode of type `furo.Property` in read only mode.\n\nEvery celledit-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CelleditFuroPropertyRepeated", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe celledit-furo-property-repeats is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_updateFieldList" }, { "kind": "field", "name": "elementList", "type": { "text": "array" }, "default": "[]" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "attribute": "noDataText" } ], "attributes": [ { "name": "noDataText", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "celledit-furo-property-repeated", "summary": "celledit renderer for `[] furo.Property`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CelleditFuroPropertyRepeated", "declaration": { "name": "CelleditFuroPropertyRepeated", "module": "src/typerenderer/celledit-furo-property-repeated.js" } }, { "kind": "custom-element-definition", "name": "celledit-furo-property-repeated", "declaration": { "name": "CelleditFuroPropertyRepeated", "module": "src/typerenderer/celledit-furo-property-repeated.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-property.js", "declarations": [ { "kind": "class", "description": "`celledit-furo-property`\nThe celledit-furo-property component displays a FieldNode of type `furo.Property` in read only mode.\n\nEvery celledit-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CelleditFuroProperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe celledit-furo-property is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_waitForType", "parameters": [ { "name": "field" } ], "description": "furo.Property wait for @type information\nregisters event listener and creates the component as soon as the @type information is available.", "privacy": "private" }, { "kind": "method", "name": "_createConcreteType", "description": "Creates the concrete type specific renderer", "privacy": "private" }, { "kind": "method", "name": "_warning" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "default": "''", "attribute": "noDataText" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" } ], "attributes": [ { "name": "noDataText", "type": { "text": "string" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "default": "''", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "celledit-furo-property", "summary": "celledit renderer for `furo.Property`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CelleditFuroProperty", "declaration": { "name": "CelleditFuroProperty", "module": "src/typerenderer/celledit-furo-property.js" } }, { "kind": "custom-element-definition", "name": "celledit-furo-property", "declaration": { "name": "CelleditFuroProperty", "module": "src/typerenderer/celledit-furo-property.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-reference.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditFuroReference", "superclass": { "name": "FuroUi5ReferenceSearch", "module": "/src/furo-ui5-reference-search.js" }, "tagName": "celledit-furo-reference", "summary": "celledit renderer for `furo.Reference`", "customElement": true, "attributes": [ { "name": "search-response-path", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "fieldName": "searchResponsePath", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "fieldName": "valueFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "extended-value-field-path", "type": { "text": "string" }, "description": "Path to response value item of the extended search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "fieldName": "extendedValueFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "extended-display-field-path", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "fieldName": "extendedDisplayFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "service", "type": { "text": "string" }, "description": "setter for the service", "parameters": [ { "name": "service" } ], "default": "''", "fieldName": "service", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "method", "type": { "text": "String" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "fieldName": "method", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "disable-search-list", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "fieldName": "disableSearchList", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "no-data-text", "type": { "text": "string" }, "description": "hint text when result not found by search", "default": "'no result found'", "fieldName": "noDataText", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "Overrides the required value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "Overrides the hint text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "fieldName": "placeholder", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "label", "type": { "text": "string" }, "description": "Overrides the label text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "min-term-length", "type": { "text": "number" }, "description": "The minimal length of search term to trigger a search.", "default": "2", "fieldName": "minTermLength", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "max-items-to-display", "type": { "text": "number" }, "description": "The maximal number of items to display.\n\nThis value will be set as page-size query-param for the backend.\n\nIf the response contains hts information with rel *next* a \"load more\" button will be displayed at the end\nof the list.", "default": "8", "fieldName": "maxItemsToDisplay", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "search-on-enter-only", "type": { "text": "Boolean" }, "description": "Enable this, to avoid the automatic triggering of \"search\".\n\nThe user have to press enter to trigger the search. Min-term-length is respected.", "fieldName": "searchOnEnterOnly", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "Overrides the readonly value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "Disable", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "busy", "type": { "text": "Boolean" }, "description": "This is used to activate the loading indicator.", "fieldName": "busy", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "value-state", "type": { "text": "string" }, "description": "Value State of the input field", "default": "'None'", "fieldName": "valueState", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "debounce-timeout", "type": { "text": "number" }, "description": "wait for this time between keystrokes to trigger a search to the service", "default": "250", "fieldName": "debounceTimeout", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "name": "extended-searcher", "type": { "text": "String" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "fieldName": "extendedSearcher", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } } ], "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "This is triggered from the FieldNodeAdapter when the data has changed", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: can be a scalar type or any complex type with 'id','display_name' signature or use\nthe furo.Reference type.", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_updateField", "description": "This is used to update the FieldNodeAdapter", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "service", "privacy": "public", "type": { "text": "string" }, "description": "setter for the service", "parameters": [ { "name": "service" } ], "default": "''", "attribute": "service", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_appendExtendedSearcher", "description": "Appends the searcher", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_FBPReady", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "focus", "description": "focuses the input field", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "triggerSearch", "parameters": [ { "name": "term" } ], "description": "triggerSearch search for a term", "privacy": "public", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_closeList", "description": "Closes the list", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_showList", "description": "Opens the list and selects the last selected item", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "Update the placeholder from the FNA", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "label" } ], "description": "Update the label from the FNA", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "Updates the readonly state from FNA", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "Updates the required constraint from the FNA", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "Updates the error state from FNA", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "Clears the error state from FNA", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updater for the value state and message", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "reset to previous value state\ntodo: check that this will not toggle between information and error", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\n\nFollowing attributes can be set:\n- `value-state`\n- `value-state-message`\n- `icon`\n- `placeholder`\n- `label`\n- `required`\n- `readonly`\n- `disabled`\n\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "htsIn", "parameters": [ { "name": "hts" } ], "description": "htsIn sets the HTS for the collection-agent.\n\nThis is only needed if you want to have fine grained control over the hts", "privacy": "public", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "qpIn", "parameters": [ { "name": "qp" } ], "description": "qpIn Use this to set query params manualy", "privacy": "public", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "setFilter", "parameters": [ { "name": "filter" } ], "description": "Sets the filter.\nHint: use the FieldNode._base64 property to send complex objects as a filter and decode it on the server side\nor do btoa(JSON.stringify(FILTER))", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "method", "name": "clearResultList", "description": "clears the result set", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "searchResponsePath", "privacy": "public", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "attribute": "search-response-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "attribute": "value-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "extendedValueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the extended search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "attribute": "extended-value-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "extendedDisplayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "attribute": "extended-display-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "maxItemsToDisplay", "privacy": "public", "type": { "text": "number" }, "description": "The maximal number of items to display.\n\nThis value will be set as page-size query-param for the backend.\n\nIf the response contains hts information with rel *next* a \"load more\" button will be displayed at the end\nof the list.", "default": "8", "attribute": "max-items-to-display", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "value", "type": { "text": "object" }, "default": "{ id: '', display_name: '' }", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "minTermLength", "privacy": "public", "type": { "text": "number" }, "description": "The minimal length of search term to trigger a search.", "default": "2", "attribute": "min-term-length", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "debounceTimeout", "privacy": "public", "type": { "text": "number" }, "description": "wait for this time between keystrokes to trigger a search to the service", "default": "250", "attribute": "debounce-timeout", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Overrides the hint text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "attribute": "placeholder", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "Overrides the label text from the **specs**.\n\nUse with caution, normally the specs defines this value.", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "string" }, "description": "hint text when result not found by search", "default": "'no result found'", "attribute": "no-data-text", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "_hasmore", "type": { "text": "string" }, "privacy": "private", "default": "'None'", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "_hasExtendedSearcher", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "disableSearchList", "privacy": "public", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "attribute": "disable-search-list", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "valueState", "privacy": "public", "type": { "text": "string" }, "description": "Value State of the input field", "default": "'None'", "attribute": "value-state", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n label: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "method", "privacy": "public", "type": { "text": "String" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "attribute": "method", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "Overrides the required value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "attribute": "required", "reflects": true, "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "searchOnEnterOnly", "privacy": "public", "type": { "text": "Boolean" }, "description": "Enable this, to avoid the automatic triggering of \"search\".\n\nThe user have to press enter to trigger the search. Min-term-length is respected.", "attribute": "search-on-enter-only", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "Overrides the readonly value from the **specs**.\n\nUse with caution, normally the specs defines this value.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "Disable", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "busy", "privacy": "public", "type": { "text": "Boolean" }, "description": "This is used to activate the loading indicator.", "attribute": "busy", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "kind": "field", "name": "extendedSearcher", "privacy": "public", "type": { "text": "String" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "attribute": "extended-searcher", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } } ], "events": [ { "type": { "text": "`Object` the complete item" }, "description": " Fired when a item was selected from the list.", "name": "item-selected", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "type": { "text": "`text`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5ReferenceSearch", "module": "src/furo-ui5-reference-search.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroReference", "declaration": { "name": "CelleditFuroReference", "module": "src/typerenderer/celledit-furo-reference.js" } }, { "kind": "custom-element-definition", "name": "celledit-furo-reference", "declaration": { "name": "CelleditFuroReference", "module": "src/typerenderer/celledit-furo-reference.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-stringoptionproperty.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditFuroStringoptionproperty", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `required`,`readonly`,`disabled`, `value-field-path`, `display-field-path`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list.", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "setOptions", "parameters": [ { "name": "arr" }, { "description": "raw data array", "name": "rawJson", "optional": true } ], "description": "inject raw data as options", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Overridden bindData of FieldNodeAdapter", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "Overridden onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "Overridden onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Overridden onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "Overridden onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "Overridden onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "Overridden onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "selectOptionById", "parameters": [ { "name": "id", "description": "must match the data", "type": { "text": "*" } } ], "description": "Selects an option by id.\nThe id field must be comparable.", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_updateOptions", "parameters": [ { "name": "list" } ], "description": "Maps and updates array of option", "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "e" } ], "description": "Handler function for the select value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "activeFieldBinding", "type": { "text": "boolean" }, "description": "Flag to indicate if a field is attached\nDefault: false", "default": "false", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "idFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "valueFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.\ndefault: id\nThis attribute is related to the option list. optionList[selected].valueFieldPath ==> bound FieldNode", "default": "'id'", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "boundFieldIdPath", "type": { "text": "string" }, "description": "Defines the id field path of the bound FieldNode.\nPoint-separated path to the field\nMust be set if a data binding is specified with a complex type.\ndefault: id\nThis attribute is related to the bound FieldNode.", "default": "'id'", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_optionList", "type": { "text": "*[]" }, "description": "Internal RepeaterNode\nDefines the ui5-select options.\nNote: Only one selected option is allowed. If more than one option is defined as selected, the last one would be considered as the selected one.", "privacy": "private", "default": "[]", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n }", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in furo-ui5-select components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n 'id-field-path': 'id',\n 'value-field-path': 'id',\n 'display-field-path': 'display_name',\n 'bound-field-id-path': 'id',\n }", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } } ], "superclass": { "name": "FuroUi5Select", "module": "/src/furo-ui5-select.js" }, "tagName": "celledit-furo-stringoptionproperty", "summary": "celledit renderer for `furo.Stringoptionproperty`", "customElement": true, "events": [ { "name": "options-updated", "type": { "text": "optionNodeList" }, "description": "Fired after the option list was rebuilt.", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "type": { "text": "selectedOption" }, "description": "Fired when the item of the dropdown list is selected.", "name": "item-selected", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } }, { "type": { "text": "selectedOption" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5Select", "module": "src/furo-ui5-select.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroStringoptionproperty", "declaration": { "name": "CelleditFuroStringoptionproperty", "module": "src/typerenderer/celledit-furo-stringoptionproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-stringproperty.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditFuroStringproperty", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_mapOptionsToSuggestions", "parameters": [ { "name": "repeaterNode" } ], "description": "Maps a RepeaterNode according the mapping definition to an ui5-suggestion-item.\nSupported fields are:\n- text\n- description", "return": { "type": { "text": "*[]" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list.\nThe items are displayed as suggestion items.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_createHandler", "parameters": [ { "name": "wait" }, { "name": "immediate" } ], "description": "Internal create of debounce handler function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'Text'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_optionList", "type": { "text": "{}" }, "description": "Internal pointer to the options RepeaterNode", "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the text of the\noption items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "wait", "type": { "text": "number" }, "description": "Debounce time in milliseconds\nDefault value: 250", "default": "250", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n icon: undefined, // updates the icon\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n maxlength: null,\n wait: 250,\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_debounce", "description": "Debounce function, taken from Underscore.js", "parameters": [ { "name": "func" }, { "name": "wait" }, { "name": "immediate" } ], "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "default": "function debounce(func, wait, immediate) {\n let timeout;\n return function debouncer() {\n const context = this;\n // eslint-disable-next-line prefer-rest-params\n const args = arguments;\n const later = function applyLater() {\n timeout = null;\n if (!immediate) func.apply(context, args);\n };\n const callNow = immediate && !timeout;\n clearTimeout(timeout);\n timeout = setTimeout(later, wait);\n if (callNow) func.apply(context, args);\n };\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ], "superclass": { "name": "CelleditString", "module": "/src/typerenderer/celledit-string.js" }, "tagName": "celledit-furo-stringproperty", "summary": "celledit renderer for `furo.Stringproperty`", "customElement": true, "events": [ { "name": "search-requested", "type": { "text": "value" }, "description": "Fired when typing in input (debounced, default 250ms)", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroStringproperty", "declaration": { "name": "CelleditFuroStringproperty", "module": "src/typerenderer/celledit-furo-stringproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-type-date.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditFuroTypeDate", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `string`, `furo.type.Date`, `google.type.Date`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `furo.type.Date`, `google.type.Date`", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nAttributes that can be se are `value-state`, `placeholder`, `required`,`readonly`,`disabled` `max-date`, `min-date`, `format-pattern`,\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "description": "The format pattern for the date.", "default": "''", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{min: undefined, readonly: undefined, max: undefined, pattern: undefined, placeholder: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{required: undefined}" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{minDate: null, readonly: null, formatPattern: null, disabled: null, maxDate: null, placeholder: null, required: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } } ], "superclass": { "name": "FuroUi5DatePicker", "module": "/src/furo-ui5-date-picker.js" }, "tagName": "celledit-furo-type-date", "summary": "celledit renderer for `furo.type.Date`", "customElement": true, "events": [ { "type": { "text": "Date" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "type": { "text": "Date" }, "description": "-Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroTypeDate", "declaration": { "name": "CelleditFuroTypeDate", "module": "src/typerenderer/celledit-furo-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-furo-type-money.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditFuroTypeMoney", "superclass": { "name": "FuroUi5MoneyInput", "module": "/src/furo-ui5-money-input.js" }, "tagName": "celledit-furo-type-money", "summary": "celledit renderer for `furo.type.Money`", "customElement": true, "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ], "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type `google.type.Money`", "type": { "text": "FieldNode" } } ], "description": "Binds a fieldNode.\n\nSupported types: `google.type.Money`", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nAttributes that can be se are `required`,`readonly`,`disabled` ,\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Checks if options.flags has an entry `currency_list`\nIn this case the option list is applied to the currency field as suggestion items.\n\nIf you use a static option definition in the type specification (furo), you can\ndefine the list as follows:\n\n```\noptions:\n flags:\n - currency_list\n list:\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: Swiss francs (CHF)\n id: CHF\n selected: false\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: Euro (EUR)\n id: EUR\n selected: false\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: US Dollar (USD)\n id: USD\n selected: false\n```", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_FBPReady", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_convertDataToMoneyObj", "parameters": [ { "name": "currency" }, { "name": "amount" }, { "name": "obj" } ], "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_updateField", "parameters": [ { "name": "value" } ], "description": "update amount field\nOne issue with number inputs is that their step size is 1 by default.\nIf you try to enter a number with a decimal (such as \"1.0\"), it will be considered invalid.\nIf you want to enter a value that requires decimals, you'll need to reflect this in the step value\n(e.g. step=\"0.01\" to allow decimals to two decimal places).", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_getElements", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{readonly: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{required: undefined}" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, required: null}" }, "description": "A list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ], "events": [ { "type": { "text": "Money" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditFuroTypeMoney", "declaration": { "name": "CelleditFuroTypeMoney", "module": "src/typerenderer/celledit-furo-type-money.js" } }, { "kind": "custom-element-definition", "name": "celledit-furo-type-money", "declaration": { "name": "CelleditFuroTypeMoney", "module": "src/typerenderer/celledit-furo-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-any.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-any`\nThe celledit-google-protobuf-any component is a wrapper displays of type `google.protobuf.Any` in read only mode.\n\nEvery celledit-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "CelleditGoolgeProtobufAny", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe celledit-google-protobuf-any is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_waitForType", "parameters": [ { "name": "field", "description": "of type google.protobuf.Any", "type": { "text": "FieldNode" } } ], "description": "google.protobuf.Any wait for @type information\nregisters event listener and creates the component as soon as the @type information is available.", "privacy": "private" }, { "kind": "method", "name": "_createContreteType", "description": "Creates the concrete type specific renderer", "privacy": "private" }, { "kind": "method", "name": "_warning", "description": "warns if diynamic component is not imported", "privacy": "private" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "celledit-google-protobuf-any", "summary": "celledit renderer for `google.protobuf.Any`", "customElement": true } ], "exports": [ { "kind": "js", "name": "CelleditGoolgeProtobufAny", "declaration": { "name": "CelleditGoolgeProtobufAny", "module": "src/typerenderer/celledit-google-protobuf-any.js" } }, { "kind": "custom-element-definition", "name": "celledit-google-protobuf-any", "declaration": { "name": "CelleditGoolgeProtobufAny", "module": "src/typerenderer/celledit-google-protobuf-any.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-boolvalue.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-boolvalue` is a `celledit` context renderer.\n\nIt uses furo-ui5-checkbox-input as the renderer", "name": "CelleditGoogleProtobufBoolvalue", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "check", "description": "Checks the checkbox and updates the value", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "uncheck", "description": "Unhecks the checkbox and updates the value", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.", "privacy": "public", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the checkbox changes.", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_setValueState", "parameters": [ { "name": "valueState" } ], "description": "Updates the valueState\nui5 checkbox has only 3 states: Warning, Error, and None (default) https://sap.github.io/ui5-webcomponents/playground/components/CheckBox/", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "_resetValueState", "description": "reset to previous value state", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaLabelChanged", "parameters": [ { "name": "text" }, { "name": "placeholder", "type": { "text": "String" } } ], "description": "overwrite onFnaLabelChanged function\nlabel is mapped to text", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly", "type": { "text": "Boolean" } } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "string" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "'None'", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{}" }, "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "{label: undefined}" }, "privacy": "private", "default": "{\n label: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "{readonly: undefined, disabled: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, text: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n disabled: null,\n text: null,\n indeterminate: null,\n checked: null,\n }", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ], "superclass": { "name": "CelleditBool", "module": "/src/typerenderer/celledit-bool.js" }, "tagName": "celledit-google-protobuf-boolvalue", "summary": "celledit renderer for `google.protobuf.BoolValue`", "customElement": true, "events": [ { "type": { "text": "Boolean" }, "description": " Fired when the checkbox checked state changes.", "name": "change", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } }, { "type": { "text": "Boolean" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5CheckboxInput", "module": "src/furo-ui5-checkbox-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleProtobufBoolvalue", "declaration": { "name": "CelleditGoogleProtobufBoolvalue", "module": "src/typerenderer/celledit-google-protobuf-boolvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-doublevalue.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-doublevalue` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditGoogleProtobufDoublevalue", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-google-protobuf-doublevalue", "summary": "celledit renderer for `google.protobuf.Double`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleProtobufDoublevalue", "declaration": { "name": "CelleditGoogleProtobufDoublevalue", "module": "src/typerenderer/celledit-google-protobuf-doublevalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-floatvalue.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-floatvalue` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditGoolgeProtobufFloatvalue", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-google-protobuf-floatvalue", "summary": "celledit renderer for `google.protobuf.FloatValue`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoolgeProtobufFloatvalue", "declaration": { "name": "CelleditGoolgeProtobufFloatvalue", "module": "src/typerenderer/celledit-google-protobuf-floatvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-int32value.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-int32value` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditGoolgeProtobufIn32value", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-google-protobuf-int32value", "summary": "celledit renderer for `google.protobuf.Int32value`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoolgeProtobufIn32value", "declaration": { "name": "CelleditGoolgeProtobufIn32value", "module": "src/typerenderer/celledit-google-protobuf-int32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-int64value.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-int64value` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditGoolgeProtobufIn64value", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-google-protobuf-int64value", "summary": "celledit renderer for `google.protobuf.Int64Value`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoolgeProtobufIn64value", "declaration": { "name": "CelleditGoolgeProtobufIn64value", "module": "src/typerenderer/celledit-google-protobuf-int64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-stringvalue.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditGoogleProtobufStringvalue", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_mapOptionsToSuggestions", "parameters": [ { "name": "repeaterNode" } ], "description": "Maps a RepeaterNode according the mapping definition to an ui5-suggestion-item.\nSupported fields are:\n- text\n- description", "return": { "type": { "text": "*[]" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list.\nThe items are displayed as suggestion items.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_createHandler", "parameters": [ { "name": "wait" }, { "name": "immediate" } ], "description": "Internal create of debounce handler function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'Text'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_optionList", "type": { "text": "{}" }, "description": "Internal pointer to the options RepeaterNode", "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the text of the\noption items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "wait", "type": { "text": "number" }, "description": "Debounce time in milliseconds\nDefault value: 250", "default": "250", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n icon: undefined, // updates the icon\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n maxlength: null,\n wait: 250,\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_debounce", "description": "Debounce function, taken from Underscore.js", "parameters": [ { "name": "func" }, { "name": "wait" }, { "name": "immediate" } ], "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "default": "function debounce(func, wait, immediate) {\n let timeout;\n return function debouncer() {\n const context = this;\n // eslint-disable-next-line prefer-rest-params\n const args = arguments;\n const later = function applyLater() {\n timeout = null;\n if (!immediate) func.apply(context, args);\n };\n const callNow = immediate && !timeout;\n clearTimeout(timeout);\n timeout = setTimeout(later, wait);\n if (callNow) func.apply(context, args);\n };\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ], "superclass": { "name": "CelleditString", "module": "/src/typerenderer/celledit-string.js" }, "tagName": "celledit-google-protobuf-stringvalue", "summary": "celledit renderer for `google.protobuf.StringValue`", "customElement": true, "events": [ { "name": "search-requested", "type": { "text": "value" }, "description": "Fired when typing in input (debounced, default 250ms)", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleProtobufStringvalue", "declaration": { "name": "CelleditGoogleProtobufStringvalue", "module": "src/typerenderer/celledit-google-protobuf-stringvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-timestamp.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditGoogleProtobufTimestamp", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "v" } ], "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `string`, `google.protobuf.Timestamp`, `int32`, `int64`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `google.protobuf.Timestamp`, `int32`, `int64`", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "readAttributes", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } } ], "superclass": { "name": "FuroUi5DateTimePicker", "module": "/src/furo-ui5-date-time-picker.js" }, "tagName": "celledit-google-protobuf-timestamp", "summary": "celledit renderer for `google.protobuf.Timestamp`", "customElement": true, "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } }, { "description": "Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5DateTimePicker", "module": "src/furo-ui5-date-time-picker.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleProtobufTimestamp", "declaration": { "name": "CelleditGoogleProtobufTimestamp", "module": "src/typerenderer/celledit-google-protobuf-timestamp.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-uint32value.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-uint32value` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditGoolgeProtobufUin32value", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-google-protobuf-uint32value", "summary": "celledit renderer for `google.protobuf.Uint32value`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoolgeProtobufUin32value", "declaration": { "name": "CelleditGoolgeProtobufUin32value", "module": "src/typerenderer/celledit-google-protobuf-uint32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-protobuf-uint64value.js", "declarations": [ { "kind": "class", "description": "`celledit-google-protobuf-uint64value` is a `celledit` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "CelleditGoogleProtobufUint64value", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-google-protobuf-uint64value", "summary": "celledit renderer for `google.protobuf.Uint64value`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleProtobufUint64value", "declaration": { "name": "CelleditGoogleProtobufUint64value", "module": "src/typerenderer/celledit-google-protobuf-uint64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-type-date.js", "declarations": [ { "kind": "class", "description": "`celledit-google-type-date` is a `celledit` context renderer.\n\nIt uses furo-ui5-date-picker as the renderer", "name": "CelleditGoogleTypeDate", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type: `string`, `furo.type.Date`, `google.type.Date`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `furo.type.Date`, `google.type.Date`", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nAttributes that can be se are `value-state`, `placeholder`, `required`,`readonly`,`disabled` `max-date`, `min-date`, `format-pattern`,\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "description": "The format pattern for the date.", "default": "''", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{min: undefined, readonly: undefined, max: undefined, pattern: undefined, placeholder: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{required: undefined}" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{minDate: null, readonly: null, formatPattern: null, disabled: null, maxDate: null, placeholder: null, required: null}" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } } ], "superclass": { "name": "FuroUi5DatePicker", "module": "/src/furo-ui5-date-picker.js" }, "tagName": "celledit-google-type-date", "summary": "celledit renderer for `google.type.Date`", "customElement": true, "events": [ { "type": { "text": "Date" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } }, { "type": { "text": "Date" }, "description": "-Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5DatePicker", "module": "src/furo-ui5-date-picker.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleTypeDate", "declaration": { "name": "CelleditGoogleTypeDate", "module": "src/typerenderer/celledit-google-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-type-money.js", "declarations": [ { "kind": "class", "description": "`celledit-google-type-money` is a `celledit` context renderer.\n\nIt uses furo-ui5-money-input as the renderer", "name": "CelleditGoogleTypeMoney", "members": [ { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type `google.type.Money`", "type": { "text": "FieldNode" } } ], "description": "Binds a fieldNode.\n\nSupported types: `google.type.Money`", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nAttributes that can be se are `required`,`readonly`,`disabled` ,\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "Checks if options.flags has an entry `currency_list`\nIn this case the option list is applied to the currency field as suggestion items.\n\nIf you use a static option definition in the type specification (furo), you can\ndefine the list as follows:\n\n```\noptions:\n flags:\n - currency_list\n list:\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: Swiss francs (CHF)\n id: CHF\n selected: false\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: Euro (EUR)\n id: EUR\n selected: false\n - '@type': type.googleapis.com/furo.Optionitem\n display_name: US Dollar (USD)\n id: USD\n selected: false\n```", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_FBPReady", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_convertDataToMoneyObj", "parameters": [ { "name": "currency" }, { "name": "amount" }, { "name": "obj" } ], "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_updateField", "parameters": [ { "name": "value" } ], "description": "update amount field\nOne issue with number inputs is that their step size is 1 by default.\nIf you try to enter a number with a decimal (such as \"1.0\"), it will be considered invalid.\nIf you want to enter a value that requires decimals, you'll need to reflect this in the step value\n(e.g. step=\"0.01\" to allow decimals to two decimal places).", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_getElements", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "{state: string, message: string}" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "{readonly: undefined}" }, "privacy": "private", "default": "{\n readonly: undefined,\n }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "{required: undefined}" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "{readonly: null, disabled: null, required: null}" }, "description": "A list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n required: null,\n disabled: null,\n }", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ], "superclass": { "name": "FuroUi5MoneyInput", "module": "/src/furo-ui5-money-input.js" }, "tagName": "celledit-google-type-money", "summary": "celledit renderer for `google.type.Money`", "customElement": true, "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ], "events": [ { "type": { "text": "Money" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5MoneyInput", "module": "src/furo-ui5-money-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleTypeMoney", "declaration": { "name": "CelleditGoogleTypeMoney", "module": "src/typerenderer/celledit-google-type-money.js" } }, { "kind": "custom-element-definition", "name": "celledit-google-type-money", "declaration": { "name": "CelleditGoogleTypeMoney", "module": "src/typerenderer/celledit-google-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-google-type-timeofday.js", "declarations": [ { "kind": "class", "description": "`celledit-google-type-timeofday` is a `celledit` context renderer.\n\nIt uses furo-ui5-time-picker as the renderer", "name": "CelleditGoogleTypeTimeofday", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "_updateFNA", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "description": "update of the bound FieldNode", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "Workaround for language request", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "description": "FieldNodeAdapter callback function to\nhandle changes on the model.", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "field", "name": "formatPattern", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after a invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n min: undefined,\n max: undefined,\n pattern: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n maxDate: null,\n minDate: null,\n formatPattern: null,\n }", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } } ], "superclass": { "name": "FuroUi5TimePicker", "module": "/src/furo-ui5-time-picker.js" }, "tagName": "celledit-google-type-timeofday", "summary": "celledit renderer for `google.type.TimeOfDay`", "customElement": true, "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } }, { "description": "Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5TimePicker", "module": "src/furo-ui5-time-picker.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditGoogleTypeTimeofday", "declaration": { "name": "CelleditGoogleTypeTimeofday", "module": "src/typerenderer/celledit-google-type-timeofday.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-int32.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditInt32", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "FuroUi5NumberInput", "module": "/src/furo-ui5-number-input.js" }, "tagName": "celledit-int32", "summary": "celledit renderer for `int32`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditInt32", "declaration": { "name": "CelleditInt32", "module": "src/typerenderer/celledit-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-int64.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditInt64", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-int64", "summary": "celledit renderer for `int64`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditInt64", "declaration": { "name": "CelleditInt64", "module": "src/typerenderer/celledit-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-string.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditString", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\n\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "update the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_mapOptionsToSuggestions", "parameters": [ { "name": "repeaterNode" } ], "description": "Maps a RepeaterNode according the mapping definition to an ui5-suggestion-item.\nSupported fields are:\n- text\n- description", "return": { "type": { "text": "*[]" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "getValueByPath", "static": true, "parameters": [ { "name": "obj" }, { "name": "path" } ], "description": "Let you get an attribute value by path", "return": { "type": { "text": "" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Here a RepeaterNode can be connected to the component as an option list.\nThe items are displayed as suggestion items.", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "method", "name": "_createHandler", "parameters": [ { "name": "wait" }, { "name": "immediate" } ], "description": "Internal create of debounce handler function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'Text'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_optionList", "type": { "text": "{}" }, "description": "Internal pointer to the options RepeaterNode", "privacy": "private", "default": "{}", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "displayFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the text of the\noption items.\nPoint-separated path to the field\nE.g. data.partner.display_name\ndefault: display_name\nThis attribute is related to the option list", "default": "'display_name'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "descFieldPath", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "wait", "type": { "text": "number" }, "description": "Debounce time in milliseconds\nDefault value: 250", "default": "250", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "description": "used to restore the state after an invalidation -> validation change", "privacy": "private", "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n max: undefined, // maps to maxlength\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n max: undefined, // maps to maxlength\n icon: undefined, // updates the icon\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in text-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n maxlength: null,\n wait: 250,\n 'display-field-path': 'display_name',\n 'desc-field-path': 'id',\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "kind": "field", "name": "_debounce", "description": "Debounce function, taken from Underscore.js", "parameters": [ { "name": "func" }, { "name": "wait" }, { "name": "immediate" } ], "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "default": "function debounce(func, wait, immediate) {\n let timeout;\n return function debouncer() {\n const context = this;\n // eslint-disable-next-line prefer-rest-params\n const args = arguments;\n const later = function applyLater() {\n timeout = null;\n if (!immediate) func.apply(context, args);\n };\n const callNow = immediate && !timeout;\n clearTimeout(timeout);\n timeout = setTimeout(later, wait);\n if (callNow) func.apply(context, args);\n };\n }", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ], "superclass": { "name": "FuroUi5TextInput", "module": "/src/furo-ui5-text-input.js" }, "tagName": "celledit-string", "summary": "celledit renderer for `string`", "customElement": true, "events": [ { "name": "search-requested", "type": { "text": "value" }, "description": "Fired when typing in input (debounced, default 250ms)", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } }, { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInput", "module": "src/furo-ui5-text-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditString", "declaration": { "name": "CelleditString", "module": "src/typerenderer/celledit-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-uint32.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditUint32", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-uint32", "summary": "celledit renderer for `uint32`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditUint32", "declaration": { "name": "CelleditUint32", "module": "src/typerenderer/celledit-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/celledit-uint64.js", "declarations": [ { "kind": "class", "description": "", "name": "CelleditUint64", "members": [ { "kind": "field", "name": "metadata", "static": true, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_addValueStateMessage", "description": "Adds a div with slot=\"valueStateMessage\" to show\nfield related information if the attribute value-state is set.", "return": { "type": { "text": "HTMLDivElement" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_removeValueStateMessage", "description": "Removes
", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "nativeInputAttributes", "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types:\n- `double`, `float`, `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32`, `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64`\n- `google.protobuf.DoubleValue`, `google.protobuf.FloatValue`, `google.protobuf.Int32Value`, etc.\n- `furo.fat.Doube`, `furo.fat.Float`, `furo.fat.Int32`, etc.\n- `furo.BigDecimal`", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "readAttributes", "description": "Reads the attributes which are set on the component dom.\nthose attributes can be set. `value-state`, `value-state-message`, `icon`, `placeholder`, `required`,`readonly`,`disabled`\nUse this after manual or scripted update of the attributes.", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateFNA", "description": "Handler function for the input value changes.\nThis is done to be able to remove the event-listeners as a protection for multiple calls", "return": { "type": { "text": "(function(): void)|*" } }, "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateLabelsFromFat", "parameters": [ { "name": "fatLabels" } ], "description": "labels are map , we handle every boolean attribute with the labels", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_updateAttributesFromFat", "parameters": [ { "name": "fatAttributes" } ], "description": "sync input attributes according to fat attributes", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "accInfo", "description": "rewrite get accInfo function\ninitiate _inputAccInfo in order to avoid error", "privacy": "private", "return": { "type": { "text": "*" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "valueStateMessage", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|{}" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "suggestionItems", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "icon", "description": "overwrite to fix error", "privacy": "private", "return": { "type": { "text": "*|[]" } }, "readonly": true, "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ], "description": "overwrite onFnaFieldValueChanged", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaPlaceholderChanged", "parameters": [ { "name": "placeholder" } ], "description": "overwrite onFnaPlaceholderChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaReadonlyChanged", "parameters": [ { "name": "readonly" } ], "description": "overwrite onFnaReadonlyChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaOptionsChanged", "parameters": [ { "name": "options" } ], "description": "overwrite onFnaOptionsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaConstraintsChanged", "parameters": [ { "name": "constraints" } ], "description": "overwrite onFnaConstraintsChanged function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldStateChanged", "parameters": [ { "name": "state" } ], "description": "set the value state", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameInvalid", "parameters": [ { "name": "validity" } ], "description": "overwrite onFnaFieldNodeBecameInvalid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "onFnaFieldNodeBecameValid", "description": "overwrite onFnaFieldNodeBecameValid function", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setSuggestions", "parameters": [ { "name": "arr" } ], "description": "set suggestions as the ui5-suggestion-item element\nui5 suggestions sample data: [{\"text\":\"Spain\",\"icon\":\"world\",\"type\":\"Active\",\"infoState\":\"None\",\"group\":false,\"key\":0},.. ]\nfuro.Fieldoption as suggestions: [{\"id\": 1,\"display_name\":\"show 1\"}, ..]\nif the suggestion item has icon , the ui5 icons should be imported in your ui component", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setValueStateMessage", "parameters": [ { "name": "valueState" }, { "name": "message" } ], "description": "updates the value state and the value state message on demand", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_resetValueStateMessage", "description": "resets value-state and valueStateMessage to previous value state\nIf no previous message is set, the valueStateMessage container is removed.", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "method", "name": "_setIcon", "parameters": [ { "name": "icon" } ], "description": "set ui5 icon", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_previousValueState", "type": { "text": "object" }, "default": "{ state: 'None', message: '' }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_constraintsFromFNA", "type": { "text": "object" }, "privacy": "private", "default": "{\n required: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_labelsFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n readonly: undefined,\n disabled: undefined,\n required: undefined,\n hidden: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_attributesFromFAT", "type": { "text": "object" }, "privacy": "private", "default": "{\n placeholder: undefined,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "kind": "field", "name": "_privilegedAttributes", "type": { "text": "object" }, "description": "a list of privileged attributes. when those attributes are set in number-input components initially.\nthey can not be modified later via response or spec\nnull is used because getAttribute returns null or value", "privacy": "private", "default": "{\n readonly: null,\n placeholder: null,\n required: null,\n disabled: null,\n icon: null,\n }", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ], "superclass": { "name": "CelleditInt32", "module": "/src/typerenderer/celledit-int32.js" }, "tagName": "celledit-uint64", "summary": "celledit renderer for `uint64`", "customElement": true, "events": [ { "type": { "text": "`number`" }, "description": " Fired when the input operation has finished by pressing Enter or on focusout.", "name": "change", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "description": " Fired when the value of the ui5-input changes at each keystroke, and when a suggestion item has been selected.", "name": "input", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } }, { "type": { "text": "`string`" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInput", "module": "src/furo-ui5-number-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "CelleditUint64", "declaration": { "name": "CelleditUint64", "module": "src/typerenderer/celledit-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-bool.js", "declarations": [ { "kind": "class", "description": "`display-bool`\nThe display-bool component displays a FieldNode of type `bool` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayBool", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ] }, { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-bool", "summary": "display renderer for `bool`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayBool", "declaration": { "name": "DisplayBool", "module": "src/typerenderer/display-bool.js" } }, { "kind": "custom-element-definition", "name": "display-bool", "declaration": { "name": "DisplayBool", "module": "src/typerenderer/display-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-double.js", "declarations": [ { "kind": "class", "description": "`display-double`\nThe display-double component displays a FieldNode of type `double` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayDouble", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ] }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ] }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-double", "summary": "display renderer for `double`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayDouble", "declaration": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "custom-element-definition", "name": "display-double", "declaration": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-float.js", "declarations": [ { "kind": "class", "description": "`display-float`\nThe display-float component displays a FieldNode of type `float` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFloat", "superclass": { "name": "DisplayDouble", "module": "/src/typerenderer/display-double.js" }, "tagName": "display-float", "summary": "display renderer for `float`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFloat", "declaration": { "name": "DisplayFloat", "module": "src/typerenderer/display-float.js" } }, { "kind": "custom-element-definition", "name": "display-float", "declaration": { "name": "DisplayFloat", "module": "src/typerenderer/display-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-bigdecimal.js", "declarations": [ { "kind": "class", "description": "`display-furo-bigdecimal`\nThe display-furo-bigdecimal component displays a FieldNode of type `furo.BigDecimal` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat", "name": "DisplayFuroBigdecimal", "members": [ { "kind": "field", "name": "currency", "privacy": "public", "type": { "text": "string" }, "description": "Set currency formating", "parameters": [ { "name": "c" } ], "attribute": "currency" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatDisplay" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_options", "type": { "text": "object" }, "default": "{}" } ], "attributes": [ { "name": "currency", "type": { "text": "string" }, "description": "Set currency formating", "parameters": [ { "name": "c" } ], "fieldName": "currency" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-furo-bigdecimal", "summary": "display renderer for `furo.BigDecimal`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroBigdecimal", "declaration": { "name": "DisplayFuroBigdecimal", "module": "src/typerenderer/display-furo-bigdecimal.js" } }, { "kind": "custom-element-definition", "name": "display-furo-bigdecimal", "declaration": { "name": "DisplayFuroBigdecimal", "module": "src/typerenderer/display-furo-bigdecimal.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-bool.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-bool`\nThe display-furo-fat-bool component displays a FieldNode of type `furo.fat.bool` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatBool", "members": [ { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private", "inheritedFrom": { "name": "DisplayBool", "module": "src/typerenderer/display-bool.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayBool", "module": "src/typerenderer/display-bool.js" } } ], "superclass": { "name": "DisplayBool", "module": "/src/typerenderer/display-bool.js" }, "tagName": "display-furo-fat-bool", "summary": "display renderer for `furo.fat.Bool`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatBool", "declaration": { "name": "DisplayFuroFatBool", "module": "src/typerenderer/display-furo-fat-bool.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-bool", "declaration": { "name": "DisplayFuroFatBool", "module": "src/typerenderer/display-furo-fat-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-double.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-double`\nThe display-furo-fat-double component displays a FieldNode of type `furo.fat.Double` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatDouble", "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } } ], "superclass": { "name": "DisplayDouble", "module": "/src/typerenderer/display-double.js" }, "tagName": "display-furo-fat-double", "summary": "display renderer for `furo.fat.Double`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatDouble", "declaration": { "name": "DisplayFuroFatDouble", "module": "src/typerenderer/display-furo-fat-double.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-double", "declaration": { "name": "DisplayFuroFatDouble", "module": "src/typerenderer/display-furo-fat-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-float.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-float`\nThe display-furo-fat-float component displays a FieldNode of type `furo.fat.Float` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatFloat", "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } } ], "superclass": { "name": "DisplayFloat", "module": "/src/typerenderer/display-float.js" }, "tagName": "display-furo-fat-float", "summary": "display renderer for `furo.fat.Float`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatFloat", "declaration": { "name": "DisplayFuroFatFloat", "module": "src/typerenderer/display-furo-fat-float.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-float", "declaration": { "name": "DisplayFuroFatFloat", "module": "src/typerenderer/display-furo-fat-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-int32.js", "declarations": [ { "kind": "class", "description": "`display-int32`\nThe display-int32 component displays a FieldNode of type `furo.fat.Int32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatInt32", "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ], "superclass": { "name": "DisplayInt32", "module": "/src/typerenderer/display-int32.js" }, "tagName": "display-furo-fat-int32", "summary": "display renderer for `furo.fat.Int32`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatInt32", "declaration": { "name": "DisplayFuroFatInt32", "module": "src/typerenderer/display-furo-fat-int32.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-int32", "declaration": { "name": "DisplayFuroFatInt32", "module": "src/typerenderer/display-furo-fat-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-int64.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-int64`\nThe display-furo-fat-int64 component displays a FieldNode of type `furo.fat.int64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatInt64", "superclass": { "name": "DisplayFuroFatInt32", "module": "/src/typerenderer/display-furo-fat-int32.js" }, "tagName": "display-furo-fat-int64", "summary": "display renderer for `furo.fat.Int64`", "customElement": true, "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatInt64", "declaration": { "name": "DisplayFuroFatInt64", "module": "src/typerenderer/display-furo-fat-int64.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-int64", "declaration": { "name": "DisplayFuroFatInt64", "module": "src/typerenderer/display-furo-fat-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-string.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-string`\nThe display-furo-fat-string component displays a FieldNode of type `furo.fat.String` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatString", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_updateMeta" }, { "kind": "method", "name": "_formatDisplay" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-furo-fat-string", "summary": "display renderer for `furo.fat.String`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatString", "declaration": { "name": "DisplayFuroFatString", "module": "src/typerenderer/display-furo-fat-string.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-string", "declaration": { "name": "DisplayFuroFatString", "module": "src/typerenderer/display-furo-fat-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-uint32.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-uint32`\nThe display-furo-fat-uint32 component displays a FieldNode of type `furo.fat.Uint32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatUint32", "superclass": { "name": "DisplayFuroFatInt32", "module": "/src/typerenderer/display-furo-fat-int32.js" }, "tagName": "display-furo-fat-Uint32", "summary": "display renderer for `furo.fat.Uint32`", "customElement": true, "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatUint32", "declaration": { "name": "DisplayFuroFatUint32", "module": "src/typerenderer/display-furo-fat-uint32.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-uint32", "declaration": { "name": "DisplayFuroFatUint32", "module": "src/typerenderer/display-furo-fat-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-fat-uint64.js", "declarations": [ { "kind": "class", "description": "`display-furo-fat-uint64`\nThe display-furo-fat-uint64 component displays a FieldNode of type `furo.fat.uint64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroFatUint64", "superclass": { "name": "DisplayFuroFatInt64", "module": "/src/typerenderer/display-furo-fat-int64.js" }, "tagName": "display-furo-fat-uint64", "summary": "display renderer for `furo.fat.Uint64`", "customElement": true, "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroFatUint64", "declaration": { "name": "DisplayFuroFatUint64", "module": "src/typerenderer/display-furo-fat-uint64.js" } }, { "kind": "custom-element-definition", "name": "display-furo-fat-uint64", "declaration": { "name": "DisplayFuroFatUint64", "module": "src/typerenderer/display-furo-fat-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-integerproperty.js", "declarations": [ { "kind": "class", "description": "`display-furo-integerproperty`\nThe display-furo-integerproperty component displays a FieldNode of type `furo.Integerproperty` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroIntegerproperty", "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ], "superclass": { "name": "DisplayInt32", "module": "/src/typerenderer/display-int32.js" }, "tagName": "display-furo-", "summary": "display renderer for `furo.`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroIntegerproperty", "declaration": { "name": "DisplayFuroIntegerproperty", "module": "src/typerenderer/display-furo-integerproperty.js" } }, { "kind": "custom-element-definition", "name": "display-furo-integerproperty", "declaration": { "name": "DisplayFuroIntegerproperty", "module": "src/typerenderer/display-furo-integerproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-link.js", "declarations": [ { "kind": "class", "description": "`display-furo-link`\nThe display-furo-link component displays a FieldNode of type `furo.Link` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroLink", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-furo-link", "summary": "display renderer for `furo.Link`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroLink", "declaration": { "name": "DisplayFuroLink", "module": "src/typerenderer/display-furo-link.js" } }, { "kind": "custom-element-definition", "name": "display-furo-link", "declaration": { "name": "DisplayFuroLink", "module": "src/typerenderer/display-furo-link.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-numberproperty.js", "declarations": [ { "kind": "class", "description": "`display-furo-numberproperty`\nThe display-furo-numberrproperty component displays a FieldNode of type `furo.Numberproperty` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroNumberproperty", "superclass": { "name": "DisplayFuroIntegerproperty", "module": "/src/typerenderer/display-furo-integerproperty.js" }, "tagName": "display-furo-numberproperty", "summary": "display renderer for `furo.Numberproperty`", "customElement": true, "members": [ { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroNumberproperty", "declaration": { "name": "DisplayFuroNumberproperty", "module": "src/typerenderer/display-furo-numberproperty.js" } }, { "kind": "custom-element-definition", "name": "display-furo-numberproperty", "declaration": { "name": "DisplayFuroNumberproperty", "module": "src/typerenderer/display-furo-numberproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-property-repeated.js", "declarations": [ { "kind": "class", "description": "`display-furo-property-repeats`\nThe display-furo-property-repeats component displays a FieldNode of type `furo.Property` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroPropertyRepeated", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe display-furo-property-repeats is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_updateFieldList" }, { "kind": "field", "name": "elementList", "type": { "text": "array" }, "default": "[]" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "attribute": "noDataText" } ], "attributes": [ { "name": "noDataText", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-furo-property-repeated", "summary": "display renderer for `[] furo.Property`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroPropertyRepeated", "declaration": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } }, { "kind": "custom-element-definition", "name": "display-furo-property-repeated", "declaration": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-property-repeats-labeled.js", "declarations": [ { "kind": "class", "description": "`display-furo-property-repeats-labeled`\nThe display-furo-property-repeats-labeled component displays a RepeaterNode of type `furo.Property` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroPropertyRepeatsLabeled", "members": [ { "kind": "method", "name": "_updateFieldList", "description": "Overloaded", "privacy": "private", "inheritedFrom": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } }, { "kind": "method", "name": "_getPropertyLabel", "parameters": [ { "name": "item" } ], "description": "resolve label for furo.Property repeated item", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe display-furo-property-repeats is a simple proxy element to show\nthe initial state if no data is available.", "inheritedFrom": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } }, { "kind": "field", "name": "elementList", "type": { "text": "array" }, "default": "[]", "inheritedFrom": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "attribute": "noDataText", "inheritedFrom": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } } ], "superclass": { "name": "DisplayFuroPropertyRepeated", "module": "/src/typerenderer/display-furo-property-repeated.js" }, "tagName": "display-furo-property-labeled", "summary": "display renderer for `[] furo.Property` with labels", "customElement": true, "attributes": [ { "name": "noDataText", "type": { "text": "String" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "fieldName": "noDataText", "inheritedFrom": { "name": "DisplayFuroPropertyRepeated", "module": "src/typerenderer/display-furo-property-repeated.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroPropertyRepeatsLabeled", "declaration": { "name": "DisplayFuroPropertyRepeatsLabeled", "module": "src/typerenderer/display-furo-property-repeats-labeled.js" } }, { "kind": "custom-element-definition", "name": "display-furo-property-repeats-labeled", "declaration": { "name": "DisplayFuroPropertyRepeatsLabeled", "module": "src/typerenderer/display-furo-property-repeats-labeled.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-property.js", "declarations": [ { "kind": "class", "description": "`display-furo-property`\nThe display-furo-property component displays a FieldNode of type `furo.Property` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroProperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe display-furo-property is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_waitForType", "parameters": [ { "name": "field" } ], "description": "furo.Property wait for @type information\nregisters event listener and creates the component as soon as the @type information is available.", "privacy": "private" }, { "kind": "method", "name": "_createConcreteType", "description": "Creates the concrete type specific renderer", "privacy": "private" }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "string" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "default": "''", "attribute": "noDataText" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" } ], "attributes": [ { "name": "noDataText", "type": { "text": "string" }, "description": "Defines the empty state display\nWith a furo.Property type, the effective type is only known when the data is transmitted.\nDefault: ''", "default": "''", "fieldName": "noDataText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp/src/fbp.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-furo-property", "summary": "display renderer for `furo.Property`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroProperty", "declaration": { "name": "DisplayFuroProperty", "module": "src/typerenderer/display-furo-property.js" } }, { "kind": "custom-element-definition", "name": "display-furo-property", "declaration": { "name": "DisplayFuroProperty", "module": "src/typerenderer/display-furo-property.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-reference.js", "declarations": [ { "kind": "class", "description": "`display-furo-reference`\nThe display-furo-reference component displays a FieldNode of type `furo.Reference` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroReference", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatDisplay", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "events": [ { "description": "when item was clicked or selected, because click from ui5 does not bubble", "name": "selected" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-furo-reference", "summary": "display renderer for `furo.Reference`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroReference", "declaration": { "name": "DisplayFuroReference", "module": "src/typerenderer/display-furo-reference.js" } }, { "kind": "custom-element-definition", "name": "display-furo-reference", "declaration": { "name": "DisplayFuroReference", "module": "src/typerenderer/display-furo-reference.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-stringoptionproperty.js", "declarations": [ { "kind": "class", "description": "`display-furo-stringoptionproperty`\nThe display-furo-numberrproperty component displays a FieldNode of type `furo.Stringoptionproperty` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroStringoptionproperty", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } }, { "kind": "field", "name": "_text", "privacy": "public", "type": { "text": "string" }, "default": "''", "attribute": "_text", "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ], "superclass": { "name": "DisplayFuroStringproperty", "module": "/src/typerenderer/display-furo-stringproperty.js" }, "tagName": "display-furo-stringoptionproperty", "summary": "display renderer for `furo.Stringoptionproperty`", "customElement": true, "attributes": [ { "name": "_text", "type": { "text": "string" }, "default": "''", "fieldName": "_text", "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroStringoptionproperty", "declaration": { "name": "DisplayFuroStringoptionproperty", "module": "src/typerenderer/display-furo-stringoptionproperty.js" } }, { "kind": "custom-element-definition", "name": "display-furo-stringoptionproperty", "declaration": { "name": "DisplayFuroStringoptionproperty", "module": "src/typerenderer/display-furo-stringoptionproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-stringproperty.js", "declarations": [ { "kind": "class", "description": "`display-furo-stringproperty`\nThe display-furo-stringproperty component displays a FieldNode of type `furo.Stringproperty` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroStringproperty", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } }, { "kind": "field", "name": "_text", "privacy": "public", "type": { "text": "string" }, "default": "''", "attribute": "_text", "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ], "superclass": { "name": "DisplayString", "module": "/src/typerenderer/display-string.js" }, "tagName": "display-furo-stringproperty", "summary": "display renderer for `furo.Stringproperty`", "customElement": true, "attributes": [ { "name": "_text", "type": { "text": "string" }, "default": "''", "fieldName": "_text", "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayFuroStringproperty", "declaration": { "name": "DisplayFuroStringproperty", "module": "src/typerenderer/display-furo-stringproperty.js" } }, { "kind": "custom-element-definition", "name": "display-furo-stringproperty", "declaration": { "name": "DisplayFuroStringproperty", "module": "src/typerenderer/display-furo-stringproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-type-date.js", "declarations": [ { "kind": "class", "description": "`display-furo-type-date`\nThe display-furo-type-date component displays a FieldNode of type `furo.type.Date` in read only mode.\n\nif the field `display_name` is set, the component will use that value for the display.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroTypeDate", "members": [ { "kind": "method", "name": "_formatDisplay", "inheritedFrom": { "name": "DisplayGoogleTypeDate", "module": "src/typerenderer/display-google-type-date.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "DisplayGoogleTypeDate", "module": "src/typerenderer/display-google-type-date.js" } }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldNode" }, { "name": "date" } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 31.12.2021", "return": { "type": { "text": "string" } }, "privacy": "private", "inheritedFrom": { "name": "DisplayGoogleTypeDate", "module": "src/typerenderer/display-google-type-date.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayGoogleTypeDate", "module": "src/typerenderer/display-google-type-date.js" } } ], "superclass": { "name": "DisplayGoogleTypeDate", "module": "/src/typerenderer/display-google-type-date.js" }, "tagName": "display-furo-type-date", "summary": "display renderer for `furo.type.Date`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroTypeDate", "declaration": { "name": "DisplayFuroTypeDate", "module": "src/typerenderer/display-furo-type-date.js" } }, { "kind": "custom-element-definition", "name": "display-furo-type-date", "declaration": { "name": "DisplayFuroTypeDate", "module": "src/typerenderer/display-furo-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-furo-type-money.js", "declarations": [ { "kind": "class", "description": "`display-furo-type-money`\nThe display-furo-type-money component displays a FieldNode of type `furo.type.Money` in read only mode.\n\nif the field `display_name` is set, the component will use that value for the display.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayFuroTypeMoney", "members": [ { "kind": "method", "name": "_formatDisplay", "inheritedFrom": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component", "inheritedFrom": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } }, { "kind": "method", "name": "_convertTypeToNumber", "static": true, "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "return": { "type": { "text": "number" } }, "privacy": "private", "inheritedFrom": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } }, { "kind": "field", "name": "_valueObject", "type": { "text": "{amount: number}" }, "privacy": "private", "default": "{ amount: Number.NaN }", "inheritedFrom": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } } ], "superclass": { "name": "DisplayGoogleTypeMoney", "module": "/src/typerenderer/display-google-type-money.js" }, "tagName": "display-furo-type-money", "summary": "display renderer for `furo.type.Money`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayFuroTypeMoney", "declaration": { "name": "DisplayFuroTypeMoney", "module": "src/typerenderer/display-furo-type-money.js" } }, { "kind": "custom-element-definition", "name": "display-furo-type-money", "declaration": { "name": "DisplayFuroTypeMoney", "module": "src/typerenderer/display-furo-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-any.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-any`\nThe display-google-protobuf-any component is a wrapper displays of type `google.protobuf.Any` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufAny", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component\nthe display-google-protobuf-any is a simple proxy element to show\nthe initial state if no data is available." }, { "kind": "method", "name": "_waitForType", "parameters": [ { "name": "field" } ], "description": "google.protobuf.Any wait for @type information\nregisters event listener and creates the component as soon as the @type information is available.", "privacy": "private" }, { "kind": "method", "name": "_createContreteType", "description": "Creates the concrete type specific renderer", "privacy": "private" }, { "kind": "method", "name": "_warning", "description": "warns if diynamic component is not imported", "privacy": "private" }, { "kind": "field", "name": "_typeResolved", "type": { "text": "boolean" }, "default": "false" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-protobuf-", "summary": "display renderer for `google.protobuf.`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufAny", "declaration": { "name": "DisplayGoolgeProtobufAny", "module": "src/typerenderer/display-google-protobuf-any.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-any", "declaration": { "name": "DisplayGoolgeProtobufAny", "module": "src/typerenderer/display-google-protobuf-any.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-boolvalue.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-boolvalue`\nThe display-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.BoolValue` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufBoolvalue", "superclass": { "name": "DisplayBool", "module": "/src/typerenderer/display-bool.js" }, "tagName": "display-google-protobuf-boolvalue", "summary": "display renderer for `google.protobuf.BoolValue`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayBool", "module": "src/typerenderer/display-bool.js" } }, { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private", "inheritedFrom": { "name": "DisplayBool", "module": "src/typerenderer/display-bool.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufBoolvalue", "declaration": { "name": "DisplayGoolgeProtobufBoolvalue", "module": "src/typerenderer/display-google-protobuf-boolvalue.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-boolvalue", "declaration": { "name": "DisplayGoolgeProtobufBoolvalue", "module": "src/typerenderer/display-google-protobuf-boolvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-doublevalue.js", "declarations": [ { "kind": "class", "description": "`display-double`\nThe display-double component displays a FieldNode of type `google.protobuf.DoubleValue` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoogleProtobufDoublevalue", "superclass": { "name": "DisplayDouble", "module": "/src/typerenderer/display-double.js" }, "tagName": "display-google-protobuf-doublevalue", "summary": "display renderer for `google.protobuf.DoubleValue`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoogleProtobufDoublevalue", "declaration": { "name": "DisplayGoogleProtobufDoublevalue", "module": "src/typerenderer/display-google-protobuf-doublevalue.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-doublevalue", "declaration": { "name": "DisplayGoogleProtobufDoublevalue", "module": "src/typerenderer/display-google-protobuf-doublevalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-floatvalue.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-floatvalue`\nThe display-google-protobuf-floatvalue component displays a FieldNode of type `google.protobuf.FloatValue` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufFloatvalue", "superclass": { "name": "DisplayFloat", "module": "/src/typerenderer/display-float.js" }, "tagName": "display-google-protobuf-floatvalue", "summary": "display renderer for `google.protobuf.FloatValue`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ], "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayDouble", "module": "src/typerenderer/display-double.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufFloatvalue", "declaration": { "name": "DisplayGoolgeProtobufFloatvalue", "module": "src/typerenderer/display-google-protobuf-floatvalue.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-floatvalue", "declaration": { "name": "DisplayGoolgeProtobufFloatvalue", "module": "src/typerenderer/display-google-protobuf-floatvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-int32value.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-boolvalue`\nThe display-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Int32Value` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufIn32value", "superclass": { "name": "DisplayInt32", "module": "/src/typerenderer/display-int32.js" }, "tagName": "display-google-protobuf-int32Value", "summary": "display renderer for `google.protobuf.Int32Value`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufIn32value", "declaration": { "name": "DisplayGoolgeProtobufIn32value", "module": "src/typerenderer/display-google-protobuf-int32value.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-int32value", "declaration": { "name": "DisplayGoolgeProtobufIn32value", "module": "src/typerenderer/display-google-protobuf-int32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-int64value.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-boolvalue`\nThe display-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Int64Value` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufIn64value", "superclass": { "name": "DisplayInt64", "module": "/src/typerenderer/display-int64.js" }, "tagName": "display-google-protobuf-int64Value", "summary": "display renderer for `google.protobuf.Int64Value`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufIn64value", "declaration": { "name": "DisplayGoolgeProtobufIn64value", "module": "src/typerenderer/display-google-protobuf-int64value.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-int64value", "declaration": { "name": "DisplayGoolgeProtobufIn64value", "module": "src/typerenderer/display-google-protobuf-int64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-stringvalue.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-stringvalue`\nThe display-google-protobuf-stringvalue component displays a FieldNode of type `google.protobuf.StringValue` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoogleProtobufStringvalue", "superclass": { "name": "DisplayString", "module": "/src/typerenderer/display-string.js" }, "tagName": "display-google-protobuf-stringvalue", "summary": "display renderer for `google.protobuf.StringValue`", "customElement": true, "attributes": [ { "name": "_text", "type": { "text": "string" }, "default": "''", "fieldName": "_text", "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ], "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } }, { "kind": "field", "name": "_text", "privacy": "public", "type": { "text": "string" }, "default": "''", "attribute": "_text", "inheritedFrom": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoogleProtobufStringvalue", "declaration": { "name": "DisplayGoogleProtobufStringvalue", "module": "src/typerenderer/display-google-protobuf-stringvalue.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-stringvalue", "declaration": { "name": "DisplayGoogleProtobufStringvalue", "module": "src/typerenderer/display-google-protobuf-stringvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-timestamp.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-timestamp`\nThe display-google-protobuf-timestamp component displays a FieldNode of type `google.prtobuf.Timestamp` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoogleProtobufTimestamp", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldValue" }, { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 15.01.2017, 02:30:15", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "method", "name": "_formatDisplay" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-protobuf-timestamp", "summary": "display renderer for `google.protobuf.Timestamp`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoogleProtobufTimestamp", "declaration": { "name": "DisplayGoogleProtobufTimestamp", "module": "src/typerenderer/display-google-protobuf-timestamp.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-timestamp", "declaration": { "name": "DisplayGoogleProtobufTimestamp", "module": "src/typerenderer/display-google-protobuf-timestamp.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-uint32value.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-boolvalue`\nThe display-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Uint32Value` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufUin32value", "superclass": { "name": "DisplayUint32", "module": "/src/typerenderer/display-uint32.js" }, "tagName": "display-google-protobuf-uint32value", "summary": "display renderer for `google.protobuf.Uint32Value`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufUin32value", "declaration": { "name": "DisplayGoolgeProtobufUin32value", "module": "src/typerenderer/display-google-protobuf-uint32value.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-uint32value", "declaration": { "name": "DisplayGoolgeProtobufUin32value", "module": "src/typerenderer/display-google-protobuf-uint32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-protobuf-uint64value.js", "declarations": [ { "kind": "class", "description": "`display-google-protobuf-boolvalue`\nThe display-google-protobuf-boolvalue component displays a FieldNode of type `google.protobuf.Uint64Value` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeProtobufUin64value", "superclass": { "name": "DisplayUint64", "module": "/src/typerenderer/display-uint64.js" }, "tagName": "display-google-protobuf-uint64value", "summary": "display renderer for `google.protobuf.Uint64Value`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeProtobufUin64value", "declaration": { "name": "DisplayGoolgeProtobufUin64value", "module": "src/typerenderer/display-google-protobuf-uint64value.js" } }, { "kind": "custom-element-definition", "name": "display-google-protobuf-uint64value", "declaration": { "name": "DisplayGoolgeProtobufUin64value", "module": "src/typerenderer/display-google-protobuf-uint64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-type-color.js", "declarations": [ { "kind": "class", "description": "`display-google-type-color`\nThe display-google-type-color component displays a FieldNode of type `google.type.Color` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoolgeTypeColor", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_updateValue", "description": "update value properties rgb", "privacy": "private" }, { "kind": "method", "name": "_getTemplate", "description": "Template logic", "return": { "type": { "text": "*" } }, "privacy": "private" }, { "kind": "field", "name": "_red", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_green", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "_blue", "type": { "text": "string" }, "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-type-color", "summary": "display renderer for `google.type.Color`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoolgeTypeColor", "declaration": { "name": "DisplayGoolgeTypeColor", "module": "src/typerenderer/display-google-type-color.js" } }, { "kind": "custom-element-definition", "name": "display-google-type-color", "declaration": { "name": "DisplayGoolgeTypeColor", "module": "src/typerenderer/display-google-type-color.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-type-date.js", "declarations": [ { "kind": "class", "description": "`display-google-type-date`\nThe display-google-type-date component displays a FieldNode of type `google.type.Date` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoogleTypeDate", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_formatDisplay" }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldNode" }, { "name": "date" } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 31.12.2021", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-type-date", "summary": "display renderer for `google.type.Date`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoogleTypeDate", "declaration": { "name": "DisplayGoogleTypeDate", "module": "src/typerenderer/display-google-type-date.js" } }, { "kind": "custom-element-definition", "name": "display-google-type-date", "declaration": { "name": "DisplayGoogleTypeDate", "module": "src/typerenderer/display-google-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-type-datetime.js", "declarations": [ { "kind": "class", "description": "`display-google-type-datetime`\nComponent description here!", "name": "DisplayGoogleTypeDatetime", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ] }, { "kind": "method", "name": "_convertDateToString", "static": true, "parameters": [ { "name": "fieldValue" }, { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "convert date object to String according to Intl DateTimeFormat\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat\nExample output: locale de-CH 15.01.2017, 02:30:15", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "fieldValue" } ] }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-type-datetime", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoogleTypeDatetime", "declaration": { "name": "DisplayGoogleTypeDatetime", "module": "src/typerenderer/display-google-type-datetime.js" } }, { "kind": "custom-element-definition", "name": "display-google-type-datetime", "declaration": { "name": "DisplayGoogleTypeDatetime", "module": "src/typerenderer/display-google-type-datetime.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-type-money.js", "declarations": [ { "kind": "class", "description": "`display-google-type-money`\nThe display-google-type-money component displays a FieldNode of type `google.type.Money` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoogleTypeMoney", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_convertTypeToNumber", "static": true, "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "return": { "type": { "text": "number" } }, "privacy": "private" }, { "kind": "method", "name": "_formatDisplay" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_valueObject", "type": { "text": "{amount: number}" }, "privacy": "private", "default": "{ amount: Number.NaN }" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-type-money", "summary": "display renderer for `google.type.Money`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoogleTypeMoney", "declaration": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } }, { "kind": "custom-element-definition", "name": "display-google-type-money", "declaration": { "name": "DisplayGoogleTypeMoney", "module": "src/typerenderer/display-google-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-google-type-timeofday.js", "declarations": [ { "kind": "class", "description": "`display-google-type-timeofday`\nThe display-google-type-timeofday component displays a FieldNode of type `google.type.TimeOfDay` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayGoogleTypeTimeofday", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a field node to the component" }, { "kind": "method", "name": "_convertDayTimeToString", "static": true, "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "convert date object to String according to local time string\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString\nExample output: 1:15:30 AM by en-US", "return": { "type": { "text": "string" } }, "privacy": "private" }, { "kind": "method", "name": "_formatDisplay" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-google-type-timeofday", "summary": "display renderer for `google.type.TimeOfDay`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayGoogleTypeTimeofday", "declaration": { "name": "DisplayGoogleTypeTimeofday", "module": "src/typerenderer/display-google-type-timeofday.js" } }, { "kind": "custom-element-definition", "name": "display-google-type-timeofday", "declaration": { "name": "DisplayGoogleTypeTimeofday", "module": "src/typerenderer/display-google-type-timeofday.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-int32.js", "declarations": [ { "kind": "class", "description": "`display-int32`\nThe display-int32 component displays a FieldNode of type `int32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayInt32", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ] }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ] }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-int32", "summary": "display renderer for `int32`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayInt32", "declaration": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "custom-element-definition", "name": "display-int32", "declaration": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-int64.js", "declarations": [ { "kind": "class", "description": "`display-int64`\nThe display-int64 component displays a FieldNode of type `int64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayInt64", "superclass": { "name": "DisplayInt32", "module": "/src/typerenderer/display-int32.js" }, "tagName": "display-int64", "summary": "display renderer for `int64`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayInt64", "declaration": { "name": "DisplayInt64", "module": "src/typerenderer/display-int64.js" } }, { "kind": "custom-element-definition", "name": "display-int64", "declaration": { "name": "DisplayInt64", "module": "src/typerenderer/display-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-string.js", "declarations": [ { "kind": "class", "description": "`display-string`\nThe display-string component displays a FieldNode of type `string` in read only mode.\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayString", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ] }, { "kind": "field", "name": "_text", "privacy": "public", "type": { "text": "string" }, "default": "''", "attribute": "_text" } ], "attributes": [ { "name": "_text", "type": { "text": "string" }, "default": "''", "fieldName": "_text" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "display-string", "summary": "display renderer for `string`", "customElement": true } ], "exports": [ { "kind": "js", "name": "DisplayString", "declaration": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } }, { "kind": "custom-element-definition", "name": "display-string", "declaration": { "name": "DisplayString", "module": "src/typerenderer/display-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-uint32.js", "declarations": [ { "kind": "class", "description": "`display-uint32`\nThe display-uint32 component displays a FieldNode of type `uint32` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayUint32", "superclass": { "name": "DisplayInt32", "module": "/src/typerenderer/display-int32.js" }, "tagName": "display-uint32", "summary": "display renderer for `uint32`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayUint32", "declaration": { "name": "DisplayUint32", "module": "src/typerenderer/display-uint32.js" } }, { "kind": "custom-element-definition", "name": "display-uint32", "declaration": { "name": "DisplayUint32", "module": "src/typerenderer/display-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/display-uint64.js", "declarations": [ { "kind": "class", "description": "`display-uint64`\nThe display-uint64 component displays a FieldNode of type `uint64` in read only mode.\n\nThe component uses locale from the environment to display the date value accordingly.\nhttps://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat\n\nEvery display-xxx component should implement the following API:\n- function: bindData(fieldNode){...}", "name": "DisplayUint64", "superclass": { "name": "DisplayInt32", "module": "/src/typerenderer/display-int32.js" }, "tagName": "display-uint64", "summary": "display renderer for `uint64`", "customElement": true, "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "value" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "method", "name": "_formatDisplay", "parameters": [ { "name": "number" } ], "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "inheritedFrom": { "name": "DisplayInt32", "module": "src/typerenderer/display-int32.js" } } ] } ], "exports": [ { "kind": "js", "name": "DisplayUint64", "declaration": { "name": "DisplayUint64", "module": "src/typerenderer/display-uint64.js" } }, { "kind": "custom-element-definition", "name": "display-uint64", "declaration": { "name": "DisplayUint64", "module": "src/typerenderer/display-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-bool.js", "declarations": [ { "kind": "class", "description": "`form-bool` is a `form` context renderer.\n\nIt uses furo-ui5-checkbox-input as the renderer", "name": "FormBool", "superclass": { "name": "FuroUi5CheckboxInputLabeled", "module": "/src/furo-ui5-checkbox-input-labeled.js" }, "tagName": "form-bool", "summary": "form renderer for `bool`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "placeholder", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "fieldName": "placeholder", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "Supported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "attribute": "placeholder", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormBool", "declaration": { "name": "FormBool", "module": "src/typerenderer/form-bool.js" } }, { "kind": "custom-element-definition", "name": "form-bool", "declaration": { "name": "FormBool", "module": "src/typerenderer/form-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-double.js", "declarations": [ { "kind": "class", "description": "", "name": "FormDouble", "superclass": { "name": "FuroUi5NumberInputLabeled", "module": "/src/furo-ui5-number-input-labeled.js" }, "tagName": "form-double", "summary": "form renderer for `double`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormDouble", "declaration": { "name": "FormDouble", "module": "src/typerenderer/form-double.js" } }, { "kind": "custom-element-definition", "name": "form-double", "declaration": { "name": "FormDouble", "module": "src/typerenderer/form-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-float.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFloat", "superclass": { "name": "FuroUi5NumberInputLabeled", "module": "/src/furo-ui5-number-input-labeled.js" }, "tagName": "form-float", "summary": "form renderer for `float`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFloat", "declaration": { "name": "FormFloat", "module": "src/typerenderer/form-float.js" } }, { "kind": "custom-element-definition", "name": "form-float", "declaration": { "name": "FormFloat", "module": "src/typerenderer/form-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-bigdecimal.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroBigdecimal", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-bigdecimal", "summary": "form renderer for type `furo.BigDecimal`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroBigdecimal", "declaration": { "name": "FormFuroBigdecimal", "module": "src/typerenderer/form-furo-bigdecimal.js" } }, { "kind": "custom-element-definition", "name": "form-furo-bigdecimal", "declaration": { "name": "FormFuroBigdecimal", "module": "src/typerenderer/form-furo-bigdecimal.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-bool.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-bool` is a `form` context renderer.\n\nIt uses furo-ui5-checkbox-input as the renderer", "name": "FormFuroFatBool", "superclass": { "name": "FormBool", "module": "/src/typerenderer/form-bool.js" }, "tagName": "form-furo-fat-bool", "summary": "form renderer for `furo.fat.Bool`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "placeholder", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "fieldName": "placeholder", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "Supported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "attribute": "placeholder", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatBool", "declaration": { "name": "FormFuroFatBool", "module": "src/typerenderer/form-furo-fat-bool.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-bool", "declaration": { "name": "FormFuroFatBool", "module": "src/typerenderer/form-furo-fat-bool.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-double.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-double` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroFatDouble", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-fat-double", "summary": "form renderer for `furo.fat.Double`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatDouble", "declaration": { "name": "FormFuroFatDouble", "module": "src/typerenderer/form-furo-fat-double.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-double", "declaration": { "name": "FormFuroFatDouble", "module": "src/typerenderer/form-furo-fat-double.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-float.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-float` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroFatFloat", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-fat-float", "summary": "form renderer for `furo.fat.Float`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatFloat", "declaration": { "name": "FormFuroFatFloat", "module": "src/typerenderer/form-furo-fat-float.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-float", "declaration": { "name": "FormFuroFatFloat", "module": "src/typerenderer/form-furo-fat-float.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-int32.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-int32` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroFatInt32", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-fat-int32", "summary": "form renderer for `furo.fat.Int32`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatInt32", "declaration": { "name": "FormFuroFatInt32", "module": "src/typerenderer/form-furo-fat-int32.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-int32", "declaration": { "name": "FormFuroFatInt32", "module": "src/typerenderer/form-furo-fat-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-int64.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-int64` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroFatInt64", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-fat-int64", "summary": "form renderer for `furo.fat.Int64`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatInt64", "declaration": { "name": "FormFuroFatInt64", "module": "src/typerenderer/form-furo-fat-int64.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-int64", "declaration": { "name": "FormFuroFatInt64", "module": "src/typerenderer/form-furo-fat-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-string.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroFatString", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-combobox component", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "descFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "attribute": "desc-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "superclass": { "name": "FuroUi5TextInputLabeled", "module": "/src/furo-ui5-text-input-labeled.js" }, "tagName": "form-furo-fat-string", "summary": "form renderer for `furo.fat.String`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "desc-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "fieldName": "descFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatString", "declaration": { "name": "FormFuroFatString", "module": "src/typerenderer/form-furo-fat-string.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-string", "declaration": { "name": "FormFuroFatString", "module": "src/typerenderer/form-furo-fat-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-uint32.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-uint32` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroFatUint32", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-fat-uint32", "summary": "form renderer for `furo.fat.Uint32`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatUint32", "declaration": { "name": "FormFuroFatUint32", "module": "src/typerenderer/form-furo-fat-uint32.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-uint32", "declaration": { "name": "FormFuroFatUint32", "module": "src/typerenderer/form-furo-fat-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-fat-uint64.js", "declarations": [ { "kind": "class", "description": "`form-furo-fat-uint64` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroFatUint64", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-fat-uint64", "summary": "form renderer for `furo.fat.Uint64`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroFatUint64", "declaration": { "name": "FormFuroFatUint64", "module": "src/typerenderer/form-furo-fat-uint64.js" } }, { "kind": "custom-element-definition", "name": "form-furo-fat-uint64", "declaration": { "name": "FormFuroFatUint64", "module": "src/typerenderer/form-furo-fat-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-integerproperty.js", "declarations": [ { "kind": "class", "description": "`form-furo-integerproperty` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroIntegerproperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-integerproperty", "summary": "form renderer for `furo.Integerproperty`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroIntegerproperty", "declaration": { "name": "FormFuroIntegerproperty", "module": "src/typerenderer/form-furo-integerproperty.js" } }, { "kind": "custom-element-definition", "name": "form-furo-integerproperty", "declaration": { "name": "FormFuroIntegerproperty", "module": "src/typerenderer/form-furo-integerproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-numberproperty.js", "declarations": [ { "kind": "class", "description": "`form-furo-integerproperty` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormFuroNumberproperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-furo-integerproperty", "summary": "form renderer for `furo.Integerproperty`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroNumberproperty", "declaration": { "name": "FormFuroNumberproperty", "module": "src/typerenderer/form-furo-numberproperty.js" } }, { "kind": "custom-element-definition", "name": "form-furo-numberproperty", "declaration": { "name": "FormFuroNumberproperty", "module": "src/typerenderer/form-furo-numberproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-reference.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroReference", "superclass": { "name": "FuroUi5ReferenceSearchLabeled", "module": "/src/furo-ui5-reference-search-labeled.js" }, "tagName": "form-furo-reference", "summary": "form renderer for `furo.Reference`", "customElement": true, "attributes": [ { "name": "service", "type": { "text": "string" }, "description": "the service name", "default": "''", "fieldName": "service", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "method", "type": { "text": "string" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "default": "''", "fieldName": "method", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "label", "type": { "text": "string" }, "description": "the label for the data-reference-search", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "fieldName": "valueFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "search-response-path", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "fieldName": "searchResponsePath", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "extended-value-field-path", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "fieldName": "extendedValueFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "extended-display-field-path", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "fieldName": "extendedDisplayFieldPath", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "placeholder", "type": { "text": "String" }, "description": "Overrides the hint text from the **specs**.\nUse with caution, normally the specs defines this value.", "fieldName": "placeholder", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "disable-search-list", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "fieldName": "disableSearchList", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "Readonly state", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "extended-searcher", "type": { "text": "string" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "default": "''", "fieldName": "extendedSearcher", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "name": "no-data-text", "type": { "text": "String" }, "description": "hint text when result not found by search", "fieldName": "noDataText", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "method", "name": "clearResultList", "description": "clearResultList clears the result list and the value state", "privacy": "public", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: can be a `scalar` type or any complex type with **{'id','display_name'}** signature.", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "method", "name": "setFilter", "parameters": [ { "name": "filter" } ], "description": "sets the filter to the inner furo-ui5-reference-search", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "noDataText", "privacy": "public", "type": { "text": "String" }, "description": "hint text when result not found by search", "attribute": "no-data-text", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "service", "privacy": "public", "type": { "text": "string" }, "description": "the service name", "default": "''", "attribute": "service", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-reference-search", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "method", "privacy": "public", "type": { "text": "string" }, "description": "Set the method. This is only needed when your service is not named \"List\".\nThis is not the http method.", "default": "''", "attribute": "method", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "extendedSearcher", "privacy": "public", "type": { "text": "string" }, "description": "Define the extended searcher. Do not forget to import the searcher you want to use.", "default": "''", "attribute": "extended-searcher", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "disableSearchList", "privacy": "public", "type": { "text": "boolean" }, "description": "A Boolean attribute which, if present, means this field can not be searched.\n\nThis is very useful when you want enforce the usage of the extended search", "default": "false", "attribute": "disable-search-list", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Use this attribute to set a custom icon for your searcher", "default": "'search'", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "searchResponsePath", "privacy": "public", "type": { "text": "string" }, "description": "Path to the node in the response value which contains the array with the selection items.\nBy default this goes to *entitites*", "default": "'entities'", "attribute": "search-response-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item which is used for the id.\nBy default this goes to *data.id*", "default": "'data.id'", "attribute": "value-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to selection value node which is used for the display.\nBy default this goes to *data.display_name*", "default": "'data.display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "extendedValueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the id.\nBy default this goes to *data.id*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.id'", "attribute": "extended-value-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "extendedDisplayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Path to response value item of the exteded search which is used for the display.\nBy default this goes to *data.display_name*.\nOnly needed when your extended searcher does not have the id, display_name signature in the response.", "default": "'data.display_name'", "attribute": "extended-display-field-path", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "String" }, "description": "Overrides the hint text from the **specs**.\nUse with caution, normally the specs defines this value.", "attribute": "placeholder", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "Readonly state", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5ReferenceSearchLabeled", "module": "src/furo-ui5-reference-search-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroReference", "declaration": { "name": "FormFuroReference", "module": "src/typerenderer/form-furo-reference.js" } }, { "kind": "custom-element-definition", "name": "form-furo-reference", "declaration": { "name": "FormFuroReference", "module": "src/typerenderer/form-furo-reference.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-stringoptionproperty.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroStringoptionproperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "method", "name": "setOptions", "parameters": [ { "name": "arr" }, { "description": "raw data array with a id, display_name signature", "name": "rawJson", "optional": true } ], "description": "inject raw data as options", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-select component", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "idFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid", "default": "'id'", "attribute": "id-field-path", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "valueFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.", "default": "'id'", "attribute": "value-field-path", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } } ], "superclass": { "name": "FuroUi5SelectLabeled", "module": "/src/furo-ui5-select-labeled.js" }, "tagName": "form-furo-stringoptionproperty", "summary": "form renderer for `furo.Stringoptionproperty`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "id-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to identify the option items.\nPoint-separated path to the field\nE.g. data.partner.ulid", "default": "'id'", "fieldName": "idFieldPath", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } }, { "name": "value-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used to update the bound component if the user has selected an option.\nPoint-separated path to the field\nMust be set if a data binding is specified.", "default": "'id'", "fieldName": "valueFieldPath", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5SelectLabeled", "module": "src/furo-ui5-select-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroStringoptionproperty", "declaration": { "name": "FormFuroStringoptionproperty", "module": "src/typerenderer/form-furo-stringoptionproperty.js" } }, { "kind": "custom-element-definition", "name": "form-furo-stringoptionproperty", "declaration": { "name": "FormFuroStringoptionproperty", "module": "src/typerenderer/form-furo-stringoptionproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-stringproperty.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroStringproperty", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-combobox component", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "descFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "attribute": "desc-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "superclass": { "name": "FuroUi5TextInputLabeled", "module": "/src/furo-ui5-text-input-labeled.js" }, "tagName": "form-furo-stringproperty", "summary": "form renderer for `furo.Stringproperty`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "desc-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "fieldName": "descFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroStringproperty", "declaration": { "name": "FormFuroStringproperty", "module": "src/typerenderer/form-furo-stringproperty.js" } }, { "kind": "custom-element-definition", "name": "form-furo-stringproperty", "declaration": { "name": "FormFuroStringproperty", "module": "src/typerenderer/form-furo-stringproperty.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-type-date.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroTypeDate", "superclass": { "name": "FuroUi5DatePickerLabeled", "module": "/src/furo-ui5-date-picker-labeled.js" }, "tagName": "form-furo-type-date", "summary": "form renderer for `furo.type.Date`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroTypeDate", "declaration": { "name": "FormFuroTypeDate", "module": "src/typerenderer/form-furo-type-date.js" } }, { "kind": "custom-element-definition", "name": "form-furo-type-date", "declaration": { "name": "FormFuroTypeDate", "module": "src/typerenderer/form-furo-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-furo-type-money.js", "declarations": [ { "kind": "class", "description": "", "name": "FormFuroTypeMoney", "superclass": { "name": "FuroUi5MoneyInputLabeled", "module": "/src/furo-ui5-money-input-labeled.js" }, "tagName": "form-furo-type-money", "summary": "form renderer for `furo.type.Money`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-money-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types: `google.type.Money`", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-money-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ], "events": [ { "type": { "text": "google.type.Money" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormFuroTypeMoney", "declaration": { "name": "FormFuroTypeMoney", "module": "src/typerenderer/form-furo-type-money.js" } }, { "kind": "custom-element-definition", "name": "form-furo-type-money", "declaration": { "name": "FormFuroTypeMoney", "module": "src/typerenderer/form-furo-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-boolvalue.js", "declarations": [ { "kind": "class", "description": "`form-google-protobuf-boolvalue` is a `form` context renderer.\n\nIt uses furo-ui5-checkbox-input as the renderer", "name": "FormGoogleProtobufBoolvalue", "superclass": { "name": "FormBool", "module": "/src/typerenderer/form-bool.js" }, "tagName": "form-google-protobuf-boolvalue", "summary": "form renderer for `google.protobuf.BoolValue`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "placeholder", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "fieldName": "placeholder", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "Supported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-checkbox-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "String" }, "description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox.", "attribute": "placeholder", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5CheckboxInputLabeled", "module": "src/furo-ui5-checkbox-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleProtobufBoolvalue", "declaration": { "name": "FormGoogleProtobufBoolvalue", "module": "src/typerenderer/form-google-protobuf-boolvalue.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-boolvalue", "declaration": { "name": "FormGoogleProtobufBoolvalue", "module": "src/typerenderer/form-google-protobuf-boolvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-doublevalue.js", "declarations": [ { "kind": "class", "description": "`form-google-protobuf-doublevalue` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormGoogleProtobufDoublevalue", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-google-protobuf-doublevalue", "summary": "form renderer for `google.protobuf.Double`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleProtobufDoublevalue", "declaration": { "name": "FormGoogleProtobufDoublevalue", "module": "src/typerenderer/form-google-protobuf-doublevalue.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-doublevalue", "declaration": { "name": "FormGoogleProtobufDoublevalue", "module": "src/typerenderer/form-google-protobuf-doublevalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-floatvalue.js", "declarations": [ { "kind": "class", "description": "`form-google-protobuf-floatvalue` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormGoolgeProtobufFloatvalue", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-google-protobuf-floatvalue", "summary": "form renderer for `google.protobuf.FloatValue`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoolgeProtobufFloatvalue", "declaration": { "name": "FormGoolgeProtobufFloatvalue", "module": "src/typerenderer/form-google-protobuf-floatvalue.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-floatvalue", "declaration": { "name": "FormGoolgeProtobufFloatvalue", "module": "src/typerenderer/form-google-protobuf-floatvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-int32value.js", "declarations": [ { "kind": "class", "description": "`form-google-protobuf-int32value` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormGoolgeProtobufIn32value", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-google-protobuf-int32value", "summary": "form renderer for `google.protobuf.Int32Value`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoolgeProtobufIn32value", "declaration": { "name": "FormGoolgeProtobufIn32value", "module": "src/typerenderer/form-google-protobuf-int32value.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-int32value", "declaration": { "name": "FormGoolgeProtobufIn32value", "module": "src/typerenderer/form-google-protobuf-int32value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-int64value.js", "declarations": [ { "kind": "class", "description": "`form-google-protobuf-int64value` is a `form` context renderer.\n\nIt uses furo-ui5-number-input as the renderer", "name": "FormGoolgeProtobufIn64value", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-google-protobuf-int64value", "summary": "form renderer for `google.protobuf.Int64Value`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoolgeProtobufIn64value", "declaration": { "name": "FormGoolgeProtobufIn64value", "module": "src/typerenderer/form-google-protobuf-int64value.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-int64value", "declaration": { "name": "FormGoolgeProtobufIn64value", "module": "src/typerenderer/form-google-protobuf-int64value.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-stringvalue.js", "declarations": [ { "kind": "class", "description": "", "name": "FormGoogleProtobufStringvalue", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-combobox component", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "descFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "attribute": "desc-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "superclass": { "name": "FuroUi5TextInputLabeled", "module": "/src/furo-ui5-text-input-labeled.js" }, "tagName": "form-google-protobuf-stringValue", "summary": "form renderer for `google.protobuf.StringValue`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "desc-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "fieldName": "descFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleProtobufStringvalue", "declaration": { "name": "FormGoogleProtobufStringvalue", "module": "src/typerenderer/form-google-protobuf-stringvalue.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-stringvalue", "declaration": { "name": "FormGoogleProtobufStringvalue", "module": "src/typerenderer/form-google-protobuf-stringvalue.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-protobuf-timestamp.js", "declarations": [ { "kind": "class", "description": "", "name": "FormGoogleProtobufTimestamp", "superclass": { "name": "FuroUi5DateTimePickerLabeled", "module": "/src/furo-ui5-date-time-picker-labeled.js" }, "tagName": "form-google-protobuf-timestamp", "summary": "form renderer for `google.protobuf.Timestamp`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "name": "format-pattern", "type": { "text": "string" }, "description": "Determines the format, displayed in the input field.", "fieldName": "formatPattern", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "description": "of type : `string`, `google.protobuf.Timestamp`, `int32`, `int64`", "type": { "text": "FieldNode" } } ], "description": "Binds a FieldNode to the component.\n\nSupported types: `string`, `google.protobuf.Timestamp`, `int32`, `int64`", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } }, { "kind": "field", "name": "formatPattern", "privacy": "public", "type": { "text": "string" }, "description": "Determines the format, displayed in the input field.", "attribute": "format-pattern", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5DateTimePickerLabeled", "module": "src/furo-ui5-date-time-picker-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleProtobufTimestamp", "declaration": { "name": "FormGoogleProtobufTimestamp", "module": "src/typerenderer/form-google-protobuf-timestamp.js" } }, { "kind": "custom-element-definition", "name": "form-google-protobuf-timestamp", "declaration": { "name": "FormGoogleProtobufTimestamp", "module": "src/typerenderer/form-google-protobuf-timestamp.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-type-date.js", "declarations": [ { "kind": "class", "description": "`form-google-type-date` is a `form` context renderer.\n\nIt uses furo-ui5-date-picker as the renderer", "name": "FormGoogleTypeDate", "superclass": { "name": "FuroUi5DatePickerLabeled", "module": "/src/furo-ui5-date-picker-labeled.js" }, "tagName": "form-google-type-date", "summary": "form renderer for `google.type.Date`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5DatePickerLabeled", "module": "src/furo-ui5-date-picker-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleTypeDate", "declaration": { "name": "FormGoogleTypeDate", "module": "src/typerenderer/form-google-type-date.js" } }, { "kind": "custom-element-definition", "name": "form-google-type-date", "declaration": { "name": "FormGoogleTypeDate", "module": "src/typerenderer/form-google-type-date.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-type-money.js", "declarations": [ { "kind": "class", "description": "`form-google-type-money` is a `form` context renderer.\n\nIt uses furo-ui5-money-input as the renderer", "name": "FormGoogleTypeMoney", "superclass": { "name": "FuroUi5MoneyInputLabeled", "module": "/src/furo-ui5-money-input-labeled.js" }, "tagName": "form-google-type-money", "summary": "form renderer for `google.type.Money`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-money-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types: `google.type.Money`", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-money-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ], "events": [ { "type": { "text": "google.type.Money" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5MoneyInputLabeled", "module": "src/furo-ui5-money-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleTypeMoney", "declaration": { "name": "FormGoogleTypeMoney", "module": "src/typerenderer/form-google-type-money.js" } }, { "kind": "custom-element-definition", "name": "form-google-type-money", "declaration": { "name": "FormGoogleTypeMoney", "module": "src/typerenderer/form-google-type-money.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-google-type-timeofday.js", "declarations": [ { "kind": "class", "description": "`form-google-type-timeofday` is a `form` context renderer.\n\nIt uses furo-ui5-time-picker as the renderer", "name": "FormGoogleTypeTimeofday", "superclass": { "name": "FuroUi5TimePickerLabeled", "module": "/src/furo-ui5-time-picker-labeled.js" }, "tagName": "form-google-type-timeofday", "summary": "form renderer for `google.type.TimeOfDay`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "name": "format-pattern", "type": { "text": "String" }, "description": "forwards the format-pattern to the furo-ui5-time-picker component.", "fieldName": "formatPattern", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } } ], "members": [ { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-date-picker", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "field", "name": "formatPattern", "privacy": "public", "type": { "text": "String" }, "description": "forwards the format-pattern to the furo-ui5-time-picker component.", "attribute": "format-pattern", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes in ISO 8601 format.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TimePickerLabeled", "module": "src/furo-ui5-time-picker-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormGoogleTypeTimeofday", "declaration": { "name": "FormGoogleTypeTimeofday", "module": "src/typerenderer/form-google-type-timeofday.js" } }, { "kind": "custom-element-definition", "name": "form-google-type-timeofday", "declaration": { "name": "FormGoogleTypeTimeofday", "module": "src/typerenderer/form-google-type-timeofday.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-int32.js", "declarations": [ { "kind": "class", "description": "", "name": "FormInt32", "superclass": { "name": "FuroUi5NumberInputLabeled", "module": "/src/furo-ui5-number-input-labeled.js" }, "tagName": "form-int32", "summary": "form renderer for `int32`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormInt32", "declaration": { "name": "FormInt32", "module": "src/typerenderer/form-int32.js" } }, { "kind": "custom-element-definition", "name": "form-int32", "declaration": { "name": "FormInt32", "module": "src/typerenderer/form-int32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-int64.js", "declarations": [ { "kind": "class", "description": "", "name": "FormInt64", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-int64", "summary": "form renderer for `int64`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormInt64", "declaration": { "name": "FormInt64", "module": "src/typerenderer/form-int64.js" } }, { "kind": "custom-element-definition", "name": "form-int64", "declaration": { "name": "FormInt64", "module": "src/typerenderer/form-int64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-string.js", "declarations": [ { "kind": "class", "description": "", "name": "FormString", "superclass": { "name": "FuroUi5TextInputLabeled", "module": "/src/furo-ui5-text-input-labeled.js" }, "tagName": "form-string", "summary": "form renderer for `string`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "display-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "fieldName": "displayFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "name": "desc-field-path", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "fieldName": "descFieldPath", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "method", "name": "bindOptions", "parameters": [ { "name": "repeaterNode" } ], "description": "Binds a repeaterNode to the furo-ui5-combobox component", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-text-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "descFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the bound RepeaterNode (bindOptions) to display the additional\ndescription of the option items.\nPoint-separated path to the field\nE.g. data.partner.id\ndefault: id\nThis attribute is related to the option list", "default": "'id'", "attribute": "desc-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "displayFieldPath", "privacy": "public", "type": { "text": "string" }, "description": "Defines the field path that is used from the injected RepeaterNode to display the option items.\nPoint-separated path to the field\nE.g. data.partner.display_name", "default": "'display_name'", "attribute": "display-field-path", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ], "events": [ { "type": { "text": "String" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5TextInputLabeled", "module": "src/furo-ui5-text-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormString", "declaration": { "name": "FormString", "module": "src/typerenderer/form-string.js" } }, { "kind": "custom-element-definition", "name": "form-string", "declaration": { "name": "FormString", "module": "src/typerenderer/form-string.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-uint32.js", "declarations": [ { "kind": "class", "description": "", "name": "FormUint32", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-uint32", "summary": "form renderer for `uint32`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormUint32", "declaration": { "name": "FormUint32", "module": "src/typerenderer/form-uint32.js" } }, { "kind": "custom-element-definition", "name": "form-uint32", "declaration": { "name": "FormUint32", "module": "src/typerenderer/form-uint32.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/form-uint64.js", "declarations": [ { "kind": "class", "description": "", "name": "FormUint64", "superclass": { "name": "FormInt32", "module": "/src/typerenderer/form-int32.js" }, "tagName": "form-uint64", "summary": "form renderer for `uint64`", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "fieldName": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "full", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "fieldName": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "required", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "fieldName": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "disabled", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "fieldName": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "readonly", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "fieldName": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "name": "icon", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "fieldName": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "members": [ { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "description": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus", "type": { "text": "Object" } } ], "description": "Focuses the underlying ui5 input element", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method", "privacy": "private", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode", "type": { "text": "FieldNode" } } ], "description": "Orchestrates the data field connection to the inside\nSupported types:\ndouble, float, int32, uint32, sint32, fixed32, sfixed32, int64, uint64, sint64, fixed64, sfixed64\ngoogle.protobuf.DoubleValue, google.protobuf.FloatValue, google.protobuf.Int32Value, etc.\nfuro.fat.Doube, furo.fat.Float, furo.fat.Int32, etc.", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "the label for the data-number-input", "default": "''", "attribute": "label", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "string" }, "description": "Icon on the right side", "default": "''", "attribute": "icon", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "full", "privacy": "public", "type": { "text": "boolean" }, "description": "This is only used to forward the state to the form-field-container", "attribute": "full", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is required and marked with *.", "attribute": "required", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field cannot be edited by the user and\nappears in disabled state.", "attribute": "disabled", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "Boolean" }, "description": "A Boolean attribute which, if present, means this field is readonly.", "attribute": "readonly", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ], "events": [ { "type": { "text": "Number" }, "description": "Fires the field value when it changes.", "name": "furo-value-changed", "inheritedFrom": { "name": "FuroUi5NumberInputLabeled", "module": "src/furo-ui5-number-input-labeled.js" } } ] } ], "exports": [ { "kind": "js", "name": "FormUint64", "declaration": { "name": "FormUint64", "module": "src/typerenderer/form-uint64.js" } }, { "kind": "custom-element-definition", "name": "form-uint64", "declaration": { "name": "FormUint64", "module": "src/typerenderer/form-uint64.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/furo-catalog.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/typerenderer/line-launchpad-launchtile.js", "declarations": [ { "kind": "class", "description": "`line-launchpad-launchtile`\ntodo Describe your element", "name": "LineLaunchpadLaunchtile", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" }, { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "todo shortdescription", "tagName": "line-launchpad-launchtile", "customElement": true } ], "exports": [ { "kind": "js", "name": "LineLaunchpadLaunchtile", "declaration": { "name": "LineLaunchpadLaunchtile", "module": "src/typerenderer/line-launchpad-launchtile.js" } }, { "kind": "custom-element-definition", "name": "line-launchpad-launchtile", "declaration": { "name": "LineLaunchpadLaunchtile", "module": "src/typerenderer/line-launchpad-launchtile.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/line-launchpad-monitortile.js", "declarations": [ { "kind": "class", "description": "`line-launchpad-monitortile`\ntodo Describe your element", "name": "LineLaunchpadMonitortile", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ] }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" }, { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "todo shortdescription", "tagName": "line-launchpad-monitortile", "customElement": true } ], "exports": [ { "kind": "js", "name": "LineLaunchpadMonitortile", "declaration": { "name": "LineLaunchpadMonitortile", "module": "src/typerenderer/line-launchpad-monitortile.js" } }, { "kind": "custom-element-definition", "name": "line-launchpad-monitortile", "declaration": { "name": "LineLaunchpadMonitortile", "module": "src/typerenderer/line-launchpad-monitortile.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/registry.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/typerenderer/tile-launchpad-launchtile.js", "declarations": [ { "kind": "class", "description": "`tile-launchpad-launchtile`\ntodo Describe your element", "name": "TileLaunchpadLaunchtile", "members": [ { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "focus", "description": "focus focuses the table", "privacy": "public" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" }, { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "todo shortdescription", "tagName": "tile-launchpad-launchtile", "customElement": true } ], "exports": [ { "kind": "js", "name": "TileLaunchpadLaunchtile", "declaration": { "name": "TileLaunchpadLaunchtile", "module": "src/typerenderer/tile-launchpad-launchtile.js" } }, { "kind": "custom-element-definition", "name": "tile-launchpad-launchtile", "declaration": { "name": "TileLaunchpadLaunchtile", "module": "src/typerenderer/tile-launchpad-launchtile.js" } } ] }, { "kind": "javascript-module", "path": "src/typerenderer/tile-launchpad-monitortile.js", "declarations": [ { "kind": "class", "description": "`tile-launchpad-monitortile`\ntodo Describe your element", "name": "TileLaunchpadMonitortile", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldNode" } ] }, { "kind": "method", "name": "onFnaFieldValueChanged", "parameters": [ { "name": "val" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "focus", "description": "focus focuses the table", "privacy": "public" } ], "mixins": [ { "name": "FieldNodeAdapter", "package": "@furo/data/src/lib/FieldNodeAdapter.js" }, { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "todo shortdescription", "tagName": "tile-launchpad-monitortile", "customElement": true } ], "exports": [ { "kind": "js", "name": "TileLaunchpadMonitortile", "declaration": { "name": "TileLaunchpadMonitortile", "module": "src/typerenderer/tile-launchpad-monitortile.js" } }, { "kind": "custom-element-definition", "name": "tile-launchpad-monitortile", "declaration": { "name": "TileLaunchpadMonitortile", "module": "src/typerenderer/tile-launchpad-monitortile.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/dialog-manage-views-deletebutton.js", "declarations": [ { "kind": "class", "description": "`DialogManageViewsDeletebutton` is a helper component", "name": "DialogManageViewsDeletebutton", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "fn" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "myBool", "privacy": "public", "type": { "text": "boolean" }, "description": "Description", "attribute": "myBool" } ], "events": [ { "name": "standard-deleted", "type": { "text": "Event" } } ], "attributes": [ { "name": "myBool", "type": { "text": "boolean" }, "description": "Description", "fieldName": "myBool" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "dialog-manage-views-deletebutton", "customElement": true } ], "exports": [ { "kind": "js", "name": "DialogManageViewsDeletebutton", "declaration": { "name": "DialogManageViewsDeletebutton", "module": "src/furo-ui5-views/helper/dialog-manage-views-deletebutton.js" } }, { "kind": "custom-element-definition", "name": "dialog-manage-views-deletebutton", "declaration": { "name": "DialogManageViewsDeletebutton", "module": "src/furo-ui5-views/helper/dialog-manage-views-deletebutton.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/dialog-manage-views.js", "declarations": [ { "kind": "class", "description": "`DialogManageViews` is a helper component", "name": "DialogManageViews", "members": [ { "kind": "method", "name": "show", "description": "show", "privacy": "public" }, { "kind": "method", "name": "close", "description": "close", "privacy": "public" }, { "kind": "method", "name": "bindData", "parameters": [ { "name": "fieldnode" } ], "description": "bindData", "privacy": "public" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "manageViewHeaderText", "privacy": "public", "type": { "text": "string" }, "default": "'Manage Views'", "attribute": "manage-view-header-text" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "type": { "text": "string" }, "default": "'Search'", "attribute": "placeholder-search" }, { "kind": "field", "name": "colheaderDefault", "privacy": "public", "type": { "text": "string" }, "default": "'Default'", "attribute": "colheader-default" }, { "kind": "field", "name": "colheaderApply", "privacy": "public", "type": { "text": "string" }, "default": "'Apply Automatically'", "attribute": "colheader-apply" }, { "kind": "field", "name": "colheaderCreator", "privacy": "public", "type": { "text": "string" }, "default": "'Created By'", "attribute": "colheader-creator" }, { "kind": "field", "name": "colheaderView", "privacy": "public", "type": { "text": "string" }, "default": "'View'", "attribute": "colheader-view" }, { "kind": "field", "name": "okButtonText", "privacy": "public", "type": { "text": "string" }, "default": "'Ok'", "attribute": "ok-button-text" }, { "kind": "field", "name": "cancelButtonText", "privacy": "public", "type": { "text": "string" }, "description": "Description", "default": "'Cancel'", "attribute": "cancel-button-text" } ], "attributes": [ { "name": "cancel-button-text", "type": { "text": "string" }, "description": "Description", "default": "'Cancel'", "fieldName": "cancelButtonText" }, { "name": "manage-view-header-text", "type": { "text": "string" }, "default": "'Manage Views'", "fieldName": "manageViewHeaderText" }, { "name": "placeholder-search", "type": { "text": "string" }, "default": "'Search'", "fieldName": "placeholderSearch" }, { "name": "colheader-default", "type": { "text": "string" }, "default": "'Default'", "fieldName": "colheaderDefault" }, { "name": "colheader-apply", "type": { "text": "string" }, "default": "'Apply Automatically'", "fieldName": "colheaderApply" }, { "name": "colheader-creator", "type": { "text": "string" }, "default": "'Created By'", "fieldName": "colheaderCreator" }, { "name": "colheader-view", "type": { "text": "string" }, "default": "'View'", "fieldName": "colheaderView" }, { "name": "ok-button-text", "type": { "text": "string" }, "default": "'Ok'", "fieldName": "okButtonText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "dialog-manage-views", "customElement": true } ], "exports": [ { "kind": "js", "name": "DialogManageViews", "declaration": { "name": "DialogManageViews", "module": "src/furo-ui5-views/helper/dialog-manage-views.js" } }, { "kind": "custom-element-definition", "name": "dialog-manage-views", "declaration": { "name": "DialogManageViews", "module": "src/furo-ui5-views/helper/dialog-manage-views.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/filter/helper-dialog-filter-settings.js", "declarations": [ { "kind": "class", "description": "`DialogFilterSettings`\nis a helper component for `FuroUi5ViewsFilterSettings`", "name": "HelperDialogFilterSettings", "members": [ { "kind": "method", "name": "bindFilter", "parameters": [ { "name": "fieldnode" } ], "description": "bindFilter", "privacy": "public" }, { "kind": "method", "name": "dialogOpened", "description": "Trigger this method after the dialog (parent) is opened." }, { "kind": "method", "name": "bindSettings", "parameters": [ { "name": "e", "description": "complete event" } ], "description": "bindSettings", "privacy": "public" }, { "kind": "method", "name": "moveNode", "parameters": [ { "name": "fromIndex" }, { "name": "toIndex" } ] }, { "kind": "method", "name": "_updateSettings" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "colheaderField", "privacy": "public", "type": { "text": "string" }, "default": "'Field'", "attribute": "colheader-field" }, { "kind": "field", "name": "colheaderPosition", "privacy": "public", "type": { "text": "string" }, "default": "'Position'", "attribute": "colheader-position" }, { "kind": "field", "name": "colheaderValue", "privacy": "public", "type": { "text": "string" }, "default": "'Value'", "attribute": "colheader-value" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "type": { "text": "string" }, "default": "'Search'", "attribute": "placeholder-search" }, { "kind": "field", "name": "headerText", "privacy": "public", "type": { "text": "string" }, "default": "'Adapt Filter'", "attribute": "filtersettings-header-text" } ], "attributes": [ { "name": "colheader-field", "type": { "text": "string" }, "default": "'Field'", "fieldName": "colheaderField" }, { "name": "colheader-position", "type": { "text": "string" }, "default": "'Position'", "fieldName": "colheaderPosition" }, { "name": "colheader-value", "type": { "text": "string" }, "default": "'Value'", "fieldName": "colheaderValue" }, { "name": "placeholder-search", "type": { "text": "string" }, "default": "'Search'", "fieldName": "placeholderSearch" }, { "name": "filtersettings-header-text", "type": { "text": "string" }, "default": "'Adapt Filter'", "fieldName": "headerText" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "dialog-filter-settings", "customElement": true } ], "exports": [ { "kind": "js", "name": "HelperDialogFilterSettings", "declaration": { "name": "HelperDialogFilterSettings", "module": "src/furo-ui5-views/helper/filter/helper-dialog-filter-settings.js" } }, { "kind": "custom-element-definition", "name": "dialog-filter-settings", "declaration": { "name": "HelperDialogFilterSettings", "module": "src/furo-ui5-views/helper/filter/helper-dialog-filter-settings.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/table/furo-ui5-set-fieldorder.js", "declarations": [ { "kind": "class", "description": "`FuroUi5SetFieldorder` is a helper component", "name": "FuroUi5SetFieldorder", "members": [ { "kind": "method", "name": "injectItems", "parameters": [ { "name": "fieldnode" } ], "description": "bindData", "privacy": "public" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "type": { "text": "string" }, "attribute": "placeholder-search" }, { "kind": "field", "name": "colheaderField", "privacy": "public", "type": { "text": "string" }, "attribute": "colheader-field" }, { "kind": "field", "name": "colheaderPosition", "privacy": "public", "type": { "text": "string" }, "attribute": "colheader-position" } ], "attributes": [ { "name": "placeholder-search", "type": { "text": "string" }, "fieldName": "placeholderSearch" }, { "name": "colheader-field", "type": { "text": "string" }, "fieldName": "colheaderField" }, { "name": "colheader-position", "type": { "text": "string" }, "fieldName": "colheaderPosition" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "furo-ui5-set-fieldorder", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SetFieldorder", "declaration": { "name": "FuroUi5SetFieldorder", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-fieldorder.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-set-fieldorder", "declaration": { "name": "FuroUi5SetFieldorder", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-fieldorder.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/table/furo-ui5-set-groupby.js", "declarations": [ { "kind": "class", "description": "`FuroUi5SetGroupby` is a helper component", "name": "FuroUi5SetGroupby", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "orderByFieldnode" } ], "description": "bindData", "privacy": "public" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "field", "name": "myBool", "privacy": "public", "type": { "text": "boolean" }, "description": "Description", "attribute": "myBool" } ], "attributes": [ { "name": "myBool", "type": { "text": "boolean" }, "description": "Description", "fieldName": "myBool" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "furo-ui5-set-groupby", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SetGroupby", "declaration": { "name": "FuroUi5SetGroupby", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-groupby.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-set-groupby", "declaration": { "name": "FuroUi5SetGroupby", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-groupby.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/table/furo-ui5-set-orderby-row.js", "declarations": [ { "kind": "class", "description": "`FuroUi5SetOrderbyRow` is a helper component", "name": "FuroUi5SetOrderbyRow", "members": [ { "kind": "method", "name": "injectData", "parameters": [ { "name": "d" } ] }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "furo-ui5-set-orderby-row", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SetOrderbyRow", "declaration": { "name": "FuroUi5SetOrderbyRow", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-orderby-row.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-set-orderby-row", "declaration": { "name": "FuroUi5SetOrderbyRow", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-orderby-row.js" } } ] }, { "kind": "javascript-module", "path": "src/furo-ui5-views/helper/table/furo-ui5-set-orderby.js", "declarations": [ { "kind": "class", "description": "`FuroUi5SetOrderby` is a helper component", "name": "FuroUi5SetOrderby", "members": [ { "kind": "method", "name": "bindData", "parameters": [ { "name": "settings" }, { "name": "orderByFieldnode" } ], "description": "bindData", "privacy": "public" }, { "kind": "method", "name": "_parseOrderBy" }, { "kind": "method", "name": "bindTable", "parameters": [ { "name": "tableDO" }, { "name": "" } ], "description": "bindTable", "privacy": "public" }, { "kind": "method", "name": "_FBPReady", "description": "flow is ready lifecycle method" }, { "kind": "method", "name": "_updateOrder" }, { "kind": "method", "name": "moveNode", "parameters": [ { "name": "fromIndex" }, { "name": "toIndex" } ] }, { "kind": "field", "name": "labelEmptySelect", "privacy": "public", "type": { "text": "string" }, "attribute": "label-empty-select" } ], "attributes": [ { "name": "label-empty-select", "type": { "text": "string" }, "fieldName": "labelEmptySelect" } ], "mixins": [ { "name": "FBP", "package": "@furo/fbp" } ], "superclass": { "name": "LitElement", "package": "lit" }, "summary": "Helper component", "tagName": "furo-ui5-set-orderby", "customElement": true } ], "exports": [ { "kind": "js", "name": "FuroUi5SetOrderby", "declaration": { "name": "FuroUi5SetOrderby", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-orderby.js" } }, { "kind": "custom-element-definition", "name": "furo-ui5-set-orderby", "declaration": { "name": "FuroUi5SetOrderby", "module": "src/furo-ui5-views/helper/table/furo-ui5-set-orderby.js" } } ] } ] }