This extends the basic form to provide a simple single text entry form. It was originally written to support the basic search requests. One of the key features is that it listens for the user hitting the enter key when focus is on the text field so that it is not necessary for them to explicitly tab to or click on the "OK" button.
- Copyright:
- Copyright (C) 2005-2020 Alfresco Software Limited
- License:
- GNU Lesser General Public License, see: Open Source Licensing
- Source:
Extends
Members
-
cssRequirements :object[]
-
An array of the CSS files to use with this widget.
Type:
- object[]
- Default Value:
- [{cssFile:"./css/SingleTextFieldForm.css"}]
- Source:
-
showCancelButton :boolean
-
Override the default attribute to hide the cancel button
Type:
- boolean
- Default Value:
- false
- Source:
-
textBoxCssClasses :string
-
This can be set to a string of additional CSS classes to apply to the text field
Type:
- string
- Default Value:
- null
- Source:
-
textBoxIconClass :string
-
This is the icon class to pass onto the text field.
Type:
- string
- Default Value:
- null
- Source:
-
textBoxLabel :string
-
Can be set to provide a label for the text box
Type:
- string
- Default Value:
- null
- Source:
-
textFieldName :string
-
This is the 'name' of the text field that will be used as an attribute in the form value published on clicking on the "OK" button or hitting the enter key
Type:
- string
- Default Value:
- null
- Source:
Methods
-
allWidgetsProcessed(widgets)
-
Extended to connect keyup events (when the key is enter) to click the submit button
Parameters:
Name Type Description widgetsarray The widgets instantiated - Source:
-
postCreate()
-
Extended to add an additional CSS class to the widget DOM to ensure that the modules CSS is applied
- Source:
-
postMixInProperties()
-
Overridden to set the "widgets" attribute to be a single text box.
- Source: