Class Index | File Index

Classes


Class Alfresco.module.socialPublishing

socialPublishing component.

Enables a user to publish a nodeRef to an external channel or view the publish history on a node.
Constructor Summary
Constructor Attributes Constructor Name and Description
 
socialPublishing constructor.
Field Summary
Field Attributes Field Name and Description
 
The default config for the gui state for the publish dialog.
 
The merged result of the defaultShowConfig and the config passed in
 
Property containing an object of the status update channels and their limit.
 
Object container for storing YUI widget and HTMLElement instances.
Method Summary
Method Attributes Method Name and Description
 
Checks the update length against the defined maximum (if there is one) and trims the contents to that length.
 
Closes the fialogue and tidys up any loose ends
 
Fired when the user clicks the cancel button.
 
Fired by YUILoaderHelper when required component script files have
 
Fired when the user clicks the "Publish" button on the dialogue
 
Triggered when the "All" open is selected from the select dropdown list on the status update channels
 
called everytime a change is made to the list of selected status channels.
 
Triggered when the "None" open is selected from the select dropdown list on the status update channels
 
Triggered when the user selects a channel from the drop down list of available publishing channels
 
Triggered when a Status Update check box is selected or unselected.
 
Triggered on Keyup event in the status update box
 
Triggered when the user clicks on the checkbox to include the URL or not.
 
onTemplateLoaded(response)
Called when the dialog html template has been returned from the server.
 
Resets the truncation message
 
Sets the update limits for later use in checkUpdateLength()
 
show(config)
Show can be called multiple times and will display the dialog
 
showTruncationMsg(truncationChannels)
Shows the truncation message
Constructor Detail
Alfresco.module.socialPublishing(htmlId)
socialPublishing constructor.

socialPublishing is considered a singleton so constructor should be treated as private,
please use Alfresco.module.getsocialPublishingInstance() instead.
Parameters:
{string} htmlId
The HTML id of the parent element
Returns:
{Alfresco.module.socialPublishing} The new socialPublishing instance
Field Detail
{object} defaultShowConfig
The default config for the gui state for the publish dialog.
The user can override these properties in the show() method.

{object} showConfig
The merged result of the defaultShowConfig and the config passed in
to the show method.

{object} updateLimits
Property containing an object of the status update channels and their limit.
used by this.checkUpdateLength()

{object} widgets
Object container for storing YUI widget and HTMLElement instances.
Method Detail
checkUpdateLength()
Checks the update length against the defined maximum (if there is one) and trims the contents to that length.

closeDialogue()
Closes the fialogue and tidys up any loose ends

onCancelButtonClick(event)
Fired when the user clicks the cancel button.
Closes the panel.
Parameters:
{object} event
a Button "click" event

onComponentsLoaded()
Fired by YUILoaderHelper when required component script files have
been loaded into the browser.

onPublishButtonClick()
Fired when the user clicks the "Publish" button on the dialogue

onSelectAllStatusChannels(event)
Triggered when the "All" open is selected from the select dropdown list on the status update channels
Parameters:
event

onSelectedStatusChannelChange()
called everytime a change is made to the list of selected status channels.

onSelectNoStatusChannels(event)
Triggered when the "None" open is selected from the select dropdown list on the status update channels
Parameters:
event

onSelectPublishChannel(event, obj)
Triggered when the user selects a channel from the drop down list of available publishing channels
Parameters:
event
obj

onStatusCheckboxToggle(event)
Triggered when a Status Update check box is selected or unselected.
Parameters:
event

onStatusUpdateKeypress()
Triggered on Keyup event in the status update box

onStatusURLToggle()
Triggered when the user clicks on the checkbox to include the URL or not.

onTemplateLoaded(response)
Called when the dialog html template has been returned from the server.
Creates the YIU gui objects such as the panel.
Parameters:
{object} response
a Alfresco.util.Ajax.request response object

resetTruncationMsg()
Resets the truncation message

setUpdateLimits(obj)
Sets the update limits for later use in checkUpdateLength()
Parameters:
obj

show(config)
Show can be called multiple times and will display the dialog
in different ways depending on the config parameter.
Parameters:
{object} config
describes how the dialog should be displayed
The config object is in the form of:
{
nodeRef: {string}, // the nodeRef
version: {string} // the version to show properties of
}

showTruncationMsg(truncationChannels)
Shows the truncation message
Parameters:
{array} truncationChannels
- list of names of channels that will be truncated

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Feb 16 2012 12:24:26 GMT-0000 (GMT)