Module: alfresco/forms/controls/MultipleEntryElementWrapper

alfresco/forms/controls/MultipleEntryElementWrapper

This widget is used to wrap individual multiple entry elements to allow them to be deleted and to switch them between edit and read mode. Read mode is designed to given a condensed human readable description of the what each element represents and the edit mode allows the user to configure the behaviour.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

cancelEditAltText :string

This is the altText that is used for the cancel edit button.
Type:
  • string
Default Value:
  • "multiple-entry.cancel"
Source:

cancelEditImage :string

This is the default image used for the cancel editing button. It will be used if a cancelEditImageSrc has not been provided.
Type:
  • string
Default Value:
  • "delete-16.png"
Source:

cancelEditImageSrc :string

This is the source of the image used for the save entry button
Type:
  • string
Default Value:
  • null
Source:

creator

This keeps track of the MultipleEntryCreator that created this wrapper. It is required so that the MultipleEntryCreator can be updated with delete requests.
Default Value:
  • null
Source:

deleteEntryAltText :string

This is the altText that is used for the delete entry button.
Type:
  • string
Default Value:
  • "multiple-entry.delete"
Source:

deleteEntryImage :string

This is the default image used for the delete entry button. It will be used if a deleteEntryImageSrc has not been provided.
Type:
  • string
Default Value:
  • "delete-16.png"
Source:

deleteEntryImageSrc :string

This is the source of the image used for the delete entry button
Type:
  • string
Default Value:
  • null
Source:

editEntryAltText :string

This is the altText that is used for the edit entry button.
Type:
  • string
Default Value:
  • "multiple-entry.edit"
Source:

editEntryImage :string

This is the default image used for the edit entry button. It will be used if a editEntryImageSrc has not been provided.
Type:
  • string
Default Value:
  • "edit-16.png"
Source:

editEntryImageSrc :string

This is the source of the image used for the edit entry button
Type:
  • string
Default Value:
  • null
Source:

previouslyExisted :boolean

Indicates whether or not this wrapper represents an element that has previously been created or whether this is being used to potentially create a new element. This is important so that it can be determined whether or not to delete the wrapper when cancelling editing or to simple return the wrapper to it's previous state.
Type:
  • boolean
Default Value:
  • false
Source:

saveEntryAltText :string

This is the altText that is used for the add entry button.
Type:
  • string
Default Value:
  • "multiple-entry.save"
Source:

saveEntryImage :string

This is the default image used for the save entry button. It will be used if a saveEntryImageSrc has not been provided.
Type:
  • string
Default Value:
  • "done-16.png"
Source:

saveEntryImageSrc :string

This is the source of the image used for the save entry button
Type:
  • string
Default Value:
  • null
Source:

templateString :String

The HTML template to use for the widget.
Type:
  • String
Source:

widget :object

The widget should be passed as a constructor configuration argument.
Type:
  • object
Default Value:
  • null
Source:

Methods

blurWrapper(saveChanges)

Handles blurring of the wrapper
Parameters:
Name Type Description
saveChanges boolean Indicates whether or not state changes should be saved.
Source:

cancelEditingElement()

Handles cancelling editing an item. If the item previously existed (e.g. edit mode wasn't entered in order to create a new item) then the previous state of the item will be returned. If the item has not yet been created then this wrapper (and the item it contains) will be deleted by calling deleteEntry.
Source:

constructor()

Source:

deleteElement()

Source:

doneEditingElement()

Handles the completion of editing an item
Source:

editElement()

This called when the edit button is clicked. It switches the element from read to edit mode.
Source:

postCreate()

Source:

postMixInProperties()

Set up the attributes to be used when rendering the template.
Source: