| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * 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.apache.cocoon.portal.layout.renderer.aspect.impl; |
| |
| import java.util.Collections; |
| import java.util.Iterator; |
| import java.util.Map; |
| import java.util.List; |
| import java.util.ArrayList; |
| |
| import org.apache.avalon.framework.parameters.ParameterException; |
| import org.apache.avalon.framework.parameters.Parameters; |
| import org.apache.cocoon.portal.PortalService; |
| import org.apache.cocoon.portal.aspect.impl.DefaultAspectDescription; |
| import org.apache.cocoon.portal.event.impl.ChangeAspectDataEvent; |
| import org.apache.cocoon.portal.layout.CompositeLayout; |
| import org.apache.cocoon.portal.layout.Item; |
| import org.apache.cocoon.portal.layout.Layout; |
| import org.apache.cocoon.portal.layout.NamedItem; |
| import org.apache.cocoon.portal.layout.renderer.aspect.RendererAspectContext; |
| import org.apache.cocoon.xml.AttributesImpl; |
| import org.apache.cocoon.xml.XMLUtils; |
| import org.xml.sax.ContentHandler; |
| import org.xml.sax.SAXException; |
| |
| /** |
| * <h2>Example XML:</h2> |
| * <pre> |
| * <composite> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." selected="true"> |
| * <!-- output from processing layout --> |
| * </named-item> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." parameter="link-event"/> |
| * </composite> |
| * </pre> |
| * |
| * <h2>Example XML with sub-navigation (child-tag-name enabled):</h2> |
| * <pre> |
| * <composite> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." selected="true"> |
| * <!-- output from processing layout --> |
| * </named-item> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." parameter="link-event"> |
| * <<i>child-tag-name</i>> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." parameter="link-event"/> |
| * </<i>child-tag-name</i>> |
| * </named-item> |
| * </composite> |
| * </pre> |
| * |
| * <h2>Example XML with sub-navigation (show-all-nav without child-tag-name enabled):</h2> |
| * <pre> |
| * <composite> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." selected="true"> |
| * <!-- output from processing layout --> |
| * </named-item> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." parameter="link-event"> |
| * <named-item name="..." parameter="link-event"/> |
| * <named-item name="..." parameter="link-event"/> |
| * </named-item> |
| * </composite> |
| * </pre> |
| |
| * |
| * * |
| * <h2>Applicable to:</h2> |
| * <ul> |
| * <li>{@link org.apache.cocoon.portal.layout.CompositeLayout}</li> |
| * </ul> |
| * |
| * <h2>Parameters</h2> |
| * <table><tbody> |
| * <tr><th>store</th><td></td><td>req</td><td>String</td><td><code>null</code></td></tr> |
| * <tr><th>aspect-name</th><td>Aspect holding the current tab state.</td><td>req</td><td>String</td><td><code>"tab"</code></td></tr> |
| * <tr><th>tag-name</th><td>Name of the tag enclosing the following output.</td> |
| * <td></td><td>String</td><td><code>"composite"</code></td></tr> |
| * <tr><th>root-tag</th><td>Should a tag enclosing the following output be generated?</td> |
| * <td></td><td>boolean</td><td><code>true</code></td></tr> |
| * <tr><th>child-tag-name</th><td>The name of the tag to enclose named items (i.e. the subnavigation) |
| * of non-selected (default) items. Setting this parameter will enable show-all-nav.</td> |
| * <td></td><td>String</td><td><code>""</code></td></tr> |
| * <tr><th>show-all-nav</th><td>Setting this value to true will output the enclosed named-items</td> |
| * <td></td><td>boolean</td><td><code>false</code></td></tr> |
| * <tr><th>include-selected</th><td>Setting this value to true will output the enclosed named-items of the selected tab too.</td> |
| * <td></td><td>boolean</td><td><code>false</code></td></tr> |
| * </tbody></table> |
| * |
| * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a> |
| * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a> |
| * |
| * @version CVS $Id$ |
| */ |
| public class TabContentAspect |
| extends CompositeContentAspect { |
| |
| /** |
| * Chains that include this aspect must always render |
| * @return true |
| */ |
| public boolean isRequired() { |
| return true; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.apache.cocoon.portal.layout.renderer.RendererAspect#toSAX(org.apache.cocoon.portal.layout.renderer.RendererAspectContext, org.apache.cocoon.portal.layout.Layout, org.apache.cocoon.portal.PortalService, org.xml.sax.ContentHandler) |
| */ |
| public void toSAX(RendererAspectContext context, |
| Layout layout, |
| PortalService service, |
| ContentHandler handler) |
| throws SAXException { |
| if (layout instanceof CompositeLayout) { |
| TabPreparedConfiguration config = (TabPreparedConfiguration)context.getAspectConfiguration(); |
| |
| if ( config.rootTag ) { |
| XMLUtils.startElement(handler, config.tagName); |
| } |
| |
| AttributesImpl attributes = new AttributesImpl(); |
| CompositeLayout tabLayout = (CompositeLayout) layout; |
| |
| // selected tab |
| Integer data = (Integer) layout.getAspectData(config.aspectName); |
| int selected = data.intValue(); |
| |
| // loop over all tabs |
| for (int j = 0; j < tabLayout.getSize(); j++) { |
| Item tab = tabLayout.getItem(j); |
| ChangeAspectDataEvent event = null; |
| |
| // open named-item tag |
| attributes.clear(); |
| if ( tab instanceof NamedItem ) { |
| attributes.addCDATAAttribute("name", String.valueOf(((NamedItem)tab).getName())); |
| } |
| if (j == selected) { |
| attributes.addCDATAAttribute("selected", "true"); |
| } |
| event = new ChangeAspectDataEvent(tabLayout, config.aspectName, new Integer(j)); |
| attributes.addCDATAAttribute("parameter", service.getComponentManager().getLinkService().getLinkURI(event)); |
| |
| // add parameters |
| final Iterator iter = tab.getParameters().entrySet().iterator(); |
| while ( iter.hasNext() ) { |
| final Map.Entry entry = (Map.Entry) iter.next(); |
| attributes.addCDATAAttribute((String)entry.getKey(), (String)entry.getValue()); |
| } |
| |
| XMLUtils.startElement(handler, "named-item", attributes); |
| if (j == selected) { |
| this.processLayout(tab.getLayout(), service, handler); |
| if (config.includeSelected) { |
| List events = new ArrayList(); |
| events.add(event); |
| this.processNav(context, tab.getLayout(), service, handler, events); |
| } |
| } else if (config.showAllNav) { |
| List events = new ArrayList(); |
| events.add(event); |
| this.processNav(context, tab.getLayout(), service, handler, events); |
| } |
| |
| // close named-item tag |
| XMLUtils.endElement(handler, "named-item"); |
| } |
| |
| if ( config.rootTag ) { |
| XMLUtils.endElement(handler, config.tagName); |
| } |
| } else { |
| throw new SAXException("Wrong layout type, TabLayout expected: " + layout.getClass().getName()); |
| } |
| } |
| |
| /** |
| * Return the aspects required for this renderer |
| * @return An iterator for the aspect descriptions or null. |
| */ |
| public Iterator getAspectDescriptions(Object configuration) { |
| TabPreparedConfiguration pc = (TabPreparedConfiguration)configuration; |
| |
| DefaultAspectDescription desc = new DefaultAspectDescription(); |
| desc.setName(pc.aspectName); |
| desc.setClassName("java.lang.Integer"); |
| desc.setPersistence(pc.store); |
| desc.setAutoCreate(true); |
| |
| return Collections.singletonList(desc).iterator(); |
| } |
| |
| /* |
| * Generate the sub navigation for non-selected tabs |
| * @param context |
| * @param layout |
| * @param service |
| * @param handler |
| * @throws SAXException |
| */ |
| private void processNav(RendererAspectContext context, |
| Layout layout, |
| PortalService service, |
| ContentHandler handler, |
| List parentEvents) |
| throws SAXException { |
| if (layout instanceof CompositeLayout) { |
| CompositeLayout tabLayout = (CompositeLayout)layout; |
| |
| if (tabLayout.getSize() == 0) { |
| return; |
| } |
| TabPreparedConfiguration config = |
| (TabPreparedConfiguration) context.getAspectConfiguration(); |
| AttributesImpl attributes = new AttributesImpl(); |
| boolean subNav = false; |
| |
| // loop over all tabs |
| for (int j = 0; j < tabLayout.getSize(); j++) { |
| Item tab = tabLayout.getItem(j); |
| |
| // open named-item tag |
| attributes.clear(); |
| if (tab instanceof NamedItem) { |
| if (!subNav && !config.childTagName.equals("")) { |
| XMLUtils.startElement(handler, config.childTagName); |
| subNav = true; |
| } |
| attributes.addCDATAAttribute("name", |
| String.valueOf(((NamedItem) tab).getName())); |
| ChangeAspectDataEvent event = new ChangeAspectDataEvent(tabLayout, |
| config.aspectName, new Integer(j)); |
| List events = new ArrayList(parentEvents); |
| events.add(event); |
| |
| attributes.addCDATAAttribute("parameter", |
| service.getComponentManager().getLinkService().getLinkURI(events)); |
| |
| // add parameters |
| final Iterator iter = tab.getParameters().entrySet().iterator(); |
| while (iter.hasNext()) { |
| final Map.Entry entry = (Map.Entry) iter.next(); |
| attributes.addCDATAAttribute((String) entry.getKey(), |
| (String) entry.getValue()); |
| } |
| |
| XMLUtils.startElement(handler, "named-item", attributes); |
| |
| this.processNav(context, tab.getLayout(), service, handler, events); |
| |
| // close named-item tag |
| XMLUtils.endElement(handler, "named-item"); |
| } |
| |
| |
| } |
| // close sub-nav tag |
| if (subNav) { |
| XMLUtils.endElement(handler, config.childTagName); |
| } |
| } |
| } |
| |
| protected class TabPreparedConfiguration extends PreparedConfiguration { |
| public String aspectName; |
| public String store; |
| public boolean showAllNav = false; |
| public boolean includeSelected = false; |
| public String childTagName; |
| |
| public void takeValues(TabPreparedConfiguration from) { |
| super.takeValues(from); |
| this.aspectName = from.aspectName; |
| this.store = from.store; |
| this.showAllNav = from.showAllNav; |
| this.includeSelected = from.includeSelected; |
| this.childTagName = from.childTagName; |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.apache.cocoon.portal.layout.renderer.aspect.RendererAspect#prepareConfiguration(org.apache.avalon.framework.parameters.Parameters) |
| */ |
| public Object prepareConfiguration(Parameters configuration) |
| throws ParameterException { |
| TabPreparedConfiguration pc = new TabPreparedConfiguration(); |
| pc.takeValues((PreparedConfiguration)super.prepareConfiguration(configuration)); |
| pc.aspectName = configuration.getParameter("aspect-name", "tab"); |
| pc.store = configuration.getParameter("store"); |
| pc.childTagName = configuration.getParameter("child-tag-name", ""); |
| if (!pc.childTagName.equals("")) { |
| pc.showAllNav = true; |
| } else { |
| pc.showAllNav = configuration.getParameterAsBoolean("show-all-nav", false); |
| } |
| pc.includeSelected = configuration.getParameterAsBoolean("include-selected", false); |
| return pc; |
| } |
| |
| } |
