com.sun.webui.jsf.renderkit.html.TabRenderer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* TabRenderer.java
*/
package com.sun.webui.jsf.renderkit.html;
import com.sun.faces.annotation.Renderer;
import java.io.IOException;
import java.util.List;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.component.UIComponent;
import com.sun.webui.jsf.util.LogUtil;
import com.sun.webui.jsf.component.Tab;
import com.sun.webui.jsf.component.TabSet;
import com.sun.webui.theme.Theme;
import com.sun.webui.jsf.theme.ThemeStyles;
import com.sun.webui.jsf.util.ThemeUtilities;
import com.sun.webui.jsf.util.ConversionUtilities;
/**
* Renders a Tab component.
*
* A Tab is a Hyperlink that, when clicked, also udpates the
* lastSelectedChild value of any parent Tab instance as well as the selected
* value of the enclosing TabSet component.
*
* @author Sean Comerford
*/
@Renderer(@Renderer.Renders(componentFamily = "com.sun.webui.jsf.Tab"))
public class TabRenderer extends HyperlinkRenderer {
/** Default constructor */
public TabRenderer() {
super();
}
/**
* This method is always called by the base class (HyperlinkRenderer)
* renderEnd method. TabRenderer should NOT render any Tab children as the
* enclosing TabSet component will do so (if necessary).
*
* @param context The current FacesContext
* @param component The current component
*/
@Override
protected void renderChildren(FacesContext context, UIComponent component)
throws IOException {
// do nothing
}
/**
* Render the start of an anchor (hyperlink) tag.
* @param context FacesContext for the current request
* @param component UIComponent to be rendered
* @param writer ResponseWriter to which the element
* start should be rendered
* @exception IOException if an input/output error occurs
*/
@Override
protected void renderStart(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
super.renderStart(context, component, writer);
// ensure that this tab's parent is either a Tab or TabSet
UIComponent parent = component.getParent();
if (!(parent instanceof Tab || parent instanceof TabSet)) {
if (LogUtil.infoEnabled()) {
LogUtil.info(TabRenderer.class, "WEBUI0006",
new String[]{component.getId()});
}
}
}
@Override
protected void finishRenderAttributes(FacesContext context, UIComponent component,
ResponseWriter writer) throws IOException {
Tab tab = (Tab) component;
// Set up local variables we will need
int tabIndex = tab.getTabIndex();
if (tabIndex >= 0) {
writer.writeAttribute("tabIndex", Integer.toString(tabIndex), null);
}
super.finishRenderAttributes(context, component, writer);
}
/**
* This function returns the style classes necessary to display the
* {@link Hyperlink} component as it's state indicates
* @return the style classes needed to display the current state of
* the component
*/
@Override
protected String getStyles(FacesContext context, UIComponent component) {
Tab link = (Tab) component;
StringBuffer sb = new StringBuffer(200);
Theme theme = ThemeUtilities.getTheme(context);
if (link.isDisabled()) {
sb.append(" "); //NOI18N
sb.append(theme.getStyleClass(ThemeStyles.LINK_DISABLED));
}
Object value = link.getText();
if (value != null) {
String text = ConversionUtilities.convertValueToString(link, value);
if (text.length() <= 6) {
sb.append(" "); // NOI18N
sb.append(theme.getStyleClass(ThemeStyles.TAB_PADDING));
}
}
return (sb.length() > 0) ? sb.toString() : null;
}
@Override
public void decode(FacesContext context, UIComponent component) {
super.decode(context, component);
String paramId = super.getSubmittedParameterId(context, component);
String submittedValue =
(String) context.getExternalContext().getRequestParameterMap().get(paramId);
if (submittedValue != null) {
// If this is the tab that submitted the page (i.e. the tab that the user
// clicked on to submit the page), update the submitted value of the
// ancestor tabSet. Note that even though this tab was clicked, if this
// tab has children, the selected tab will be one of its descendants.
// Also refresh the selectedChildId property of all parent tabs of the
// selected tab.
Tab selectedTab = (Tab) component;
while (selectedTab.getTabChildCount() > 0) {
String previousSelectedTabId = selectedTab.getSelectedChildId();
List childrenTabs = selectedTab.getTabChildren();
selectedTab = childrenTabs.get(0);
for (Tab childTab : childrenTabs) {
if (childTab.getId() != null && childTab.getId().equals(previousSelectedTabId)) {
selectedTab = childTab;
}
}
}
TabSet tabSet = Tab.getTabSet(selectedTab);
tabSet.setSubmittedValue(selectedTab.getId());
}
}
}