| Package: | CQ.wcm |
| Class: | EditBase |
| Extends: | Object |
| Clientlib: | cq.widgets |
| Config Options | Defined By | |
|---|---|---|
|
IEScriptInsert : string Dynamically inserting and executing a script on IE does not work if script is the first tag or is preceded only by di...
Dynamically inserting and executing a script on IE does not work if script is the first tag or is preceded only by divs. See insertAdjacentHTML() function bug on IE. IEScriptInsert contains HTML content (default is
<div style="display:none;"> </div>). On IE only, it will be inserted before any element (containing at least one script tag) which would be inserted in the DOM and script would be executed. |
EditBase | |
|
actions : Array/String An array of Ext.Button configs or an array of strings or a single string. The strings may be one of the following: E...
An array of Ext.Button configs or an array of strings or a single string. The strings may be one of the following:
Usages: |
EditBase | |
|
containerClass : String
CSS class attached to the container div (default is "section").
|
EditBase | |
|
copyText : String
The text for the default copy button.
|
EditBase | |
|
deleteText : String
The text for the default delete button.
|
EditBase | |
|
dialog : CQ.Dialog/Object/String
The dialog, the dialog config or URL to retrieve the dialog config from.
|
EditBase | |
|
dropTarget : Object[] An array of config objects describing: DOM elements which must be drop targets accepted drag objects (defined by gro...
An array of config objects describing:
|
EditBase | |
|
editText : String
The text for the default edit button.
|
EditBase | |
|
element : CQ.Ext.Element/HTMLElement/String
The HTML element or ID of the element to anchor the edit component to.
|
EditBase | |
|
inlineEditing : string/Number Inline editing mode defines if the component editing (edit action) is done through an inline editing or through a flo...
Inline editing mode defines if the component editing (edit action) is done through an inline editing or through a floating dialog. Possible values are:
Usage: An Number value overrides default minimum size. Floating dialog is opened if component element width is more than this minimum size. |
EditBase | |
|
inplaceEditing : Object
Base configuration for inplace editing; may be null if inplace editing is not available for the component
|
EditBase | |
|
insertBehavior : String
The behavior of the edit component when inserting new content.
|
EditBase | |
|
insertText : String
The text for the default insert button.
|
EditBase | |
|
isContained : Boolean True to define if component is contained in a div. This div will be created, moved and deleted with the component (de...
True to define if component is contained in a div. This div will be created, moved and deleted with the component (default is true).
|
EditBase | |
|
isContainer : Boolean True to define if component is a container, e.g. a parsys. this is set via the make editable call and is defined in t...
True to define if component is a container, e.g. a parsys. this is set via the make editable call and is defined in the component definition.
|
EditBase | |
|
isDropTarget : Boolean
True to define the edit component as a drop target (default is true).
|
EditBase | |
|
orderable : Boolean
True to define the edit component as orderable, ie it can be dragged and dropped (default is true).
|
EditBase | |
|
params : Object The params that will be passed to the edit dialog. params: {
paramName1: "value 1",
paramName2: "value 2"
}
The params that will be passed to the edit dialog.
|
EditBase | |
|
pasteText : String
The text for the default paste button.
|
EditBase | |
|
path : String
The content path for the edit component.
|
EditBase | |
|
referenceText : String
The text for the default reference button.
|
EditBase | |
|
targetMode : String Mode for displaying a target ghost or line below the current component while dragging over. Possible values are: Edi...
Mode for displaying a target ghost or line below the current component while dragging over. Possible values are:
|
EditBase | |
| Property | Defined By | |
|---|---|---|
|
EditBase.ANNOTATE : String <static> The value for actions to create an annotate control. Usages:
var config = {
actions: CQ.wcm.EditBa...
<static> The value for actions to create an annotate control. Usages:
|
EditBase | |
|
EditBase.COPYMOVE : String <static> The value for actions to create a copy control. Usages:
var config = {
actions: CQ.wcm.EditBase.CO...
<static> The value for actions to create a copy control. Usages:
|
EditBase | |
|
EditBase.DD_GROUP_ASSET : String
<static> Constant for edit component drag and drop media group.
|
EditBase | |
|
EditBase.DD_GROUP_COMPONENT : String
<static>
Constant for edit component drag and drop group.
|
EditBase | |
|
EditBase.DD_GROUP_DEFAULT : String
<static> Constant for ExtJS drag and drop default group.
|
EditBase | |
|
EditBase.DD_GROUP_PAGE : String
<static> Constant for edit component drag and drop page group.
|
EditBase | |
|
EditBase.DD_GROUP_PARAGRAPH : String
<static> Constant for edit component drag and drop paragraph group.
|
EditBase | |
|
EditBase.DD_GROUP_PRODUCT : String
<static> Constant for edit component drag and drop product group.
|
EditBase | |
|
EditBase.DELETE : String <static> The value for actions to create a delete control. Usages:
var config = {
actions: CQ.wcm.EditBase....
<static> The value for actions to create a delete control. Usages:
|
EditBase | |
|
EditBase.EDIT : String <static> The value for actions to create an edit control. Usages:
var config = {
actions: CQ.wcm.EditBase.E...
<static> The value for actions to create an edit control. Usages:
|
EditBase | |
|
EditBase.EDITANNOTATE : String[] <static> The value for actions to create an edit and annotate control.
Usage:
var config = {
actions: CQ.wc...
<static> The value for actions to create an edit and annotate control.
Usage:
|
EditBase | |
|
EditBase.EDITANNOTATECOPYMOVEDELETEINSERT : String[] <static> The value for actions to create an edit, annotate, delete, copy and insert control.
Usage:
var config ...
<static> The value for actions to create an edit, annotate, delete, copy and insert control.
Usage:
|
EditBase | |
|
EditBase.EDITANNOTATECOPYMOVEINSERT : String[] <static> The value for actions to create an edit, annotate, copy and insert control.
Usage:
var config = {
...
<static> The value for actions to create an edit, annotate, copy and insert control.
Usage:
|
EditBase | |
|
EditBase.EDITANNOTATEDELETE : String[] <static> The value for actions to create an edit, delete and annotate control.
Usage:
var config = {
action...
<static> The value for actions to create an edit, delete and annotate control.
Usage:
|
EditBase | |
|
EditBase.EDITANNOTATEDELETEINSERT : String[] <static> The value for actions to create an edit, annotate, delete and insert control.
Usage:
var config = {
...
<static> The value for actions to create an edit, annotate, delete and insert control.
Usage:
|
EditBase | |
|
EditBase.EDITCOPYMOVEDELETEINSERT : String[] <static> The value for actions to create an edit, delete, copy and insert control.
Usage:
var config = {
ac...
<static> The value for actions to create an edit, delete, copy and insert control.
Usage:
|
EditBase | |
|
EditBase.EDITCOPYMOVEINSERT : String[] <static> The value for actions to create an edit, copy and insert control.
Usage:
var config = {
actions: C...
<static> The value for actions to create an edit, copy and insert control.
Usage:
|
EditBase | |
|
EditBase.EDITDELETE : String[] <static> The value for actions to create an edit and delete control.
Usage:
var config = {
actions: CQ.wcm....
<static> The value for actions to create an edit and delete control.
Usage:
|
EditBase | |
|
EditBase.EDITDELETEINSERT : String[] <static> The value for actions to create an edit, delete and insert control.
Usage:
var config = {
actions:...
<static> The value for actions to create an edit, delete and insert control.
Usage:
|
EditBase | |
|
EditBase.INLINE_MODE_AUTO : String
<static> Inline editing mode: auto. See inlineEditing.
|
EditBase | |
|
EditBase.INLINE_MODE_FORCED : String
<static> Inline editing mode: forced. See inlineEditing.
|
EditBase | |
|
EditBase.INLINE_MODE_NEVER : String
<static> Inline editing mode: never. See inlineEditing.
|
EditBase | |
|
EditBase.INSERT : String <static> The value for actions to create an insert control. Usages:
var config = {
actions: CQ.wcm.EditBase...
<static> The value for actions to create an insert control. Usages:
|
EditBase | |
|
EditBase.INSERTING_PARAGRAPH : String
<static> Loading text displayed when a paragraph is inserted.
|
EditBase | |
|
EditBase.INSERT_AFTER : String
<static> Constant for inserting a new component after another one.
|
EditBase | |
|
EditBase.INSERT_BEFORE : String
<static> Constant for inserting a new component before another one.
|
EditBase | |
|
EditBase.INSERT_LAST : String
<static> Constant for inserting a new component at the end.
|
EditBase | |
|
EditBase.PARSYS_NEW : string
<static> Resource type of the parsys placeholder.
|
EditBase | |
|
EditBase.REFERENCE_COMPONENT : String
<static> The resource type of the reference component.
|
EditBase | |
|
EditBase.REFERENCE_COMPONENT_PATH_PROPERTY : String
<static> The path property name of the reference component.
|
EditBase | |
|
EditBase.TARGET_COMPONENT : String
<static> Resource type of wrapper component used for targeting.
|
EditBase | |
|
EditBase.TARGET_MODE_GHOST : String
<static> Target mode: ghost. See targetMode.
|
EditBase | |
|
EditBase.TARGET_MODE_LINE : String
<static> Target mode: line. See targetMode.
|
EditBase | |
|
cq : String
<static> Name of the annotations folder.
|
EditBase | |
|
path : Object
Content path of the edit component.
|
EditBase | |
|
purpose : Object
Returns the parent of the current edit component (if available).
|
EditBase | |
| Method | Defined By | |
|---|---|---|
EditBase.showDialog( CQ.wcm.EditBar/CQ.wcm.EditRollover editComponent, [String type], [Boolean ignoreIsContainer] ) : void <static> Shows the dialog for the given edit component.
<static> Shows the dialog for the given edit component.
Parameters:
|
EditBase | |
|
cancelInplaceEditing() : void Cancels inplace editing (if inplace editing is currently active). Changed content
will be reverted.
Cancels inplace editing (if inplace editing is currently active). Changed content
will be reverted.
Parameters:
|
EditBase | |
copyParagraph( String path, String resourceType, [Boolean loadAnnotations], [Object undoCfg] ) : String Creates a copy of the paragraph with the specified path.
Creates a copy of the paragraph with the specified path.
Parameters:
|
EditBase | |
createParagraph( Object definition, [Object extraParams], [Boolean noEvent], [Boolean loadAnnotations], [Boolean ignoreTemplate], [Boolean preventUndo], [Object undoCfg] ) : String Creates a new paragraph using the specified definition.
Creates a new paragraph using the specified definition.
Parameters:
|
EditBase | |
doRemoveParagraph( Object item ) : void Removes the given item from the server.
Removes the given item from the server.
Parameters:
|
EditBase | |
equals( CQ.wcm.EditBar/CQ.wcm.EditRollover anotherEditComponent ) : Boolean Returns if current component and anotherEditComponent parameter have the same path.
Returns if current component and anotherEditComponent parameter have the same path.
Parameters:
|
EditBase | |
|
finishInplaceEditing() : void Finishes inplace editing (if inplace editing is currently active). Changed content
will be persisted.
Finishes inplace editing (if inplace editing is currently active). Changed content
will be persisted.
Parameters:
|
EditBase | |
getAnnotation( String id ) : CQ.wcm.Annotation Returns the specified annotation.
Returns the specified annotation.
Parameters:
|
EditBase | |
getAnnotationAt( String path ) : CQ.wcm.Annotation Returns the annotation at the specified path.
Returns the annotation at the specified path.
Parameters:
|
EditBase | |
|
getCell() : CQ.wcm.Cell Returns the design cell of this component
Returns the design cell of this component
Parameters:
|
EditBase | |
|
getParentFromDOM() : CQ.wcm.EditBase Returns the parent editable based on the DOM structure of the components,
or null if there is no parent.
Note: this c...
Returns the parent editable based on the DOM structure of the components,
or null if there is no parent.
Note: this could probably be moved into getParent() which currently does
a path-based parent identification. This needs proper testing though.
Parameters:
|
EditBase | |
|
getParentPath() : CQ.wcm.EditBar/CQ.wcm.EditRollover Returns the parent path of the current edit component (if available).
Returns the parent path of the current edit component (if available).
Parameters:
|
EditBase | |
|
getResourceSuperType() : String Returns the resource super type of the current edit component.
Returns the resource super type of the current edit component.
Parameters:
|
EditBase | |
|
getResourceType() : String Returns the resource type of the current edit component.
Returns the resource type of the current edit component.
Parameters:
|
EditBase | |
|
getTargetAncestor() : CQ.wcm.EditBase Returns the target component ancestor, or null if this component is not targeted.
Returns the target component ancestor, or null if this component is not targeted.
Parameters:
|
EditBase | |
|
getTargetParent() : s Returns the targeted wrapper of this component. Note that this is different from getTargetAncestor() in the way that ...
Returns the targeted wrapper of this component. Note that this is different from getTargetAncestor() in the way that it only goes to check one level up the DOM tree.
Parameters:
|
EditBase | |
|
hasAnnotations() : void Returns if this editable has registered annotations
Returns if this editable has registered annotations
Parameters:
|
EditBase | |
|
initRefreshShortcuts() : void String shortcuts for refresh listeners.
String shortcuts for refresh listeners.
Parameters:
|
EditBase | |
|
isActionCopyMove() : Boolean Returns true if EditBase.COPYMOVE action is defined for the current edit component.
Returns true if EditBase.COPYMOVE action is defined for the current edit component.
Parameters:
|
EditBase | |
|
isActionDelete() : Boolean Returns true if EditBase.DELETE action is defined for the current edit component.
Returns true if EditBase.DELETE action is defined for the current edit component.
Parameters:
|
EditBase | |
|
isActionEdit() : Boolean Returns true if EditBase.EDIT action is defined for the current edit component.
Returns true if EditBase.EDIT action is defined for the current edit component.
Parameters:
|
EditBase | |
|
isActionInsert() : Boolean Returns true if EditBase.INSERT action is defined for the current edit component.
Returns true if EditBase.INSERT action is defined for the current edit component.
Parameters:
|
EditBase | |
|
isActionInsertOnly() : Boolean Returns true if only EditBase.INSERT action is defined for the current edit component.
Returns true if only EditBase.INSERT action is defined for the current edit component.
Parameters:
|
EditBase | |
isInsertAllowed( String resourceType ) : Boolean Returns if insert on component of a certain resource type is allowed.
Returns if insert on component of a certain resource type is allowed.
Parameters:
|
EditBase | |
|
isReady() : Boolean Returns if the component is ready (rendered and events attached) or not
Returns if the component is ready (rendered and events attached) or not
Parameters:
|
EditBase | |
|
isRemovable() : s Checks if this component can be removed from its container (i.e. if it can have a "Delete" option).
It does so by che...
Checks if this component can be removed from its container (i.e. if it can have a "Delete" option).
It does so by checking if the component's parent is a container. Only components in a container (such as parsys/) can be removed.
Parameters:
|
EditBase | |
isSameParent( CQ.wcm.EditBar/CQ.wcm.EditRollover anotherEditComponent ) : Boolean Returns if current component and anotherEditComponent parameter have the same one level parent.
Returns if current component and anotherEditComponent parameter have the same one level parent.
Parameters:
|
EditBase | |
loadAnnotations( [Boolean preventAsync] ) : void Loads the annotations.
Note that (since 5.5) existing annotations are removed before loading commences
to prevent ann...
Loads the annotations. Note that (since 5.5) existing annotations are removed before loading commences to prevent annotations appearing multiple times if loaded multiple times.
Parameters:
|
EditBase | |
moveParagraph( String path, String resourceType, [Boolean loadAnnotations] ) : String Moves the paragraph with the specified path.
Moves the paragraph with the specified path.
Parameters:
|
EditBase | |
referenceParagraph( String path, [Object undoCfg] ) : String
Creates a reference to the paragraph with the specified path.
Creates a reference to the paragraph with the specified path.
Parameters:
|
EditBase | |
refresh( [String url], [Boolean smoothly] ) : void Refreshes the content element of the edit component.
Refreshes the content element of the edit component.
Parameters:
|
EditBase | |
refreshCreated( String path, Object definition, [Boolean loadAnnotations] ) : void
Refreshes a newly created paragraph.
Refreshes a newly created paragraph.
Parameters:
|
EditBase | |
|
refreshPage() : void Refreshes the page.
Refreshes the page.
Parameters:
|
EditBase | |
|
refreshParent() : void Refreshes the parent of the paragraph. If the parent is undefined, the
page will be refreshed.
Refreshes the parent of the paragraph. If the parent is undefined, the
page will be refreshed.
Parameters:
|
EditBase | |
|
refreshSelf() : void Refreshes the paragraph.
Refreshes the paragraph.
Parameters:
|
EditBase | |
refreshSelfMoved( String path, String newPath ) : void Refreshes the source and target paragraph after a move.
Refreshes the source and target paragraph after a move.
Parameters:
|
EditBase | |
|
removeParagraph() : void Removes the paragraph.
Removes the paragraph.
Parameters:
|
EditBase | |
|
startInplaceEditing() : void Starts inplace editing for the component if inplace editing is actually enabled for
it.
Starts inplace editing for the component if inplace editing is actually enabled for
it.
Parameters:
|
EditBase | |
targetComponent( [Boolean revert], [Boolean confirm] ) : void <static> Function to enable or disable targeting.
<static> Function to enable or disable targeting.
Parameters:
|
EditBase | |
|
updateComponentList() : void Collects the list of allowed components and updates the current
'component list'. before the update function on the c...
Collects the list of allowed components and updates the current
'component list'. before the update function on the component list is
called, an "updatecomponentlist" event is fired on this object.
this can be used to manipulate the list of allowed component dynamically.
eg:
function MyHandler(CQ.wcm.Cell cell, Array allowed, CQ.wcm.ComponentList componentList) {
// manipulate the 'allowed' array if needed
}
the "updatecomponentlist" listener can be registered using the normal
editConfig listeners on the container component (eg. parsys).
Please note that "runtime" manipulations of the component list is currently
not supported. i.e. if the list of allowed components depends on client side
changes, this can't be propagated to the dialogs.
Parameters:
|
EditBase | |
updateCqCssClass( String oldCls, String newCls ) : void updates the css class names on this element that are usually set by
the component includer and need a dynamic update ...
updates the css class names on this element that are usually set by
the component includer and need a dynamic update after a modification.
Parameters:
|
EditBase | |
updateParagraph( String propName, String/String[] values, [Object extraParams], [Boolean useDefaultSuccessFn], [CQ.Ext.form.BasicForm form] ) : Boolean Updates the paragraph using the specified property name and value(s).
Updates the paragraph using the specified property name and value(s).
Parameters:
|
EditBase | |