inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

- Incorporated new sidebar which contains the shelf and navigator (tree) components

Browse Source 
- Changed version number to 2.0.0 (dev)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4538 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Gavin Cornwell
2006-12-06 23:26:27 +00:00
parent 8f17798cde
commit 98c5a2071c
46 changed files with 3649 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

241
source/java/org/alfresco/web/config/SidebarConfigElement.java Normal file
View File

@@ -0,0 +1,241 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.web.config;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.config.ConfigElement;
import org.alfresco.config.ConfigException;
import org.alfresco.config.element.ConfigElementAdapter;
import org.alfresco.util.ParameterCheck;
/**
* Custom config element that represents the config data for the sidebar
*
* @author gavinc
*/
public class SidebarConfigElement extends ConfigElementAdapter
{
public static final String CONFIG_ELEMENT_ID = "sidebar";
private String defaultPlugin;
private Map<String, SidebarPluginConfig> plugins = new LinkedHashMap<String, SidebarPluginConfig>(8, 10f);
/**
* Default constructor
*/
public SidebarConfigElement()
{
super(CONFIG_ELEMENT_ID);
}
/**
* Constructor
*
* @param name Name of the element this config element represents
*/
public SidebarConfigElement(String name)
{
super(name);
}
/**
* @see org.alfresco.config.ConfigElement#getChildren()
*/
public List<ConfigElement> getChildren()
{
throw new ConfigException("Reading the sidebar config via the generic interfaces is not supported");
}
/**
* @see org.alfresco.config.ConfigElement#combine(org.alfresco.config.ConfigElement)
*/
public ConfigElement combine(ConfigElement configElement)
{
SidebarConfigElement newElement = (SidebarConfigElement)configElement;
SidebarConfigElement combinedElement = new SidebarConfigElement();
// add all the plugins from this element
for (SidebarPluginConfig plugin : this.getPlugins().values())
{
combinedElement.addPlugin(plugin);
}
// add all the plugins from the given element
for (SidebarPluginConfig plugin : newElement.getPlugins().values())
{
combinedElement.addPlugin(plugin);
}
// work out the default plugin
String newDefaultPlugin = newElement.getDefaultPlugin();
if (newDefaultPlugin != null)
{
combinedElement.setDefaultPlugin(newDefaultPlugin);
}
else
{
combinedElement.setDefaultPlugin(this.getDefaultPlugin());
}
return combinedElement;
}
/**
* Returns the named plugin
*
* @param id The id of the plugin to retrieve
* @return The SidebarPluginConfig object for the requested plugin or null if it doesn't exist
*/
public SidebarPluginConfig getPlugin(String id)
{
return this.plugins.get(id);
}
/**
* @return Returns a map of the plugins. A linked hash map is used internally to
* preserve ordering.
*/
public Map<String, SidebarPluginConfig> getPlugins()
{
return this.plugins;
}
/**
* @return The id of the default plugin, null if there isn't a default defined
*/
public String getDefaultPlugin()
{
return this.defaultPlugin;
}
/**
* Sets the plugin to use as the default
*
* @param defaultPlugin Id of the default plugin
*/
public void setDefaultPlugin(String defaultPlugin)
{
this.defaultPlugin = defaultPlugin;
}
/**
* Adds a plugin
*
* @param pluginConfig A pre-configured plugin config object
*/
/*package*/ void addPlugin(SidebarPluginConfig pluginConfig)
{
this.plugins.put(pluginConfig.getId(), pluginConfig);
}
/**
* Inner class representing the configuration of a sidebar plugin
*
* @author gavinc
*/
public static class SidebarPluginConfig
{
protected String id;
protected String page;
protected String actionsConfigId;
protected String icon;
protected String label;
protected String labelId;
protected String description;
protected String descriptionId;
public SidebarPluginConfig(String id, String page,
String label, String labelId,
String description, String descriptionId,
String actionsConfigId, String icon)
{
// check the mandatory parameters are present
ParameterCheck.mandatoryString("id", id);
ParameterCheck.mandatoryString("page", page);
this.id = id;
this.page = page;
this.icon = icon;
this.label = label;
this.labelId = labelId;
this.description = description;
this.descriptionId = descriptionId;
this.actionsConfigId = actionsConfigId;
}
public String getId()
{
return this.id;
}
public String getPage()
{
return this.page;
}
public String getIcon()
{
return this.icon;
}
public String getlabel()
{
return this.label;
}
public String getlabelId()
{
return this.labelId;
}
public String getDescription()
{
return this.description;
}
public String getDescriptionId()
{
return this.descriptionId;
}
public String getActionsConfigId()
{
return this.actionsConfigId;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder buffer = new StringBuilder(super.toString());
buffer.append(" (id=").append(this.id);
buffer.append(" page=").append(this.page);
buffer.append(" icon=").append(this.icon);
buffer.append(" label=").append(this.label);
buffer.append(" labelId=").append(this.labelId);
buffer.append(" description=").append(this.description);
buffer.append(" descriptionId=").append(this.descriptionId);
buffer.append(" actions-config-id=").append(this.actionsConfigId).append(")");
return buffer.toString();
}
}
}

103
source/java/org/alfresco/web/config/SidebarElementReader.java Normal file
View File

@@ -0,0 +1,103 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.web.config;
import java.util.Iterator;
import org.alfresco.config.ConfigElement;
import org.alfresco.config.ConfigException;
import org.alfresco.config.xml.elementreader.ConfigElementReader;
import org.dom4j.Element;
/**
* Custom element reader to parse config for the sidebar
*
* @author gavinc
*/
public class SidebarElementReader implements ConfigElementReader
{
public static final String ELEMENT_SIDEBAR = "sidebar";
public static final String ELEMENT_PLUGINS = "plugins";
public static final String ELEMENT_PLUGIN = "plugin";
public static final String ELEMENT_DEFAULT_PLUGIN = "default-plugin";
public static final String ATTR_ID = "id";
public static final String ATTR_LABEL = "label";
public static final String ATTR_LABEL_ID = "label-id";
public static final String ATTR_DESCRIPTION = "description";
public static final String ATTR_DESCRIPTION_ID = "description-id";
public static final String ATTR_PAGE = "page";
public static final String ATTR_ICON = "icon";
public static final String ATTR_ACTIONS_CONFIG_ID = "actions-config-id";
/**
* @see org.alfresco.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element)
*/
@SuppressWarnings("unchecked")
public ConfigElement parse(Element element)
{
SidebarConfigElement configElement = null;
if (element != null)
{
String elementName = element.getName();
if (elementName.equals(ELEMENT_SIDEBAR) == false)
{
throw new ConfigException("SidebarElementReader can only parse " +
ELEMENT_SIDEBAR + "elements, the element passed was '" +
elementName + "'");
}
configElement = new SidebarConfigElement();
// go through the plugins that make up the sidebar
Element pluginsElem = element.element(ELEMENT_PLUGINS);
if (pluginsElem != null)
{
Iterator<Element> plugins = pluginsElem.elementIterator(ELEMENT_PLUGIN);
while (plugins.hasNext())
{
Element plugin = plugins.next();
String id = plugin.attributeValue(ATTR_ID);
String page = plugin.attributeValue(ATTR_PAGE);
String label = plugin.attributeValue(ATTR_LABEL);
String labelId = plugin.attributeValue(ATTR_LABEL_ID);
String description = plugin.attributeValue(ATTR_DESCRIPTION);
String descriptionId = plugin.attributeValue(ATTR_DESCRIPTION_ID);
String actionsConfigId = plugin.attributeValue(ATTR_ACTIONS_CONFIG_ID);
String icon = plugin.attributeValue(ATTR_ICON);
SidebarConfigElement.SidebarPluginConfig cfg =
new SidebarConfigElement.SidebarPluginConfig(id, page,
label, labelId, description, descriptionId,
actionsConfigId, icon);
configElement.addPlugin(cfg);
}
}
// see if a default plugin is specified
Element defaultPlugin = element.element(ELEMENT_DEFAULT_PLUGIN);
if (defaultPlugin != null)
{
configElement.setDefaultPlugin(defaultPlugin.getTextTrim());
}
}
return configElement;
}
}