Extends
Members
accessPolicyControlContainer :string
The selector for the HTML element that will contain a button/link/control for
opening the AccessPolicyView modal window. If this element doesn't exist on the page,
then the AccessPolicyView will be inserted into the `accessPolicyViewContainer` directly, rather than a modal window.
Type:
- string
- Inherited From:
- Source:
accessPolicyModalID :string
The text to use in the editor submit button
Type:
- string
- Inherited From:
- Source:
accessPolicyViewContainer :string
The selector for the HTML element that will contain the AccessPolicyView.
If this element doesn't exist on the page, then the AccessPolicyView will not be inserted into the page.
If a `accessPolicyControlContainer` element is on the page, then this element will
contain the modal window element.
Type:
- string
- Inherited From:
- Source:
activeSectionLabel :string
The currently active editor section. e.g. Data, Metrics, Settings, etc.
Type:
- string
editorSubmitMessageTemplate
References to templates for this view. HTML files are converted to Underscore.js templates
- Overrides:
- Source:
el :string|DOMElement
The element this view is contained in. A jQuery selector or the element itself.
Type:
- string | DOMElement
- Inherited From:
- Source:
events :Object
The events this view will listen to and the associated function to call.
This view will inherit events from the parent class, EditorView.
Type:
- Object
- Overrides:
- Source:
model :Portal
The PortalModel that is being edited
Type:
- Portal
newPortalActiveSectionLabel :string
When a new portal is being created, this is the label of the section that will be active when the editor first renders
Type:
- string
newPortalTempName :string
A temporary name to use for portals when they are first created but don't have a label yet.
This name should only be used in views, and never set on the model so it doesn't risk getting
serialized and saved.
Type:
- string
portalIdentifier :string
The short name OR pid for the portal
Type:
- string
portEditLogoContainer :string
A jQuery selector for the element that the portal logo image uploader
should be inserted into
Type:
- string
portEditSectionsContainer :string
A jQuery selector for the element that the PortEditorSectionsView should be inserted into
Type:
- string
sectionsView :PortEditorSectionsView
A reference to the PortEditorSectionsView for this instance of the PortEditorView
Type:
submitButtonText :string
The text to use in the editor submit button
Type:
- string
- Overrides:
- Source:
subviews :Array.<Backbone.View>
An array of Backbone Views that are contained in this view.
Type:
- Array.<Backbone.View>
template
References to templates for this view. HTML files are converted to Underscore.js templates
type :string
The type of View this is
Type:
- string
viewPortalLinks :string
A jQuery selector for links to view this portal
Type:
- string
Methods
authorizeUser()
The authorizeUser function checks if the current user is authorized
to edit the given PortalModel. If not, a message is displayed and
the view doesn't render anything else.
If the user isn't logged in at all, don't check for authorization and
display a message and login button.
cancel()
Cancel all edits in the editor by simply re-rendering the view
- Inherited From:
- Source:
canClose() → {boolean}
Checks if there are unsaved changes in this Editor that should prevent closing of this view.
This function is also executed by the AppView, which controls the top-level navigation.
- Inherited From:
- Source:
Returns:
Returns true if this view should be closed. False if it should remain opened and active.
- Type
- boolean
checkValidity()
Check the validity of this view's model
- Inherited From:
- Source:
createModel()
Create a PortalModel object
getConfirmCloseMessage() → {string}
This function is called whenever the user is about to leave this view.
- Inherited From:
- Source:
Returns:
The message that asks the user if they are sure they want to close this view
- Type
- string
handleSaveCancel()
Trigger a save error with a message that the save was cancelled
- Inherited From:
- Source:
handleScroll()
This function is called whenever the window is scrolled.
hasUnsavedChanges() → {boolean}
Returns true if there are unsaved changes in this Editor
This function should be exended by each subclass of EditorView to check for unsaved changes for that model type
- Inherited From:
- Source:
Returns:
- Type
- boolean
hideControls()
Hide the editor footer controls (Save bar)
- Inherited From:
- Source:
hideLoading()
Hides the loading
- Overrides:
- Source:
hideSaving()
Remove the styles set in showSaving()
- Inherited From:
- Source:
initialize(options)
Is executed when a new PortalEditorView is created
Parameters:
Name | Type | Description |
---|---|---|
options |
Object | A literal object with options to pass to the view |
onClose()
Perform clean-up functions when this view is about to be removed from the page or navigated away from.
- Overrides:
- Source:
removeValidation()
Removes all the validation error styling and messaging from this view
- Overrides:
- Source:
render()
Renders the PortalEditorView
- Overrides:
- Source:
renderAccessPolicy(e)
Renders the AccessPolicyView
Parameters:
Name | Type | Description |
---|---|---|
e |
Event | The event that triggered this function as a callback |
- Inherited From:
- Source:
renderAccessPolicyControl()
Adds a Share button for editing the access policy
- Inherited From:
- Source:
renderEditorControls()
Adds top-level control elements to this editor.
- Inherited From:
- Source:
renderLogoEditor()
renderLogoEditor - Creates a new PortalImage model for the portal logo if
one doesn't exist already, then inserts an ImageEdit view into the
portEditLogoContainer.
renderPortalEditor()
Renders the portal editor view once the portal view is created
renderRequiredIcons(requiredFields)
Shows the required icons for the sections and fields that must be completed in this editor.
Parameters:
Name | Type | Description |
---|---|---|
requiredFields |
object | A literal object that specified which fields should be required. The keys on the object map to model attributes, and the value is true if required, false if optional. |
- Inherited From:
- Source:
renderSubscriptionInfo()
The DataONE Plus Subscription if fetched from Bookkeeper and the status of the
Subscription is rendered on the page.
Subviews in this view should have their own renderSubscriptionInfo() function
that inserts subscription details into the subview.
save()
Saves the model
- Inherited From:
- Source:
saveError(errorMsg)
When the object fails to save, tell the user
Parameters:
Name | Type | Description |
---|---|---|
errorMsg |
string | The error message resulting from a failed attempt to save |
- Inherited From:
- Source:
saveSuccess(savedObject)
When the object is saved successfully, tell the user.
Parameters:
Name | Type | Description |
---|---|---|
savedObject |
object | the object that was successfully saved |
- Overrides:
- Source:
setListeners()
Set listeners on the view's model.
This function centralizes all the listeners so that when/if the view's
model is replaced, the listeners can be reset.
- Inherited From:
- Source:
showAccessPolicyModal(e)
Shows the AccessPolicyView for the object being edited.
Parameters:
Name | Type | Description |
---|---|---|
e |
Event | The event that triggered this function as a callback |
- Inherited From:
- Source:
showControls()
Show the editor footer controls (Save bar)
- Inherited From:
- Source:
showLoading(container, message)
Style the view to show that it is loading
Parameters:
Name | Type | Description |
---|---|---|
container |
string | DOMElement | The element to put the loading styling in. Either a jQuery selector or the element itself. |
message |
string | DOMElement | The message to display next to the loading icon. Either a jQuery selector or the element itself. |
- Inherited From:
- Source:
showNotFound()
If the given portal doesn't exist, display a Not Found message.
- Overrides:
- Source:
showSaving()
Change the styling of this view to show that the object is in the process of saving
- Inherited From:
- Source:
showSignIn()
Show Sign In buttons
- Overrides:
- Source:
showValidation()
When the Portal model has been flagged as invalid, show the validation error messages
- Overrides:
- Source:
showValidationMessage(elements, errorMsg)
Shows a validation error message and adds error styling to the given elements
Parameters:
Name | Type | Description |
---|---|---|
elements |
jQuery | The elements to add error styling and messaging to |
errorMsg |
string | The error message to display |
toggleSectionLinks()
toggleSectionLinks - show or hide the section links. Used for the
mobile/small screen view of the portal.
updateBasicText(eopt)
When a simple text input field loses focus, the corresponding model
attribute is updated with the value from the input field
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
e |
Event |
<optional> |
The focusout event |