org.opencms.ade.sitemap.client.CmsSitemapTreeItem Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.ade.sitemap.client;
import org.opencms.ade.sitemap.client.control.CmsSitemapController;
import org.opencms.ade.sitemap.client.hoverbar.CmsSitemapHoverbar;
import org.opencms.ade.sitemap.client.ui.css.I_CmsSitemapItemCss;
import org.opencms.ade.sitemap.client.ui.css.I_CmsSitemapLayoutBundle;
import org.opencms.ade.sitemap.shared.CmsClientSitemapEntry;
import org.opencms.ade.sitemap.shared.CmsClientSitemapEntry.EntryType;
import org.opencms.ade.sitemap.shared.CmsDetailPageTable;
import org.opencms.ade.sitemap.shared.CmsSitemapData.EditorMode;
import org.opencms.file.CmsResource;
import org.opencms.gwt.client.CmsCoreProvider;
import org.opencms.gwt.client.dnd.I_CmsDragHandle;
import org.opencms.gwt.client.dnd.I_CmsDropTarget;
import org.opencms.gwt.client.property.CmsReloadMode;
import org.opencms.gwt.client.ui.CmsAlertDialog;
import org.opencms.gwt.client.ui.CmsListItemWidget;
import org.opencms.gwt.client.ui.CmsListItemWidget.Background;
import org.opencms.gwt.client.ui.CmsListItemWidget.I_CmsTitleEditHandler;
import org.opencms.gwt.client.ui.css.I_CmsInputLayoutBundle;
import org.opencms.gwt.client.ui.input.CmsLabel;
import org.opencms.gwt.client.ui.input.CmsLabel.I_TitleGenerator;
import org.opencms.gwt.client.ui.tree.CmsLazyTreeItem;
import org.opencms.gwt.client.ui.tree.CmsTreeItem;
import org.opencms.gwt.client.util.CmsMessages;
import org.opencms.gwt.client.util.CmsStyleVariable;
import org.opencms.gwt.shared.CmsAdditionalInfoBean;
import org.opencms.gwt.shared.CmsListInfoBean;
import org.opencms.gwt.shared.CmsListInfoBean.LockIcon;
import org.opencms.gwt.shared.CmsListInfoBean.StateIcon;
import org.opencms.gwt.shared.property.CmsClientProperty;
import org.opencms.gwt.shared.property.CmsPropertyModification;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.RepeatingCommand;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.logical.shared.OpenEvent;
import com.google.gwt.event.logical.shared.OpenHandler;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.TextBox;
import com.google.gwt.user.client.ui.Widget;
/**
* Sitemap entry tree item implementation.
*
* @since 8.0.0
*
* @see org.opencms.gwt.client.ui.tree.CmsLazyTreeItem
* @see org.opencms.ade.sitemap.shared.CmsClientSitemapEntry
*/
public class CmsSitemapTreeItem extends CmsLazyTreeItem {
/**
* Label generator for the detail page info label.
*/
protected class DetailPageLabelTitleGenerator implements I_TitleGenerator {
/** The title to use for the detail page label.*/
private String m_detailPageTitle;
/**
* @see org.opencms.gwt.client.ui.input.CmsLabel.I_TitleGenerator#getTitle(java.lang.String)
*/
public String getTitle(String originalText) {
return m_detailPageTitle;
}
/**
* Sets the title to use for the detail page label.
*
* @param detailPageTitle the title to use
*/
public void setDetailPageTitle(String detailPageTitle) {
m_detailPageTitle = detailPageTitle;
}
}
/** The CSS bundle used by this widget. */
private static final I_CmsSitemapItemCss CSS = I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss();
/** A map of sitemap tree items by entry id. */
private static Map m_itemsById = new HashMap();
/** The current sitemap entry id. */
protected CmsUUID m_entryId;
/** The detail page label title generator. */
private DetailPageLabelTitleGenerator m_detailPageLabelTitleGenerator;
/** Style variable for to toggle in navigation style. */
private CmsStyleVariable m_inNavigationStyle;
/** Style variable for opener. */
private CmsStyleVariable m_openerForNonNavigationStyle;
/** Style variable for switching between 'children / no children' styles. */
private CmsStyleVariable m_styleHasChildren = new CmsStyleVariable(this);
/** Style variable for switching between 'navigation children / no navigation children' styles. */
private CmsStyleVariable m_styleHasNavChildren = new CmsStyleVariable(this);
/**
* Default constructor.
*
* @param entry the sitemap entry
*/
public CmsSitemapTreeItem(CmsClientSitemapEntry entry) {
super(generateItemWidget(entry), false);
m_opener.addStyleName(CSS.treeItemOpener());
m_styleHasChildren.setValue(CSS.hasChildren());
m_styleHasNavChildren.setValue(CSS.hasNavChildren());
m_entryId = entry.getId();
m_decoratedPanel.addDecorationBoxStyle(CSS.sitemapEntryDecoration());
m_detailPageLabelTitleGenerator = new DetailPageLabelTitleGenerator();
getListItemWidget().setUnselectable();
getListItemWidget().addOpenHandler(new OpenHandler() {
public void onOpen(OpenEvent event) {
CmsSitemapView.getInstance().getController().updateSingleEntry(m_entryId);
}
});
getListItemWidget().addIconClickHandler(new ClickHandler() {
public void onClick(ClickEvent event) {
CmsSitemapController controller = CmsSitemapView.getInstance().getController();
CmsClientSitemapEntry sitemapEntry = controller.getEntryById(m_entryId);
if (sitemapEntry != null) {
if (sitemapEntry.isSubSitemapType()) {
controller.openSiteMap(sitemapEntry.getSitePath());
} else if (sitemapEntry.isNavigationLevelType()) {
if (!sitemapEntry.getSubEntries().isEmpty()) {
CmsClientSitemapEntry subEntry = sitemapEntry.getSubEntries().get(0);
if (!subEntry.isNavigationLevelType()) {
controller.leaveEditor(subEntry.getSitePath());
return;
}
}
getListItemWidget().setIconTitle(
Messages.get().key(Messages.GUI_NAVIGATION_LEVEL_UNKOWN_TARGET_0));
} else {
controller.leaveEditor(sitemapEntry.getSitePath());
}
}
}
});
m_inNavigationStyle = new CmsStyleVariable(this);
m_openerForNonNavigationStyle = new CmsStyleVariable(m_opener);
getListItemWidget().addTitleStyleName(CSS.itemTitle());
updateInNavigation(entry);
m_itemsById.put(m_entryId, this);
setId(getName(entry.getSitePath()));
updateSitePath(entry.getSitePath());
updateDetailPageStatus();
updateLock(entry);
if (!entry.isFolderType()) {
hideOpeners();
}
setDropEnabled(entry.isFolderType() && !entry.hasForeignFolderLock());
getListItemWidget().setTitleEditHandler(new I_CmsTitleEditHandler() {
/**
* @see org.opencms.gwt.client.ui.CmsListItemWidget.I_CmsTitleEditHandler#handleEdit(org.opencms.gwt.client.ui.input.CmsLabel, com.google.gwt.user.client.ui.TextBox)
*/
public void handleEdit(CmsLabel titleLabel, TextBox box) {
CmsClientSitemapEntry editEntry = getSitemapEntry();
final String newTitle = box.getText();
box.removeFromParent();
if (CmsStringUtil.isEmpty(newTitle)) {
titleLabel.setVisible(true);
String dialogTitle = Messages.get().key(Messages.GUI_EDIT_TITLE_ERROR_DIALOG_TITLE_0);
String dialogText = Messages.get().key(Messages.GUI_TITLE_CANT_BE_EMPTY_0);
CmsAlertDialog alert = new CmsAlertDialog(dialogTitle, dialogText);
alert.center();
return;
}
String oldTitle = editEntry.getTitle();
if (!oldTitle.equals(newTitle)) {
CmsPropertyModification propMod = new CmsPropertyModification(
editEntry.getId(),
CmsClientProperty.PROPERTY_NAVTEXT,
newTitle,
true);
final List propChanges = new ArrayList();
propChanges.add(propMod);
CmsSitemapController controller = CmsSitemapView.getInstance().getController();
if (editEntry.isNew() && !editEntry.isRoot() && !oldTitle.equalsIgnoreCase(newTitle)) {
String urlName = controller.ensureUniqueName(
CmsResource.getParentFolder(editEntry.getSitePath()),
newTitle);
if (oldTitle.equals(editEntry.getPropertyValue(CmsClientProperty.PROPERTY_TITLE))) {
CmsPropertyModification titleMod = new CmsPropertyModification(
editEntry.getId(),
CmsClientProperty.PROPERTY_TITLE,
newTitle,
true);
propChanges.add(titleMod);
}
controller.editAndChangeName(editEntry, urlName, propChanges, true, CmsReloadMode.reloadEntry);
} else {
controller.edit(editEntry, propChanges, CmsReloadMode.reloadEntry);
}
}
titleLabel.setVisible(true);
}
});
}
/**
* Looks up a sitemap tree item by entry id.
*
* @param id the sitemap entry id
* @return the corresponding sitemap tree item, or null if there is none
*/
public static CmsSitemapTreeItem getItemById(CmsUUID id) {
return m_itemsById.get(id);
}
/**
* Helper method to add an additional info bean to a list.
*
* @param infos the list of additional info beans
* @param label the label for the new bean
* @param value the value for the new bean
*/
protected static void addInfo(List infos, String label, String value) {
infos.add(new CmsAdditionalInfoBean(label, value, null));
}
/**
* Returns the list info bean for the given entry.
*
* @param entry the sitemap entry
* @param navMode a flag indicating whether we want the info bean for navigation mode or VFS mode
*
* @return the list info bean
*/
static CmsListInfoBean getInfoBean(CmsClientSitemapEntry entry, boolean navMode) {
CmsListInfoBean infoBean = new CmsListInfoBean();
infoBean.setTitle(entry.getTitle());
infoBean.setSubTitle(entry.getSitePath());
// showing the resource type icon of the default file in navigation mode
infoBean.setResourceType(
CmsStringUtil.isNotEmptyOrWhitespaceOnly(entry.getDefaultFileType())
? entry.getDefaultFileType()
: entry.getResourceTypeName());
infoBean.setResourceState(entry.getResourceState());
CmsMessages msg = Messages.get();
List infos = new ArrayList();
addInfo(infos, msg.key(Messages.GUI_NAME_0), entry.getName());
boolean isTitleSet = false;
if (navMode) {
// in nav mode, display the title of the page rather than that of the folder, if available
Map defaultFileProps = entry.getDefaultFileProperties();
CmsClientProperty titleProperty = defaultFileProps == null
? null
: defaultFileProps.get(CmsClientProperty.PROPERTY_TITLE);
if ((titleProperty != null) && !titleProperty.isEmpty()) {
addInfo(infos, msg.key(Messages.GUI_TITLE_PROPERTY_0), titleProperty.getEffectiveValue());
isTitleSet = true;
}
}
if (!isTitleSet) {
CmsClientProperty titleProperty = entry.getOwnProperties().get(CmsClientProperty.PROPERTY_TITLE);
if ((titleProperty != null) && !titleProperty.isEmpty()) {
addInfo(infos, msg.key(Messages.GUI_TITLE_PROPERTY_0), titleProperty.getEffectiveValue());
isTitleSet = true;
}
}
String shownPath = entry.getVfsPath();
if (CmsStringUtil.isEmptyOrWhitespaceOnly(shownPath)) {
shownPath = "-";
}
addInfo(infos, msg.key(Messages.GUI_VFS_PATH_0), shownPath);
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(entry.getDateReleased())) {
addInfo(infos, msg.key(Messages.GUI_LABEL_DATE_RELEASED_0), entry.getDateReleased());
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(entry.getDateExpired())) {
addInfo(infos, msg.key(Messages.GUI_LABEL_DATE_EXPIRED_0), entry.getDateExpired());
}
if (entry.getEntryType() == EntryType.redirect) {
addInfo(infos, msg.key(Messages.GUI_LABEL_TARGET_0), entry.getRedirectTarget());
}
if (entry.getAliases() != null) {
int counter = 1;
for (String aliasPath : entry.getAliases()) {
addInfo(infos, msg.key(Messages.GUI_LABEL_ALIAS_1, counter + ""), aliasPath);
counter += 1;
}
}
infoBean.setAdditionalInfo(infos);
return infoBean;
}
/**
* Generates the list item widget for the tree item.
*
* @param entry the sitemap entry
*
* @return the list item widget
*/
private static CmsListItemWidget generateItemWidget(final CmsClientSitemapEntry entry) {
CmsListInfoBean infoBean = getInfoBean(entry, true);
final CmsListItemWidget itemWidget = new CmsListItemWidget(infoBean);
itemWidget.setUnselectable();
itemWidget.setIcon(CmsSitemapView.getInstance().getIconForEntry(entry));
itemWidget.setTopRightIcon(null, "");
itemWidget.setIconTitle(
entry.isSubSitemapType()
? Messages.get().key(Messages.GUI_HOVERBAR_GOTO_SUB_0)
: Messages.get().key(Messages.GUI_HOVERBAR_GOTO_0));
setAdditionalStyles(entry, itemWidget);
return itemWidget;
}
/**
* Sets the additional style to mark expired entries or those that have the hide in navigation property set.
*
* @param entry the sitemap entry
* @param itemWidget the item widget
*/
private static void setAdditionalStyles(CmsClientSitemapEntry entry, CmsListItemWidget itemWidget) {
if (!entry.isResleasedAndNotExpired()
|| ((CmsSitemapView.getInstance().getEditorMode() == EditorMode.navigation)
&& !entry.isDefaultFileReleased())) {
itemWidget.getContentPanel().addStyleName(
I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().expiredOrNotReleased());
} else {
itemWidget.getContentPanel().removeStyleName(
I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().expiredOrNotReleased());
}
if (entry.isHiddenNavigationEntry()) {
itemWidget.getContentPanel().addStyleName(
I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().hiddenNavEntry());
} else {
itemWidget.getContentPanel().removeStyleName(
I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().hiddenNavEntry());
}
}
/**
* Given the path of a sitemap entry, this method returns the URL which should be displayed to the user.
*
* @param sitePath the site path of a sitemap entry
*
* @return the URL which should be displayed to the user
*/
public String getDisplayedUrl(String sitePath) {
if (getSitemapEntry().isLeafType() && sitePath.endsWith("/")) {
sitePath = sitePath.substring(0, sitePath.length() - 1);
}
CmsSitemapController controller = CmsSitemapView.getInstance().getController();
String exportProp = controller.getEffectiveProperty(getSitemapEntry(), "export");
if ("true".equals(exportProp)) {
String exportName = getSitemapEntry().getExportName();
if (exportName == null) {
exportName = CmsCoreProvider.get().getSiteRoot();
}
String rfsPrefix = CmsSitemapView.getInstance().getController().getData().getExportRfsPrefix();
if (rfsPrefix != null) {
return CmsStringUtil.joinPaths(rfsPrefix, exportName, sitePath);
}
}
return CmsCoreProvider.get().link(sitePath);
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDraggable#getDragHelper(I_CmsDropTarget)
*/
@Override
public Element getDragHelper(I_CmsDropTarget target) {
Element helper = super.getDragHelper(target);
// ensure the proper CSS context for the drag helper
m_provisionalParent.addClassName(I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().navMode());
return helper;
}
/**
* Returns the entry id.
*
* @return the entry id
*/
public CmsUUID getEntryId() {
return m_entryId;
}
/**
* @see org.opencms.gwt.client.ui.CmsListItem#getMoveHandle()
*/
@Override
public I_CmsDragHandle getMoveHandle() {
CmsSitemapHoverbar hoverbar = getHoverbar();
if (hoverbar != null) {
int count = hoverbar.getWidgetCount();
if (count > 0) {
for (int i = 0; i < count; i++) {
Widget w = hoverbar.getWidget(i);
if (w instanceof I_CmsDragHandle) {
return (I_CmsDragHandle)w;
}
}
}
}
return null;
}
/**
* @see org.opencms.gwt.client.ui.tree.CmsTreeItem#getPath()
*/
@Override
public String getPath() {
String result = getSitePath();
// ensure that the path of a folder ends with a '/'
if (getSitemapEntry().isFolderType() && !result.endsWith("/")) {
result += "/";
}
return result;
}
/**
* Returns the sitemap entry.
*
* @return the sitemap entry
*/
public CmsClientSitemapEntry getSitemapEntry() {
return CmsSitemapView.getInstance().getController().getEntryById(m_entryId);
}
/**
* Returns the site path.
*
* @return the site path
*/
public String getSitePath() {
return getSitemapEntry().getSitePath();
}
/**
* Turns the highlighting for this item on or off.
*
* @param highlightOn if true, the highlighting is turned on, else off
*/
public void highlight(boolean highlightOn) {
if (highlightOn) {
setBackgroundColor(Background.YELLOW);
} else {
setBackgroundColor(Background.DEFAULT);
}
}
/**
* Temporarily highlights an item.
*
* @param duration the duration for which
* @param background the background to color to set when finished
*/
public void highlightTemporarily(int duration, final Background background) {
int blinkInterval = 300;
final int blinkCount = duration / blinkInterval;
Scheduler.get().scheduleFixedPeriod(new RepeatingCommand() {
private int m_counter;
/**
* @see com.google.gwt.core.client.Scheduler.RepeatingCommand#execute()
*/
public boolean execute() {
boolean finish = m_counter > blinkCount;
highlight(((m_counter % 2) == 0) && !finish);
m_counter += 1;
if (finish) {
setBackgroundColor(background);
}
return !finish;
}
}, blinkInterval);
}
/**
* @see org.opencms.gwt.client.ui.tree.CmsTreeItem#isDropEnabled()
*/
@Override
public boolean isDropEnabled() {
CmsClientSitemapEntry entry = getSitemapEntry();
return !entry.hasForeignFolderLock() && entry.isInNavigation() && entry.isFolderType() && super.isDropEnabled();
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDraggable#onDragCancel()
*/
@Override
public void onDragCancel() {
removeStyleName(I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().positionIndicator());
super.onDragCancel();
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDraggable#onDrop(org.opencms.gwt.client.dnd.I_CmsDropTarget)
*/
@Override
public void onDrop(I_CmsDropTarget target) {
removeStyleName(I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().positionIndicator());
super.onDrop(target);
}
/**
* @see org.opencms.gwt.client.ui.CmsListItem#onStartDrag(org.opencms.gwt.client.dnd.I_CmsDropTarget)
*/
@Override
public void onStartDrag(I_CmsDropTarget target) {
setOpen(false);
// transform the widget into a position indicator
addStyleName(I_CmsSitemapLayoutBundle.INSTANCE.sitemapItemCss().positionIndicator());
CmsSitemapHoverbar hoverbar = getHoverbar();
if (hoverbar != null) {
hoverbar.hide();
}
}
/**
* Resets entry appearance.
*/
public void resetEntry() {
updateEntry(getSitemapEntry());
}
/**
* Sets the background color of the list item widget.
*
* If the background is null, the widget will be shown with its default style.
*
* @param background the background color to set
*/
public void setBackgroundColor(Background background) {
getListItemWidget().setBackground(background);
}
/**
* Sets the icon.
*
* @param icon the icon to set
*/
public void setStateIcon(StateIcon icon) {
getListItemWidget().setStateIcon(icon);
}
/**
* @see com.google.gwt.user.client.ui.UIObject#toString()
*/
@Override
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append(getSitemapEntry().getSitePath()).append("\n");
for (int i = 0; i < getChildCount(); i++) {
CmsTreeItem child = getChild(i);
if (child instanceof CmsLazyTreeItem.LoadingItem) {
continue;
}
sb.append(child.toString());
}
return sb.toString();
}
/**
* Updates the detail page description.
*/
public void updateDetailPageStatus() {
CmsDetailPageTable detailPageTable = CmsSitemapView.getInstance().getController().getDetailPageTable();
String type;
String text = null;
String suffixTitle = null;
switch (detailPageTable.getStatus(m_entryId)) {
case firstDetailPage:
type = detailPageTable.get(m_entryId).getDisplayType();
suffixTitle = Messages.get().key(Messages.GUI_MAIN_DETAIL_PAGE_TITLE_1, type);
text = "(*" + type + ")";
break;
case otherDetailPage:
type = detailPageTable.get(m_entryId).getDisplayType();
suffixTitle = Messages.get().key(Messages.GUI_DETAIL_PAGE_TITLE_1, type);
text = "(" + type + ")";
break;
case noDetailPage:
default:
}
m_detailPageLabelTitleGenerator.setDetailPageTitle(suffixTitle);
getListItemWidget().updateTruncation();
Widget label = getListItemWidget().getShortExtraInfoLabel();
label.addStyleName(I_CmsInputLayoutBundle.INSTANCE.inputCss().subtitleSuffix());
getListItemWidget().setExtraInfo(text);
}
/**
* Updates the sitemap editor mode.
*/
public void updateEditorMode() {
CmsClientSitemapEntry entry = getSitemapEntry();
getListItemWidget().setIcon(CmsSitemapView.getInstance().getIconForEntry(entry));
setAdditionalStyles(entry, getListItemWidget());
for (Widget child : m_children) {
if (child instanceof CmsSitemapTreeItem) {
((CmsSitemapTreeItem)child).updateEditorMode();
}
}
}
/**
* Refreshes the displayed data from the given sitemap entry.
*
* @param entry the sitemap entry to update
*/
public void updateEntry(CmsClientSitemapEntry entry) {
getListItemWidget().setTitleLabel(entry.getTitle());
getListItemWidget().reInitAdditionalInfo(getInfoBean(entry, CmsSitemapView.getInstance().isNavigationMode()));
updateSitePath(entry.getSitePath());
updateDetailPageStatus();
updateLock(entry);
updateInNavigation(entry);
getListItemWidget().setIcon(CmsSitemapView.getInstance().getIconForEntry(entry));
setAdditionalStyles(entry, getListItemWidget());
setDropEnabled(getSitemapEntry().isFolderType() && !getSitemapEntry().hasForeignFolderLock());
if (entry.isSubSitemapType() || entry.isLeafType()) {
hideOpeners();
} else {
showOpeners();
}
getListItemWidget().updateTruncation();
}
/**
* Updates the in navigation properties of the displayed entry.
*
* @param entry the sitemap entry
*/
public void updateInNavigation(CmsClientSitemapEntry entry) {
if (entry.isInNavigation()) {
m_inNavigationStyle.setValue(null);
getListItemWidget().setTitleEditable(true);
} else {
m_inNavigationStyle.setValue(CSS.notInNavigationEntry());
getListItemWidget().setTitleEditable(false);
}
}
/**
* Updates the site path using the current site entry's data.
*/
public void updateSitePath() {
updateSitePath(getSitemapEntry().getSitePath());
}
/**
* Updates the recursively the site path.
*
* @param sitePath the new site path to set
*/
public void updateSitePath(String sitePath) {
String newSubTitle = getDisplayedUrl(sitePath);
removeInvalidChildren();
getListItemWidget().setSubtitleLabel(newSubTitle);
String name = getName(sitePath);
setId(name);
getListItemWidget().setAdditionalInfoValue(1, name);
if (getLoadState() == LoadState.LOADED) {
for (int i = 0; i < getChildCount(); i++) {
CmsSitemapTreeItem item = (CmsSitemapTreeItem)getChild(i);
if ((item != null)
&& (CmsSitemapView.getInstance().getController().getEntryById(item.getEntryId()) != null)) {
String path = CmsStringUtil.joinPaths(sitePath, CmsResource.getName(item.getSitePath()));
item.updateSitePath(path);
}
}
}
getListItemWidget().updateTruncation();
}
/**
* Helper method for adding the marker widget.
*
* @param text the text for the marker widget
*
* @return the new marker widget
*/
protected Widget addMarker(String text) {
Label label = new Label(text);
label.addStyleName(CSS.marker());
getListItemWidget().addButton(label);
return label;
}
/**
* Return the name of this item, which can differ from the entry name for root nodes.
*
* @param sitePath the sitemap entry's site path
*
* @return the name
*/
protected String getName(String sitePath) {
String name = CmsResource.getName(sitePath);
if (name.endsWith("/")) {
name = name.substring(0, name.length() - 1);
}
return name;
}
/**
* @see org.opencms.gwt.client.ui.tree.CmsLazyTreeItem#onChangeChildren()
*/
@Override
protected void onChangeChildren() {
super.onChangeChildren();
if (m_openerForNonNavigationStyle == null) {
// happens when initializing
return;
}
removeInvalidChildren();
boolean hasChildren = false;
boolean hasNavChildren = false;
for (Widget childWidget : m_children) {
if (childWidget instanceof CmsSitemapTreeItem) {
hasChildren = true;
CmsSitemapTreeItem treeItem = (CmsSitemapTreeItem)childWidget;
if (treeItem.getSitemapEntry().isInNavigation()) {
hasNavChildren = true;
break; // both flags set to true, no more iterations needed
}
}
}
m_styleHasChildren.setValue(hasChildren ? CSS.hasChildren() : CSS.hasNoChildren());
m_styleHasNavChildren.setValue(hasNavChildren ? CSS.hasNavChildren() : CSS.hasNoNavChildren());
}
/**
* Helper method to remove invalid children that don't have a corresponding CmsSitemapClientEntry.
*/
protected void removeInvalidChildren() {
if (getLoadState() == LoadState.LOADED) {
List toDelete = new ArrayList();
for (int i = 0; i < getChildCount(); i++) {
CmsSitemapTreeItem item = (CmsSitemapTreeItem)getChild(i);
CmsUUID id = item.getEntryId();
if ((id != null) && (CmsSitemapView.getInstance().getController().getEntryById(id) == null)) {
toDelete.add(item);
}
}
for (CmsSitemapTreeItem deleteItem : toDelete) {
m_children.removeItem(deleteItem);
}
}
}
/**
* Retrieves the hoverbar, can be null if not attached.
*
* @return the hoverbar, or null if not attached
*/
private CmsSitemapHoverbar getHoverbar() {
for (Widget w : getListItemWidget().getContentPanel()) {
if (!(w instanceof CmsSitemapHoverbar)) {
continue;
}
return (CmsSitemapHoverbar)w;
}
return null;
}
/**
* Updates the lock icon according to the entry information.
*
* @param entry the entry
*/
private void updateLock(CmsClientSitemapEntry entry) {
LockIcon icon = LockIcon.NONE;
String iconTitle = null;
if (entry.hasBlockingLockedChildren()) {
icon = LockIcon.CLOSED;
iconTitle = Messages.get().key(Messages.GUI_BLOCKING_LOCKED_CHILDREN_0);
}
if (!entry.getLock().isOwnedByUser()) {
switch (entry.getLock().getLockType()) {
case EXCLUSIVE:
case INHERITED:
case TEMPORARY:
icon = LockIcon.CLOSED;
break;
case SHARED_EXCLUSIVE:
case SHARED_INHERITED:
icon = LockIcon.SHARED_CLOSED;
break;
default:
}
} else {
switch (entry.getLock().getLockType()) {
case EXCLUSIVE:
case INHERITED:
case TEMPORARY:
icon = LockIcon.OPEN;
break;
case SHARED_EXCLUSIVE:
case SHARED_INHERITED:
icon = LockIcon.SHARED_OPEN;
break;
default:
}
}
if (entry.getLock().getLockOwner() != null) {
iconTitle = org.opencms.gwt.client.Messages.get().key(
org.opencms.gwt.client.Messages.GUI_LOCK_OWNED_BY_1,
entry.getLock().getLockOwner());
}
getListItemWidget().setLockIcon(icon, iconTitle);
}
}