diff --git a/analysis.json b/analysis.json new file mode 100644 index 0000000..1645511 --- /dev/null +++ b/analysis.json @@ -0,0 +1,1267 @@ +{ + "schema_version": "1.0.0", + "elements": [ + { + "description": "`cuba-lookup` component provides an ability to specify entity `-list` component\nin order to select an entity instance for a reference attribute.\nThe list component should be marked passed into `lookup-screen` slot.\n\n\n \n\n \n
\n ...\n
\n \n ", + "summary": "", + "path": "cuba-lookup.html", + "properties": [ + { + "name": "pickedEntity", + "type": "Object", + "description": "Entity which has been picked by user.", + "privacy": "public", + "sourceRange": { + "start": { + "line": 73, + "column": 8 + }, + "end": { + "line": 76, + "column": 9 + } + }, + "metadata": { + "polymer": { + "notify": true, + "attributeType": "Object" + } + } + }, + { + "name": "selectedEntity", + "type": "Object", + "description": "Entity which is currently selected in lookup dialog.", + "privacy": "public", + "sourceRange": { + "start": { + "line": 83, + "column": 8 + }, + "end": { + "line": 87, + "column": 9 + } + }, + "metadata": { + "polymer": { + "notify": true, + "attributeType": "Object" + } + }, + "defaultValue": "null" + }, + { + "name": "_lookupElement", + "type": "Object | null | undefined", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 88, + "column": 8 + }, + "end": { + "line": 88, + "column": 30 + } + }, + "metadata": { + "polymer": { + "attributeType": "Object" + } + } + } + ], + "methods": [ + { + "name": "ready", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 90, + "column": 6 + }, + "end": { + "line": 98, + "column": 7 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "showLookupScreen", + "description": "Shows lookup screen", + "privacy": "public", + "sourceRange": { + "start": { + "line": 104, + "column": 6 + }, + "end": { + "line": 108, + "column": 7 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_select", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 109, + "column": 6 + }, + "end": { + "line": 112, + "column": 7 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_cancel", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 113, + "column": 6 + }, + "end": { + "line": 117, + "column": 7 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + } + ], + "staticMethods": [], + "demos": [], + "metadata": {}, + "sourceRange": { + "start": { + "line": 65, + "column": 12 + }, + "end": { + "line": 118, + "column": 5 + } + }, + "privacy": "public", + "superclass": "HTMLElement", + "attributes": [ + { + "name": "picked-entity", + "description": "Entity which has been picked by user.", + "sourceRange": { + "start": { + "line": 73, + "column": 8 + }, + "end": { + "line": 76, + "column": 9 + } + }, + "metadata": {}, + "type": "Object" + }, + { + "name": "selected-entity", + "description": "Entity which is currently selected in lookup dialog.", + "sourceRange": { + "start": { + "line": 83, + "column": 8 + }, + "end": { + "line": 87, + "column": 9 + } + }, + "metadata": {}, + "type": "Object" + } + ], + "events": [ + { + "type": "CustomEvent", + "name": "picked-entity-changed", + "description": "Fired when the `pickedEntity` property changes.", + "metadata": {} + }, + { + "type": "CustomEvent", + "name": "selected-entity-changed", + "description": "Fired when the `selectedEntity` property changes.", + "metadata": {} + } + ], + "styling": { + "cssVariables": [], + "selectors": [] + }, + "slots": [ + { + "description": "", + "name": "dropdown", + "range": { + "start": { + "line": 50, + "column": 8 + }, + "end": { + "line": 50, + "column": 37 + } + } + }, + { + "description": "", + "name": "lookup-screen", + "range": { + "start": { + "line": 62, + "column": 8 + }, + "end": { + "line": 62, + "column": 61 + } + } + } + ], + "tagname": "cuba-lookup" + }, + { + "description": "`` is a Polymer 2 element for data loading progress indication.\n\n```html\n\n```\n\n### Styling\n\n`` provides the following custom properties\nfor styling:\n\nCustom property | Description | Default\n----------------|-------------|----------\n`--progress-height` | Height of the progress indicator | `3px`\n`--progress-color` | Color of the progress indicator | `#0040a8`", + "summary": "", + "path": "cuba-progress-indicator.html", + "properties": [ + { + "name": "_loadingCounter", + "type": "number | null | undefined", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 96, + "column": 12 + }, + "end": { + "line": 101, + "column": 13 + } + }, + "metadata": { + "polymer": { + "observer": "\"_counterChanged\"", + "readOnly": true, + "attributeType": "Number" + } + }, + "defaultValue": "0" + } + ], + "methods": [ + { + "name": "connectedCallback", + "description": "", + "privacy": "public", + "sourceRange": { + "start": { + "line": 105, + "column": 8 + }, + "end": { + "line": 111, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "disconnectedCallback", + "description": "", + "privacy": "public", + "sourceRange": { + "start": { + "line": 113, + "column": 8 + }, + "end": { + "line": 119, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_incrementCounter", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 121, + "column": 8 + }, + "end": { + "line": 123, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_decrementCounter", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 125, + "column": 8 + }, + "end": { + "line": 127, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_counterChanged", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 129, + "column": 8 + }, + "end": { + "line": 137, + "column": 9 + } + }, + "metadata": {}, + "params": [ + { + "name": "counter" + } + ], + "return": { + "type": "void" + } + } + ], + "staticMethods": [], + "demos": [], + "metadata": {}, + "sourceRange": { + "start": { + "line": 83, + "column": 6 + }, + "end": { + "line": 138, + "column": 7 + } + }, + "privacy": "public", + "superclass": "HTMLElement", + "name": "CubaProgressIndicator", + "attributes": [], + "events": [], + "styling": { + "cssVariables": [], + "selectors": [] + }, + "slots": [], + "tagname": "cuba-progress-indicator" + } + ], + "metadata": { + "polymer": { + "behaviors": [ + { + "description": "", + "summary": "", + "path": "cuba-entity-list-view-behavior.html", + "properties": [ + { + "name": "active", + "type": "boolean | null | undefined", + "description": "Indicates if data is loading", + "privacy": "public", + "sourceRange": { + "start": { + "line": 16, + "column": 6 + }, + "end": { + "line": 19, + "column": 7 + } + }, + "metadata": { + "polymer": { + "attributeType": "Boolean" + } + }, + "defaultValue": "false" + }, + { + "name": "entities", + "type": "Array.", + "description": "Loaded entities", + "privacy": "public", + "sourceRange": { + "start": { + "line": 25, + "column": 6 + }, + "end": { + "line": 25, + "column": 21 + } + }, + "metadata": { + "polymer": { + "attributeType": "Array" + } + } + }, + { + "name": "entitiesCount", + "type": "number | null | undefined", + "description": "Number of entities", + "privacy": "public", + "sourceRange": { + "start": { + "line": 29, + "column": 6 + }, + "end": { + "line": 29, + "column": 27 + } + }, + "metadata": { + "polymer": { + "attributeType": "Number" + } + } + }, + { + "name": "moreDataAvailable", + "type": "boolean | null | undefined", + "description": "Indicates if more data is available", + "privacy": "public", + "sourceRange": { + "start": { + "line": 33, + "column": 6 + }, + "end": { + "line": 37, + "column": 7 + } + }, + "metadata": { + "polymer": { + "readOnly": true, + "attributeType": "Boolean" + } + }, + "defaultValue": "false" + }, + { + "name": "dataLoading", + "type": "boolean | null | undefined", + "description": "Indicates if data is currently loading", + "privacy": "public", + "sourceRange": { + "start": { + "line": 41, + "column": 6 + }, + "end": { + "line": 44, + "column": 7 + } + }, + "metadata": { + "polymer": { + "notify": true, + "attributeType": "Boolean" + } + } + }, + { + "name": "selectedEntity", + "type": "Object", + "description": "Entity that is currently selected", + "privacy": "public", + "sourceRange": { + "start": { + "line": 50, + "column": 6 + }, + "end": { + "line": 53, + "column": 7 + } + }, + "metadata": { + "polymer": { + "notify": true, + "attributeType": "Object" + } + } + } + ], + "methods": [ + { + "name": "reload", + "description": "Reloads entities", + "privacy": "public", + "sourceRange": { + "start": { + "line": 60, + "column": 4 + }, + "end": { + "line": 62, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "Promise" + } + }, + { + "name": "remove", + "description": "Removes entity", + "privacy": "public", + "sourceRange": { + "start": { + "line": 69, + "column": 4 + }, + "end": { + "line": 71, + "column": 5 + } + }, + "metadata": {}, + "params": [ + { + "name": "entity", + "type": "Object", + "description": "The entity to remove" + } + ], + "return": { + "type": "Promise" + } + }, + { + "name": "_loadMore", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 72, + "column": 4 + }, + "end": { + "line": 74, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_computeMoreDataAvailable", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 75, + "column": 4 + }, + "end": { + "line": 77, + "column": 5 + } + }, + "metadata": {}, + "params": [ + { + "name": "entities" + }, + { + "name": "entitiesCount" + } + ] + }, + { + "name": "_handleItemTap", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 78, + "column": 4 + }, + "end": { + "line": 80, + "column": 5 + } + }, + "metadata": {}, + "params": [ + { + "name": "event" + } + ], + "return": { + "type": "void" + } + }, + { + "name": "_handleSelectionChange", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 81, + "column": 4 + }, + "end": { + "line": 83, + "column": 5 + } + }, + "metadata": {}, + "params": [ + { + "name": "event" + } + ], + "return": { + "type": "void" + } + } + ], + "staticMethods": [], + "demos": [], + "metadata": {}, + "sourceRange": { + "start": { + "line": 4, + "column": 2 + }, + "end": { + "line": 84, + "column": 3 + } + }, + "privacy": "public", + "name": "CubaEntityListViewBehavior", + "attributes": [ + { + "name": "active", + "description": "Indicates if data is loading", + "sourceRange": { + "start": { + "line": 16, + "column": 6 + }, + "end": { + "line": 19, + "column": 7 + } + }, + "metadata": {}, + "type": "boolean | null | undefined" + }, + { + "name": "entities", + "description": "Loaded entities", + "sourceRange": { + "start": { + "line": 25, + "column": 6 + }, + "end": { + "line": 25, + "column": 21 + } + }, + "metadata": {}, + "type": "Array." + }, + { + "name": "entities-count", + "description": "Number of entities", + "sourceRange": { + "start": { + "line": 29, + "column": 6 + }, + "end": { + "line": 29, + "column": 27 + } + }, + "metadata": {}, + "type": "number | null | undefined" + }, + { + "name": "more-data-available", + "description": "Indicates if more data is available", + "sourceRange": { + "start": { + "line": 33, + "column": 6 + }, + "end": { + "line": 37, + "column": 7 + } + }, + "metadata": {}, + "type": "boolean | null | undefined" + }, + { + "name": "data-loading", + "description": "Indicates if data is currently loading", + "sourceRange": { + "start": { + "line": 41, + "column": 6 + }, + "end": { + "line": 44, + "column": 7 + } + }, + "metadata": {}, + "type": "boolean | null | undefined" + }, + { + "name": "selected-entity", + "description": "Entity that is currently selected", + "sourceRange": { + "start": { + "line": 50, + "column": 6 + }, + "end": { + "line": 53, + "column": 7 + } + }, + "metadata": {}, + "type": "Object" + } + ], + "events": [ + { + "type": "CustomEvent", + "name": "item-tap", + "description": "Fired when user taps on item.", + "metadata": {} + }, + { + "type": "CustomEvent", + "name": "data-loading-changed", + "description": "Fired when the `dataLoading` property changes.", + "metadata": {} + }, + { + "type": "CustomEvent", + "name": "selected-entity-changed", + "description": "Fired when the `selectedEntity` property changes.", + "metadata": {} + } + ], + "styling": { + "cssVariables": [], + "selectors": [] + }, + "slots": [] + }, + { + "description": "", + "summary": "", + "path": "cuba-entity-edit-view-behavior.html", + "properties": [ + { + "name": "entityId", + "type": "string | null | undefined", + "description": "Id of entity that will be loaded", + "privacy": "public", + "sourceRange": { + "start": { + "line": 29, + "column": 6 + }, + "end": { + "line": 32, + "column": 7 + } + }, + "metadata": { + "polymer": { + "observer": "\"_handleEntityIdChange\"", + "attributeType": "String" + } + } + }, + { + "name": "entity", + "type": "Object", + "description": "Loaded entity", + "privacy": "public", + "sourceRange": { + "start": { + "line": 38, + "column": 6 + }, + "end": { + "line": 43, + "column": 7 + } + }, + "metadata": { + "polymer": { + "attributeType": "Object" + } + }, + "defaultValue": "{}" + } + ], + "methods": [ + { + "name": "_handleEntityIdChange", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 45, + "column": 4 + }, + "end": { + "line": 47, + "column": 5 + } + }, + "metadata": {}, + "params": [ + { + "name": "newValue" + } + ], + "return": { + "type": "void" + } + }, + { + "name": "_save", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 48, + "column": 4 + }, + "end": { + "line": 50, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_onSuccess", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 51, + "column": 4 + }, + "end": { + "line": 53, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_onError", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 54, + "column": 4 + }, + "end": { + "line": 56, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_cancel", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 57, + "column": 4 + }, + "end": { + "line": 60, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_delete", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 61, + "column": 4 + }, + "end": { + "line": 63, + "column": 5 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + } + }, + { + "name": "_isInvalid", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 64, + "column": 4 + }, + "end": { + "line": 66, + "column": 5 + } + }, + "metadata": {}, + "params": [ + { + "name": "err" + } + ] + } + ], + "staticMethods": [], + "demos": [], + "metadata": {}, + "sourceRange": { + "start": { + "line": 4, + "column": 2 + }, + "end": { + "line": 67, + "column": 3 + } + }, + "privacy": "public", + "name": "CubaEntityEditViewBehavior", + "attributes": [ + { + "name": "entity-id", + "description": "Id of entity that will be loaded", + "sourceRange": { + "start": { + "line": 29, + "column": 6 + }, + "end": { + "line": 32, + "column": 7 + } + }, + "metadata": {}, + "type": "string | null | undefined" + }, + { + "name": "entity", + "description": "Loaded entity", + "sourceRange": { + "start": { + "line": 38, + "column": 6 + }, + "end": { + "line": 43, + "column": 7 + } + }, + "metadata": {}, + "type": "Object" + } + ], + "events": [ + { + "type": "CustomEvent", + "name": "cancel", + "description": "Fired when user cancels changes.", + "metadata": {} + }, + { + "type": "CustomEvent", + "name": "commit", + "description": "Fired when an entity successfully saved.", + "metadata": {} + }, + { + "type": "CustomEvent", + "name": "delete", + "description": "Fired when when user deletes an entity.", + "metadata": {} + } + ], + "styling": { + "cssVariables": [], + "selectors": [] + }, + "slots": [] + } + ] + } + }, + "classes": [ + { + "description": "`` is a Polymer 2 element for data loading progress indication.\n\n```html\n\n```\n\n### Styling\n\n`` provides the following custom properties\nfor styling:\n\nCustom property | Description | Default\n----------------|-------------|----------\n`--progress-height` | Height of the progress indicator | `3px`\n`--progress-color` | Color of the progress indicator | `#0040a8`", + "summary": "", + "path": "cuba-progress-indicator.html", + "properties": [ + { + "name": "_loadingCounter", + "type": "number | null | undefined", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 96, + "column": 12 + }, + "end": { + "line": 101, + "column": 13 + } + }, + "metadata": {}, + "defaultValue": "0", + "inheritedFrom": "CubaProgressIndicator" + } + ], + "methods": [ + { + "name": "connectedCallback", + "description": "", + "privacy": "public", + "sourceRange": { + "start": { + "line": 105, + "column": 8 + }, + "end": { + "line": 111, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + }, + "inheritedFrom": "CubaProgressIndicator" + }, + { + "name": "disconnectedCallback", + "description": "", + "privacy": "public", + "sourceRange": { + "start": { + "line": 113, + "column": 8 + }, + "end": { + "line": 119, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + }, + "inheritedFrom": "CubaProgressIndicator" + }, + { + "name": "_incrementCounter", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 121, + "column": 8 + }, + "end": { + "line": 123, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + }, + "inheritedFrom": "CubaProgressIndicator" + }, + { + "name": "_decrementCounter", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 125, + "column": 8 + }, + "end": { + "line": 127, + "column": 9 + } + }, + "metadata": {}, + "params": [], + "return": { + "type": "void" + }, + "inheritedFrom": "CubaProgressIndicator" + }, + { + "name": "_counterChanged", + "description": "", + "privacy": "protected", + "sourceRange": { + "start": { + "line": 129, + "column": 8 + }, + "end": { + "line": 137, + "column": 9 + } + }, + "metadata": {}, + "params": [ + { + "name": "counter" + } + ], + "return": { + "type": "void" + }, + "inheritedFrom": "CubaProgressIndicator" + } + ], + "staticMethods": [], + "demos": [], + "metadata": {}, + "sourceRange": { + "start": { + "line": 83, + "column": 43 + }, + "end": { + "line": 83, + "column": 75 + } + }, + "privacy": "public", + "superclass": "Polymer.Element" + } + ] +} diff --git a/bower.json b/bower.json index 7e0bd58..e15a510 100644 --- a/bower.json +++ b/bower.json @@ -8,7 +8,7 @@ "paper-dialog-scrollable": "PolymerElements/paper-dialog-scrollable#^2.0.0" }, "devDependencies": { - "iron-component-page": "PolymerElements/iron-component-page#^2.0.0", + "iron-component-page": "PolymerElements/iron-component-page#^3.0.0", "iron-demo-helpers": "PolymerElements/iron-demo-helpers#^2.0.0", "web-component-tester": "^6.0.0", "webcomponentsjs": "webcomponents/webcomponentsjs#^1.0.0" diff --git a/cuba-entity-edit-view-behavior.html b/cuba-entity-edit-view-behavior.html index f344972..fac86b5 100644 --- a/cuba-entity-edit-view-behavior.html +++ b/cuba-entity-edit-view-behavior.html @@ -3,11 +3,39 @@ * @polymerBehavior CubaEntityEditViewBehavior */ CubaEntityEditViewBehavior = { + + /** + * Fired when an entity successfully saved. + * + * @event commit + */ + + /** + * Fired when user cancels changes. + * + * @event cancel + */ + + /** + * Fired when when user deletes an entity. + * + * @event delete + * @param {Object} entity The entity to delete + */ + properties: { + /** + * Id of entity that will be loaded + */ entityId: { type: String, observer: '_handleEntityIdChange' }, + /** + * Loaded entity + * + * @type {Object} + */ entity: { type: Object, value: function() { diff --git a/cuba-entity-list-view-behavior.html b/cuba-entity-list-view-behavior.html index 1908649..3b6065d 100644 --- a/cuba-entity-list-view-behavior.html +++ b/cuba-entity-list-view-behavior.html @@ -4,30 +4,69 @@ */ CubaEntityListViewBehavior = { + /** + * Fired when user taps on item. + * + * @event item-tap + */ + properties: { + /** + * Indicates if data is loading + */ active: { type: Boolean, value: false }, + /** + * Loaded entities + * + * @type {Array} + */ entities: Array, + /** + * Number of entities + */ entitiesCount: Number, + /** + * Indicates if more data is available + */ moreDataAvailable: { type: Boolean, computed: '_computeMoreDataAvailable(entities, entitiesCount, entities.*)', value: false }, + /** + * Indicates if data is currently loading + */ dataLoading: { type: Boolean, notify: true }, + /** + * Entity that is currently selected + * + * @type {Object} + */ selectedEntity: { type: Object, notify: true } }, + /** + * Reloads entities + * + * @return {Promise} + */ reload: function() { return this.$.data.load(); }, + /** + * Removes entity + * + * @param {Object} entity The entity to remove + * @return {Promise} + */ remove: function(entity) { return this.$.data.remove(entity); }, diff --git a/cuba-lookup.html b/cuba-lookup.html index 0036fca..5a49a22 100644 --- a/cuba-lookup.html +++ b/cuba-lookup.html @@ -68,6 +68,8 @@ properties: { /** * Entity which has been picked by user. + * + * @type {Object} */ pickedEntity: { type: Object, @@ -76,6 +78,8 @@ /** * Entity which is currently selected in lookup dialog. + * + * @type {Object} */ selectedEntity: { type: Object, @@ -93,6 +97,11 @@ }.bind(this)); } }, + /** + * Shows lookup screen + * + * @return {void} + */ showLookupScreen: function() { this._lookupElement.reload().then(function() { this.$.lookupDialog.open(); diff --git a/cuba-progress-indicator.html b/cuba-progress-indicator.html index 57eeadc..4a6755d 100644 --- a/cuba-progress-indicator.html +++ b/cuba-progress-indicator.html @@ -72,7 +72,7 @@ * * ### Styling * - * `` provides the following custom properties and mixins + * `` provides the following custom properties * for styling: * * Custom property | Description | Default diff --git a/cuba-ui.html b/cuba-ui.html index d348e82..ede551b 100644 --- a/cuba-ui.html +++ b/cuba-ui.html @@ -1,3 +1,4 @@ + diff --git a/index.html b/index.html index 8a92452..0e804ac 100644 --- a/index.html +++ b/index.html @@ -9,6 +9,6 @@ - +