Entry Filter Header

<et2-nextmatch-header-entry> | Et2EntryFilterHeader

Since 23.1

Nextmatch entry filter header. Renders an entry picker and normalizes simple selected entries to the legacy app:id filter value expected by nextmatch.

Slots

Learn more about using slots.

Inherited properties (30)

Link Entry

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
appIcons	Show just application icons instead of names
applicationList	Limit to the listed applications (comma seperated)
autofocus	Have browser focus this input on load. Overrides etemplate2.focusOnFirstInput(), use only once per page https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attributes
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.
hasFeedbackFor	Get a list of feedback types
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 Legacy support for labels with %s that get wrapped around the widget Not the best way go with webComponents - shouldn’t modify their DOM like this
noLang	Disable any translations for the widget
onlyApp	Limit to just this application - hides app selection
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
placeholder	Displayed in the search / select when no value is selected
query	Callback before query to server. It will be passed the request & et2_link_entry objects. Must return true, or false to abort query.
searchOptions	Additional search parameters that are passed to the server when we query searchUrl
select	Callback when user selects an option. Must return true, or false to abort normal action.
statustext	Tooltip which is shown for this element on hover
styles	WebComponent *
translate	List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing.
value	Override to always return a string appname:id (or just id) for simple (one real selection) cases, parent returns an object. If multiple are selected, or anything other than app and id, the original parent value is returned.
needed	Compatibility for deprecated name “needed”
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.

Events

Learn more about events.

Inherited methods (30)

Link Entry

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.
et2HandleBlur()	If the value is unchanged, put any held validation messages back Named et2HandleBlur to avoid overwriting handleBlur() in Shoelace components
et2HandleFocus()	When input receives focus, clear any validation errors. If the value is the same on blur, we’ll put them back The ones from the server (ManualMessage) can interfere with submitting. Named et2HandleFocus to avoid overwriting handleFocus() in Shoelace components
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
getInputNode()	Get input to e.g. set aria-attributes
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
handleSlChange()	Handle sl-change event from Shoelace components and dispatch a change event so anything listening for change events can react to it instead of having to listen for both sl-change and change.
isValid()	Used by etemplate2 to determine if we can submit or not
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
submit()	Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission.
validate()	Massively simplified validate, as compared to what ValidatorMixin gives us, since ValidatorMixin extends FormControlMixin which breaks SlSelect’s render() We take all validators for the widget, and if there’s a value (or field is required) we check the value with each validator. For array values we check each element with each validator. If the value does not pass the validator, we collect the message and display feedback to the user. We handle validation errors from the server with ManualMessages, which always “fail”. If the value is empty, we only validate if the field is required.
_handleClick()	Click handler calling custom handler set via onclick attribute to this.onclick
_oldChange()	Change handler calling custom handler set via onchange attribute
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

FilterMixin

Name	Description
setNextmatch()	Set nextmatch is the function which has to be implemented for the et2_INextmatchHeader interface.

Parts

Learn more about customizing CSS parts.

Belongs to

Link Entry