Namespace aV.QuickEdit
Represents a namespace, aV.QuickEdit, for the new functions and global parameters of those functions.
Defined in: aV.plg.quickEdit.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Represents a namespace, aV.QuickEdit, for the new functions and global parameters of those functions.
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
aV.QuickEdit.uploadBoxCount
Used internally to assign unique id's to the created upload boxes.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
aV.QuickEdit.createUploadBox(titleText, postAdress, params, callBackFunc)
Creates a tiny little upload box which has the class name uploadContainer.
|
| <static> |
aV.QuickEdit.init()
This function initializes the aV.QuickEdit system.
|
Namespace Detail
aV.QuickEdit
Represents a namespace, aV.QuickEdit, for the new functions and global parameters of those functions.
- Parameters:
- {String} arguments.uploadImgPath
- The path to the image which will be shown while uploading a file via an upload box.
- {String} arguments.imgUploadTitle
- The default upload box title for image replacements.
- {String} arguments.imgUploadError
- The error message which will be showed when an error is occured while uploading the new image.
- {String} arguments.textEditError
- The error message which will be showed when an error is occured while uploading the new text content.
- {String} arguments.ruleFile
- Path to the external file which contains the rule definitons for editable items.
- {Boolean} arguments.useInfoBox
- The script will try to use the InfoBox extension(if exists) to display messages instead of alert function.
- {String[]} arguments.forbiddenTags
- The tag names in uppercase which should not be assigned for quickEdit in any case.
Field Detail
<static>
{integer}
aV.QuickEdit.uploadBoxCount
Used internally to assign unique id's to the created upload boxes.
You should never change this value.
You should never change this value.
Method Detail
<static>
{HTMLDivElementObject}
aV.QuickEdit.createUploadBox(titleText, postAdress, params, callBackFunc)
Creates a tiny little upload box which has the class name uploadContainer.
It asynchronously uploads selected file immediately after the user have selected it.
- Parameters:
- {String} titleText
- The title of the upload box.
- {String} postAdress
- The adress of the server-side page, where the file will be uploaded.
- {String} params
- A "&" delimited string which contains the parameters which will be passed
to the server-side page. Just like the GET paramters of a page, the parameter values should be URIEncoded.
Note: The last item should not be a name-value pair. Instead, it should only have the name of the file variable.
An example params string will be like this:
var1=hello%20world&var2=hello%20again&theFileVar - {Function(HTMLDivElementObject|String)} callBackFunc Optional
- The function which is called when the upload process is finished.
It should take the parent object of the uploadBox div, which is the same element what the createUploadBox function returns,
as its first paramter. The text result of the server-side page's response, which is defined in postAddress parameter, as its second parameter.
If this function returns false, the upload box will remain and if this function returns nothing or true the upload box will dissappear after the POST operation is completed.
The upload box will automatically dissappear if callBackFunction is not assigned also.
- Returns:
- {HTMLDivElementObject} The object reference to the created upload box div.
<static>
aV.QuickEdit.init()
This function initializes the aV.QuickEdit system.
Downloads the ruleFile if there is one, assigns the necessary property
and event handlers to the editable elements.
Attached to the window.onload event automatically.