public interface EditConfig extends ComponentEditConfig
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
LISTENER_AFTERCREATE
Name of the edit listener that is invoked after
a new component was created.
|
static java.lang.String |
LISTENER_AFTERDELETE
Name of the edit listener that is invoked after
a component was deleted.
|
static java.lang.String |
LISTENER_AFTEREDIT
Name of the edit listener that is invoked after
a component was edited (and modified).
|
static java.lang.String |
LISTENER_AFTERINSERT
Name of the edit listener that is invoked after
a component was inserted in this container component.
|
static java.lang.String |
LISTENER_AFTERMOVE
Name of the edit listener that is invoked after
a component was moved within this container component.
|
static java.lang.String |
LISTENER_AFTERREMOVE
Name of the edit listener that is invoked after
a component was removed from this container component.
|
static java.lang.String |
REFRESH_PAGE
Predefined key for the 'CQ.wcm.EditBase.refreshPage' listener.
|
static java.lang.String |
REFRESH_PARENT
Predefined key for the 'CQ.wcm.EditBase.refreshParent' listener.
|
static java.lang.String |
REFRESH_SELF
Predefined key for the 'CQ.wcm.EditBase.refreshSelf' listener.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,DropTarget> |
getDropTargets()
Returns amap of configurations of drop targets.
|
java.util.Map<java.lang.String,java.lang.Object> |
getFormParameterMap()
Returns the additional form parameters to be included in the dialog.
|
java.util.Map<java.lang.String,java.lang.String> |
getFormParameters()
Returns a modifiable map for additional form parameters to be included
in the dialog.
|
java.util.Map<java.lang.String,java.lang.String> |
getListeners()
Returns a modifiable map of edit listeners
|
Toolbar |
getToolbar()
Returns the (modifiable) toolbar for the editbar/menu.
|
void |
setDeepCancel(java.lang.Boolean deepCancel)
Sets if cancelling inheritance of the component sets the cq:isCancelledForChildren flag or not.
|
void |
setDialogMode(DialogMode mode)
Sets the dialog mode
|
void |
setEmpty(boolean empty)
Sets the
empty flag. |
void |
setEmptyText(java.lang.String text)
Sets the text to be displayed when
ComponentEditConfig.isEmpty() is true . |
void |
setInplaceEditingConfig(InplaceEditingConfig inplaceEditingConfig)
Sets the inplace editing configuration.
|
void |
setInsertBehavior(java.lang.String behavior)
Sets the insert behavior
|
void |
setLayout(EditLayout layout)
Sets the edit layout for the edit control widget.
|
void |
setLiveRelationship(JSONItem liveRelationship)
Set the computed live relationship of the component
TODO seems like we are only considering this as an additional JSONItem
to render - if that's confirmed we might rename this method.
|
void |
setOrderable(java.lang.Boolean orderable)
Sets if the edited component is orderable.
|
getDialogMode, getEmptyText, getInplaceEditingConfig, getInsertBehavior, getLayout, getLiveRelationship, isDeepCancel, isDefault, isEmpty, isOrderable, isTargetingDisabled
static final java.lang.String LISTENER_AFTERCREATE
getListeners()
,
Constant Field Valuesstatic final java.lang.String LISTENER_AFTEREDIT
getListeners()
,
Constant Field Valuesstatic final java.lang.String LISTENER_AFTERDELETE
getListeners()
,
Constant Field Valuesstatic final java.lang.String LISTENER_AFTERINSERT
getListeners()
,
Constant Field Valuesstatic final java.lang.String LISTENER_AFTERREMOVE
getListeners()
,
Constant Field Valuesstatic final java.lang.String LISTENER_AFTERMOVE
getListeners()
,
Constant Field Valuesstatic final java.lang.String REFRESH_PAGE
getListeners()
,
Constant Field Valuesstatic final java.lang.String REFRESH_SELF
getListeners()
,
Constant Field Valuesstatic final java.lang.String REFRESH_PARENT
getListeners()
,
Constant Field Valuesvoid setLayout(EditLayout layout)
layout
- edit layoutjava.util.Map<java.lang.String,DropTarget> getDropTargets()
getDropTargets
in interface ComponentEditConfig
void setDialogMode(DialogMode mode)
mode
- the modevoid setInplaceEditingConfig(InplaceEditingConfig inplaceEditingConfig)
inplaceEditingConfig
- The inplace editing configurationvoid setInsertBehavior(java.lang.String behavior)
behavior
- the behaviorvoid setEmpty(boolean empty)
empty
flag. If true
this indicates
that the component has not visual content and a placeholder text should
be rendered.empty
- true
if a placeholder text should be rendered.void setEmptyText(java.lang.String text)
ComponentEditConfig.isEmpty()
is true
.
If text
is null
then the default text is displayed.text
- the text or null
void setOrderable(java.lang.Boolean orderable)
orderable
- true
to enable ordering or null
if the behavior is defined by the widgets.Toolbar getToolbar()
getToolbar
in interface ComponentEditConfig
java.util.Map<java.lang.String,java.lang.String> getFormParameters()
getFormParameters
in interface ComponentEditConfig
java.util.Map<java.lang.String,java.lang.Object> getFormParameterMap()
getFormParameterMap
in interface ComponentEditConfig
java.util.Map<java.lang.String,java.lang.String> getListeners()
getListeners
in interface ComponentEditConfig
void setLiveRelationship(JSONItem liveRelationship)
liveRelationship
- the relationship to setvoid setDeepCancel(java.lang.Boolean deepCancel)
deepCancel
- true
if cancel sets the flag or null
if cancel does not set the flag.Copyright © 2010 - 2020 Adobe. All Rights Reserved