Customfields Filters

<et2-customfields-filters> | Et2CustomfieldsFilters

Renders customfield filter selectboxes. Only legacy filter-eligible customfields render: select-style fields and app-backed link-entry fields. Filemanager and non-select fields are skipped.

Overview

et2-customfields-filters renders an application’s custom fields as filter controls, for the filter area of a list. It is the third context of the family described on et2-customfields, alongside the editable widget and the read-only list.

Not every field can be filtered

Unlike the other two widgets, this one does not render every visible field. A filter has to offer a fixed set of choices to be useful, so the widget keeps only fields it can turn into a selection:

• select-style fields are rendered as filter selectboxes
• a field whose type is an installed application is also kept, and filters by entry from that app
• everything else - free text, dates, and so on - is skipped
• filemanager fields are excluded

So a field appearing in the edit dialog but not in the filters is expected, not a fault. If a field should be filterable, its customfield type has to change.

Beyond that it shares the same visibility contract as the rest of the family, documented on et2-customfields: fields, exclude, typeFilter and tab all apply here too.

Usage

<et2-customfields-filters id="customfields"></et2-customfields-filters>

      

      
    

Inside a kdots application, filters usually reach the framework through the filter slot rather than being placed directly - see Et2Filterbox, which describes how a list’s filters are assembled.

Inherited properties (24)

Et2CustomfieldsBase

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.
customfields	Customfield metadata keyed by unprefixed field name.
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.
exclude	Comma-separated field names that should be hidden.
fields	Visibility map keyed by unprefixed field name.
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 *
tab	Optional tab restriction for rendered customfields.
typeFilter	Type filter, array of filters, or previous filter reuse.
value	Customfield values keyed by prefixed field name, e.g. #cf_name.
options	Get property-values as object
supportedWidgetClasses	et2_widget compatability

LitElement

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

Methods

Learn more about methods.

Inherited methods (21)

Et2CustomfieldsBase

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

Parts

Learn more about customizing CSS parts.

Belongs to

Custom fields

Related

These widgets are related by naming but not by inheritance or sub-widget composition.

• Customfields
• Customfields List