Light Dark System

Link List

<et2-link-list> | Et2LinkList

Overview

Display a list of entries in a comma separated list

Given an application & entry ID, will query the list of links and display

What it is for

Shows every entry linked to one entry as a list, one link per row, each with a delete button and a context menu. It extends <et2-link-string> and shares its value handling, so everything that page says about naming the entry, onlyApp, linkType, showDeleted and limit applies here too - the difference is the layout and that the user can act on the links.

This is the widget for a “Links” tab. Pair it with an <et2-link-to> that has the same id: the two halves then share one value, <et2-link-to> creates links and <et2-link-list> picks them up and shows them. 

<et2-link-to id="link_to" span="all"></et2-link-to>
<et2-link-list id="link_to" span="all"></et2-link-list>

See Choosing a link widget for the rest of the family.

Examples

Setting value to an array of {app, id, title} objects displays exactly those. link_id is the ID of the link itself (not of either entry), and is what the delete button sends to the server. 

<et2-link-list id="link-list-example"></et2-link-list>
<script>
    const list = document.getElementById("link-list-example");
    customElements.whenDefined("et2-link-list").then(() =>
    {
        list.value = [
            {app: "addressbook", id: "42", title: "Fischer, Peter", link_id: 1},
            {app: "infolog", id: "7", title: "Call customer back", link_id: 2, remark: "after the holidays"},
            {app: "timesheet", id: "19", title: "Support, 1.5h", link_id: 3}
        ];
    });
</script>

Hover a row to reveal its delete button.

The context menu

Right-clicking a row opens a context menu, whose entries depend on what the row holds: put a comment on the link, and for a file also show its file information, save it, mail it, or copy it into the VFS. With two or more rows there is also “Save as Zip” for all of them at once. readonly suppresses the whole menu.

Deleting

Deleting is two different operations behind one button. For a saved entry the widget sends Link::ajax_delete and only removes the row once the server confirms. For an entry that has no ID yet - a new InfoLog the user is still typing - there is nothing on the server to delete, so the link is simply dropped from the value that will be submitted.

The example above is the second case: it has no entryId, so its delete button really does remove the row, with no server involved.

Every removal fires two events on the widget: et2-before-delete before, and et2-delete plus a bubbling change after. <et2-link-to> listens for et2-delete so it can drop the link from what it is holding for submission.

Readonly

readonly removes the delete buttons and disables the context menu - the links are still clickable, they just cannot be changed. Use it on a view template, or wherever the user has no edit rights. 

<et2-link-list id="link-list-readonly-example" readonly></et2-link-list>
<script>
    const list = document.getElementById("link-list-readonly-example");
    customElements.whenDefined("et2-link-list").then(() =>
    {
        list.value = [
            {app: "addressbook", id: "42", title: "Fischer, Peter", link_id: 1},
            {app: "infolog", id: "7", title: "Call customer back", link_id: 2}
        ];
    });
</script>

Reacting to changes

onchange is called whenever the list changes - the same hook the rest of eTemplate uses. The widget also dispatches a bubbling change event, so a plain listener works just as well. 

this.et2.getWidgetById("link_to").addEventListener("change", () => this.recountLinks());
Inherited properties (25)

Et2Widget

Name Description
accesskey Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character.
actions Set Actions on the widget Each action is defined as an object: move: { type: “drop”, acceptedTypes: “mail”, icon: “move”, caption: “Move to” onExecute: javascript:mail_move” } This will turn the widget into a drop target for “mail” drag types. When “mail” drag types are dropped, the global function mail_move(egwAction action, egwActionObject sender) will be called. The ID of the dragged “mail” will be in sender.id, some information about the sender will be in sender.context. The etemplate2 widget involved can typically be found in action.parent.data.widget, so your handler can operate in the widget context easily. The location varies depending on your action though. It might be action.parent.parent.data.widget To customise how the actions are handled for a particular widget, override _link_actions(). It handles the more widget-specific parts.
align Used by Et2Box to determine alignment. Allowed values are left, right
class CSS Class. This class is applied to the outside, on the web component itself. Due to how WebComponents work, this might not change anything inside the component.
data Set the dataset from a CSV
deferredProperties Any attribute that refers to row content cannot be resolved immediately, but some like booleans cannot stay a string because it’s a boolean attribute. We store them for later, and parse when they’re fully in their row. If you are creating a widget that can go in a nextmatch row, and it has boolean attributes that can change for each row, add those attributes into deferredProperties
disabled Defines whether this widget is visibly disabled. The widget is still visible, but clearly cannot be interacted with. Widgets disabled in the template will not return a value to the application code, even if re-enabled via javascript before submitting. To allow a disabled widget to be re-enabled and return a value, disable via javascript in the app’s et2_ready() instead of an attribute in the template file.
dom_id Get the actual DOM ID, which has been prefixed to make sure it’s unique.
hidden The widget is not visible. As far as the user is concerned, the widget does not exist. Widgets hidden with an attribute in the template may not be created in the DOM, and will not return a value. Widgets can be hidden after creation, and they may return a value if hidden this way.
id Get the ID of the widget
label The label of the widget This is usually displayed in some way. It’s also important for accessability. This is defined in the parent somewhere, and re-defining it causes labels to disappear
noLang Disable any translations for the widget
parentId Parent is different than what is specified in the template / hierarchy. Widget ID of another node to insert this node into instead of the normal location
statustext Tooltip which is shown for this element on hover
styles WebComponent *
options Get property-values as object
supportedWidgetClasses et2_widget compatability

Link String

Name Description
application Specify the application for all the entries, so you only need to specify the entry ID
entryId Application entry ID
limit Number of application-links to load (file-links are always fully loaded currently) If number is exceeded, a “Load more links …” button is displayed, which will load the double amount of links each time clicked
linkType Type filter Sub-type key to list only entries of that type
onlyApp Application filter Set to an appname or comma separated list of applications to show only linked entries from those applications
showDeleted Show links that are marked as deleted, being held for purge
value Handle values passed as an array

LitElement

Name Description
updateComplete A read-only promise that resolves when the component has finished updating.

Events

Name Description Event Detail
et2-before-delete Missing description CustomEvent
et2-delete Missing description CustomEvent
change Missing description Event

Learn more about events.

Inherited methods (23)

Et2Widget

Name Description
checkCreateNamespace() Checks whether a namespace exists for this element in the content array. If yes, an own perspective of the content array is created. If not, the parent content manager is used. Constructor attributes are passed in case a child needs to make decisions
clone() Creates a copy of this widget.
createElementFromNode() Create a et2_widget from an XML node. First the type and attributes are read from the node. Then the readonly & modifications arrays are checked for changes specific to the loaded data. Then the appropriate constructor is called. After the constructor returns, the widget has a chance to further initialize itself from the XML node when the widget’s loadFromXML() method is called with the node.
getArrayMgr() Returns the array manager object for the given part
getArrayMgrs() Returns an associative array containing the top-most array managers.
getChildren() Get child widgets Use .children to get web component children
getInstanceManager() Returns the instance manager
getPath() Returns the path into the data array. By default, array manager takes care of this, but some extensions need to override this
getRoot() Returns the base widget Usually this is the same as getInstanceManager().widgetContainer
loadFromXML() Loads the widget tree from an XML node
loadingFinished() Needed for legacy compatability.
parseXMLAttrs() The parseXMLAttrs function takes an XML DOM attributes object and adds the given attributes to the _target associative array. This function also parses the legacyOptions. N.B. This is only used for legacy widgets. WebComponents use transformAttributes() and do their own handling of attributes.
set_label() NOT the setter, since we cannot add to the DOM before connectedCallback() TODO: This is not best practice. Should just set property, DOM modification should be done in render https://lit-element.polymer-project.org/guide/templates#design-a-performant-template
setArrayMgr() Sets the array manager for the given part
setArrayMgrs() Sets all array manager objects - this function can be used to set the root array managers of the container object.
setInstanceManager() Set the instance manager Normally this is not needed as it’s set on the top-level container, and we just return that reference
_handleClick() Click handler calling custom handler set via onclick attribute to this.onclick
destroy() et2_widget compatability
set_class() Set the widget class
set_disabled() Wrapper on this.disabled because legacy had it.
set_statustext() supports legacy set_statustext

Link String

Name Description
get_links() Starts the request for link list to the server Called internally to fetch the list. May be called externally to trigger a refresh if a link is added.
set_value() Set the value of the list Value can be: - String: CSV list of entries in either app:ID or just ID if application is set. - Object: {to_app: , to_id: } List of linked entries will be fetched from the server - Array: {app: , id: }[]

Belongs to

Linking system