|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.explorer.CmsExplorerTypeSettings
Holds all information to build the explorer context menu of a resource type and information for the new resource dialog.
Objects of this type are sorted by their order value which specifies the order in the new resource dialog.
Field Summary | |
static int |
ORDER_VALUE_DEFAULT_START
The default order start value for context menu entries. |
static java.lang.String |
ORDER_VALUE_SEPARATOR_DEFAULT
The default order value for context menu separator entries without order attribute. |
Constructor Summary | |
CmsExplorerTypeSettings()
Default constructor. |
Method Summary | |
void |
addContextMenuEntry(CmsExplorerContextMenuItem item)
Adds a menu entry to the list of context menu items. |
void |
addContextMenuSeparator(CmsExplorerContextMenuItem item)
Adds a menu separator to the list of context menu items. |
boolean |
addProperty(java.lang.String propertyName)
Adds a property definition name to the list of editable properties. |
int |
compareTo(java.lang.Object obj)
|
void |
createContextMenu()
Adds all context menu entries to the context menu object. |
boolean |
equals(java.lang.Object o)
|
CmsExplorerTypeAccess |
getAccess()
Gets the access object of the type settings. |
CmsExplorerContextMenu |
getContextMenu()
Returns the context menu. |
java.util.List |
getContextMenuEntries()
Returns the list of context menu entries of the explorer type setting. |
java.lang.String |
getDescriptionImage()
Returns the descriptionImage. |
java.lang.String |
getIcon()
Returns the icon path and file name of the explorer type setting. |
java.lang.String |
getInfo()
Returns the info. |
java.lang.String |
getJSEntries(CmsExplorerTypeSettings settings,
int resTypeId,
CmsMessages messages)
Builds the Javascript to create the context menu. |
java.lang.String |
getKey()
Returns the key name of the explorer type setting. |
java.lang.String |
getName()
Returns the name of the explorer type setting. |
java.lang.String |
getNewResourceHandlerClassName()
Returns the class name of the new resource handler used to create new resources of a specified resource type. |
java.lang.String |
getNewResourceOrder()
Returns the order for the new resource dialog of the explorer type setting. |
java.lang.String |
getNewResourcePage()
Returns the page. |
java.lang.String |
getNewResourceUri()
Returns the URI for the new resource dialog of the explorer type setting. |
java.util.List |
getProperties()
Returns the list of properties of the explorer type setting. |
java.lang.String |
getReference()
Returns the reference of the explorer type setting. |
java.lang.String |
getTitleKey()
Returns the titleKey. |
boolean |
hasEditOptions()
Returns true if this explorer type entry has explicit edit options set. |
int |
hashCode()
|
boolean |
isAddititionalModuleExplorerType()
Indicates that this is an additional explorer type which is defined in a module. |
boolean |
isAutoSetNavigation()
Returns true if navigation properties should automatically be added on resource creation. |
boolean |
isAutoSetTitle()
Returns true if the title property should automatically be added on resource creation. |
boolean |
isEditable(CmsObject cms,
CmsResource resource)
Checks if the current user has write permissions on the given resource. |
boolean |
isPropertiesEnabled()
Returns if this explorer type setting uses a special properties dialog. |
boolean |
isShowNavigation()
Returns if this explorer type setting displays the navigation properties in the special properties dialog. |
void |
setAccess(CmsExplorerTypeAccess access)
Sets the access object of the type settings. |
void |
setAddititionalModuleExplorerType(boolean addititionalModuleExplorerType)
Sets the additional explorer type flag. |
void |
setAutoSetNavigation(java.lang.String autoSetNavigation)
Sets if navigation properties should automatically be added on resource creation. |
void |
setAutoSetTitle(java.lang.String autoSetTitle)
Sets if the title property should automatically be added on resource creation. |
void |
setContextMenuEntries(java.util.List entries)
Sets the list of context menu entries of the explorer type setting. |
void |
setDescriptionImage(java.lang.String descriptionImage)
Sets the descriptionImage. |
void |
setEditOptions()
Sets the flag if this explorer type entry has explicit edit options set. |
void |
setIcon(java.lang.String icon)
Sets the icon path and file name of the explorer type setting. |
void |
setInfo(java.lang.String info)
Sets the info. |
void |
setKey(java.lang.String key)
Sets the key name of the explorer type setting. |
void |
setName(java.lang.String name)
Sets the name of the explorer type setting. |
void |
setNewResourceHandlerClassName(java.lang.String newResourceHandlerClassName)
Sets the class name of the new resource handler used to create new resources of a specified resource type. |
void |
setNewResourceOrder(java.lang.String newResourceOrder)
Sets the order for the new resource dialog of the explorer type setting. |
void |
setNewResourcePage(java.lang.String page)
Sets the page. |
void |
setNewResourceUri(java.lang.String newResourceUri)
Sets the URI for the new resource dialog of the explorer type setting. |
void |
setProperties(java.util.List properties)
Sets the list of properties of the explorer type setting. |
void |
setPropertiesEnabled(boolean enabled)
Sets if this explorer type setting uses a special properties dialog. |
void |
setPropertyDefaults(java.lang.String enabled,
java.lang.String showNavigation)
Sets the default settings for the property display dialog. |
void |
setReference(java.lang.String reference)
Sets the reference of the explorer type setting. |
void |
setShowNavigation(boolean navigation)
Sets if this explorer type setting displays the navigation properties in the special properties dialog. |
void |
setTitleKey(java.lang.String titleKey)
Sets the titleKey. |
void |
setTypeAttributes(java.lang.String name,
java.lang.String key,
java.lang.String icon)
Sets the basic attributes of the type settings. |
void |
setTypeAttributes(java.lang.String name,
java.lang.String key,
java.lang.String icon,
java.lang.String reference)
Sets the basic attributes of the type settings. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ORDER_VALUE_DEFAULT_START
public static final java.lang.String ORDER_VALUE_SEPARATOR_DEFAULT
Constructor Detail |
public CmsExplorerTypeSettings()
Method Detail |
public void addContextMenuEntry(CmsExplorerContextMenuItem item)
item
- the entry item to add to the listpublic void addContextMenuSeparator(CmsExplorerContextMenuItem item)
item
- the separator item to add to the listpublic boolean addProperty(java.lang.String propertyName)
propertyName
- the name of the property definition to add
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
Comparable.compareTo(java.lang.Object)
public void createContextMenu()
This method has to be called when all context menu entries have been added to the list of entries.
public boolean equals(java.lang.Object o)
Object.equals(java.lang.Object)
public CmsExplorerTypeAccess getAccess()
public CmsExplorerContextMenu getContextMenu()
public java.util.List getContextMenuEntries()
public java.lang.String getDescriptionImage()
public java.lang.String getIcon()
public java.lang.String getInfo()
public java.lang.String getJSEntries(CmsExplorerTypeSettings settings, int resTypeId, CmsMessages messages)
settings
- the explorer type settings for which the context menu is createdresTypeId
- the id of the resource type which uses the context menumessages
- the messages to generate the context menu with (should be the workplace messages)
public java.lang.String getKey()
public java.lang.String getName()
public java.lang.String getNewResourceHandlerClassName()
public java.lang.String getNewResourceOrder()
public java.lang.String getNewResourcePage()
public java.lang.String getNewResourceUri()
public java.util.List getProperties()
public java.lang.String getReference()
public java.lang.String getTitleKey()
public boolean hasEditOptions()
public int hashCode()
Object.hashCode()
public boolean isAddititionalModuleExplorerType()
public boolean isAutoSetNavigation()
public boolean isAutoSetTitle()
public boolean isEditable(CmsObject cms, CmsResource resource)
cms
- the current cms contextresource
- the resource to check
true
if the current user has write permissions on the given resourcepublic boolean isPropertiesEnabled()
public boolean isShowNavigation()
public void setAccess(CmsExplorerTypeAccess access)
access
- access objectpublic void setAddititionalModuleExplorerType(boolean addititionalModuleExplorerType)
addititionalModuleExplorerType
- true or falsepublic void setAutoSetNavigation(java.lang.String autoSetNavigation)
autoSetNavigation
- true if properties should be added, otherwise falsepublic void setAutoSetTitle(java.lang.String autoSetTitle)
autoSetTitle
- true if title should be added, otherwise falsepublic void setContextMenuEntries(java.util.List entries)
entries
- the list of context menu entries of the explorer type settingpublic void setDescriptionImage(java.lang.String descriptionImage)
descriptionImage
- the descriptionImage to setpublic void setEditOptions()
This is determined by the presence of the <editoptions> node in the Cms workplace configuration.
public void setIcon(java.lang.String icon)
icon
- the icon path and file name of the explorer type settingpublic void setInfo(java.lang.String info)
info
- the info to setpublic void setKey(java.lang.String key)
key
- the key name of the explorer type settingpublic void setName(java.lang.String name)
name
- the name of the explorer type settingpublic void setNewResourceHandlerClassName(java.lang.String newResourceHandlerClassName)
newResourceHandlerClassName
- the class name of the new resource handlerpublic void setNewResourceOrder(java.lang.String newResourceOrder)
newResourceOrder
- the order for the new resource dialog of the explorer type settingpublic void setNewResourcePage(java.lang.String page)
page
- the page to setpublic void setNewResourceUri(java.lang.String newResourceUri)
newResourceUri
- the URI for the new resource dialog of the explorer type settingpublic void setProperties(java.util.List properties)
properties
- the list of properties of the explorer type settingpublic void setPropertiesEnabled(boolean enabled)
enabled
- true, if this explorer type setting uses a special properties dialogpublic void setPropertyDefaults(java.lang.String enabled, java.lang.String showNavigation)
enabled
- true, if this explorer type setting uses a special properties dialogshowNavigation
- true, if this explorer type setting displays the navigation properties in the special properties dialogpublic void setReference(java.lang.String reference)
reference
- the reference of the explorer type settingpublic void setShowNavigation(boolean navigation)
navigation
- true, if this explorer type setting displays the navigation properties in the special properties dialogpublic void setTitleKey(java.lang.String titleKey)
titleKey
- the titleKey to setpublic void setTypeAttributes(java.lang.String name, java.lang.String key, java.lang.String icon)
name
- the name of the type settingkey
- the key name of the explorer type settingicon
- the icon path and file name of the explorer type settingpublic void setTypeAttributes(java.lang.String name, java.lang.String key, java.lang.String icon, java.lang.String reference)
name
- the name of the type settingkey
- the key name of the explorer type settingicon
- the icon path and file name of the explorer type settingreference
- the reference of the explorer type setting
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |