de.bund.bva.isyfact.common.web.jsf.renderer.NoLabelHtmlRadioRenderer Maven / Gradle / Ivy
Show all versions of isy-web Show documentation
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
* The Federal Office of Administration (Bundesverwaltungsamt, BVA)
* 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 de.bund.bva.isyfact.common.web.jsf.renderer;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UINamingContainer;
import javax.faces.component.UISelectOne;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.convert.Converter;
import javax.faces.model.SelectItem;
import org.apache.myfaces.component.UserRoleUtils;
import org.apache.myfaces.custom.radio.HtmlRadio;
import org.apache.myfaces.renderkit.html.ext.HtmlRadioRenderer;
import org.apache.myfaces.shared_tomahawk.renderkit.ClientBehaviorEvents;
import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HTML;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.util.JavascriptUtils;
/**
* Erweitert den Standard-Radio Renderer von Tomahawk, damit kein Label gerendert wird. Dies übernimmt die
* Composite Component.
*
* Durchgeführte Änderungen:
*
* Methode {@link #renderLabel(ResponseWriter, UIComponent, UIComponent, String, SelectItem, boolean)} rendert
* kein Label mehr.
*
* Methode {@link #renderRadio(FacesContext, HtmlRadio)} und {@link #decode(FacesContext, UIComponent)} kann
* jetzt das Input Element auch relativ suchen.
*
* @author Capgemini
* @version $Id: NoLabelHtmlRadioRenderer.java 123758 2014-10-10 10:01:14Z sdm_ahoerning $
* @deprecated This module is deprecated and will be removed in a future release.
* It is recommended to use isy-angular-widgets instead.
*/
@Deprecated
public class NoLabelHtmlRadioRenderer extends HtmlRadioRenderer {
private static final String LAYOUT_SPREAD = "spread";
// private static final String[] LABEL_STYLES = { "labelStyle", "labelStyleClass" };
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
if (context == null) {
throw new NullPointerException("context");
}
if (component == null) {
throw new NullPointerException("component");
}
if (component instanceof HtmlRadio) {
renderRadio(context, (HtmlRadio) component);
} else if (HtmlRendererUtils.isDisplayValueOnly(component)) {
HtmlRendererUtils.renderDisplayValueOnlyForSelects(context, component);
} else if (component instanceof UISelectOne) {
String layout = getLayout(component);
if (layout != null && layout.equals(LAYOUT_SPREAD)) {
return; // radio inputs are rendered by spread radio components
} else {
super.encodeEnd(context, component);
}
} else {
throw new IllegalArgumentException("Unsupported component class "
+ component.getClass().getName());
}
}
@Override
protected void renderRadio(FacesContext facesContext, HtmlRadio radio) throws IOException {
String forAttr = radio.getFor();
if (forAttr == null) {
throw new IllegalStateException("mandatory attribute 'for'");
}
int index = radio.getIndex();
if (index < 0) {
throw new IllegalStateException("positive index must be given");
}
UIComponent uiComponent = search(forAttr, radio);
if (uiComponent == null) {
throw new IllegalStateException("Could not find component '" + forAttr
+ "' (calling findComponent on component '" + radio.getClientId(facesContext) + "')");
}
if (!(uiComponent instanceof UISelectOne)) {
throw new IllegalStateException("UISelectOne expected");
}
UISelectOne uiSelectOne = (UISelectOne) uiComponent;
Converter converter;
List selectItemList = RendererUtils.getSelectItemList(uiSelectOne);
if (index >= selectItemList.size()) {
throw new IndexOutOfBoundsException("index " + index + " >= " + selectItemList.size());
}
try {
converter = RendererUtils.findUIOutputConverter(facesContext, uiSelectOne);
} catch (FacesException e) {
converter = null;
}
Object currentValue = RendererUtils.getObjectValue(uiSelectOne);
currentValue =
RendererUtils.getConvertedStringValue(facesContext, uiSelectOne, converter, currentValue);
SelectItem selectItem = (SelectItem) selectItemList.get(index);
String itemStrValue =
RendererUtils
.getConvertedStringValue(facesContext, uiSelectOne, converter, selectItem.getValue());
ResponseWriter writer = facesContext.getResponseWriter();
// writer.startElement(HTML.LABEL_ELEM, uiSelectOne);
// renderRadio(facesContext,
// uiSelectOne,
// itemStrValue,
// selectItem.getLabel(),
// selectItem.isDisabled(),
// itemStrValue.equals(currentValue), false);
// writer.endElement(HTML.LABEL_ELEM);
// Render the radio component
String itemId =
renderRadio(facesContext, uiSelectOne, radio, itemStrValue, selectItem.isDisabled(),
itemStrValue.equals(currentValue), false, index);
// Render the
// label element after the input
boolean componentDisabled = isDisabled(facesContext, uiSelectOne);
boolean itemDisabled = selectItem.isDisabled();
boolean disabled = (componentDisabled || itemDisabled);
renderLabel(writer, radio, uiSelectOne, itemId, selectItem, disabled);
}
@Override
protected String renderRadio(FacesContext facesContext, UISelectOne uiComponent, HtmlRadio radio,
String value, boolean disabled, boolean checked, boolean renderId, Integer itemNum)
throws IOException {
String clientId = uiComponent.getClientId(facesContext);
String itemId =
radio.isRenderLogicalId() ? clientId + UINamingContainer.getSeparatorChar(facesContext) + itemNum
: radio.getClientId(facesContext);
ResponseWriter writer = facesContext.getResponseWriter();
writer.startElement(HTML.INPUT_ELEM, uiComponent);
// Force id rendering because it is necessary for the label
// and for @this work correctly
writer.writeAttribute(HTML.ID_ATTR, itemId, null);
writer.writeAttribute(HTML.TYPE_ATTR, HTML.INPUT_TYPE_RADIO, null);
writer.writeAttribute(HTML.NAME_ATTR, clientId, null);
if (disabled) {
writer.writeAttribute(HTML.DISABLED_ATTR, HTML.DISABLED_ATTR, null);
}
if (checked) {
writer.writeAttribute(HTML.CHECKED_ATTR, HTML.CHECKED_ATTR, null);
}
if (value != null) {
writer.writeAttribute(HTML.VALUE_ATTR, value, null);
}
Map> behaviors = null;
if (uiComponent instanceof ClientBehaviorHolder
&& JavascriptUtils.isJavascriptAllowed(facesContext.getExternalContext())) {
behaviors = ((ClientBehaviorHolder) uiComponent).getClientBehaviors();
renderBehaviorizedOnchangeEventHandler(facesContext, writer, radio, uiComponent, itemId,
behaviors);
renderBehaviorizedEventHandlers(facesContext, writer, radio, uiComponent, itemId, behaviors);
renderBehaviorizedFieldEventHandlersWithoutOnchange(facesContext, writer, radio, uiComponent,
itemId, behaviors);
renderHTMLAttributes(writer, radio, uiComponent,
HTML.INPUT_PASSTHROUGH_ATTRIBUTES_WITHOUT_DISABLED_AND_EVENTS);
} else {
renderHTMLAttributes(writer, radio, uiComponent,
HTML.INPUT_PASSTHROUGH_ATTRIBUTES_WITHOUT_DISABLED);
}
if (isDisabled(facesContext, uiComponent)) {
writer.writeAttribute(org.apache.myfaces.shared_tomahawk.renderkit.html.HTML.DISABLED_ATTR,
Boolean.TRUE, null);
}
writer.endElement(HTML.INPUT_ELEM);
return itemId;
}
public static void renderLabel(ResponseWriter writer, UIComponent radio, UIComponent component,
String forClientId, SelectItem item, boolean disabled) throws IOException {
// Es wird kein Label gerendert
}
private static boolean renderHTMLAttributes(ResponseWriter writer, UIComponent radio,
UIComponent selectOne, String[] attributes) throws IOException {
boolean somethingDone = false;
for (int i = 0, len = attributes.length; i < len; i++) {
String attrName = attributes[i];
Object value = radio.getAttributes().get(attrName);
if (value == null) {
value = selectOne.getAttributes().get(attrName);
}
if (HtmlRendererUtils.renderHTMLAttribute(writer, attrName, attrName, value)) {
somethingDone = true;
}
}
return somethingDone;
}
private static boolean renderBehaviorizedOnchangeEventHandler(FacesContext facesContext,
ResponseWriter writer, UIComponent radio, UIComponent uiComponent, String targetClientId,
Map> clientBehaviors) throws IOException {
boolean hasChange =
HtmlRendererUtils.hasClientBehavior(ClientBehaviorEvents.CHANGE, clientBehaviors, facesContext);
boolean hasValueChange =
HtmlRendererUtils.hasClientBehavior(ClientBehaviorEvents.VALUECHANGE, clientBehaviors,
facesContext);
String value = (String) radio.getAttributes().get(HTML.ONCHANGE_ATTR);
if (value == null) {
value = (String) uiComponent.getAttributes().get(HTML.ONCHANGE_ATTR);
}
if (hasChange && hasValueChange) {
String chain =
HtmlRendererUtils.buildBehaviorChain(facesContext, uiComponent, targetClientId,
ClientBehaviorEvents.CHANGE, null, ClientBehaviorEvents.VALUECHANGE, null,
clientBehaviors, value, null);
return HtmlRendererUtils.renderHTMLAttribute(writer, HTML.ONCHANGE_ATTR, HTML.ONCHANGE_ATTR,
chain);
} else if (hasChange) {
return HtmlRendererUtils.renderBehaviorizedAttribute(facesContext, writer, HTML.ONCHANGE_ATTR,
uiComponent, targetClientId, ClientBehaviorEvents.CHANGE, null, clientBehaviors,
HTML.ONCHANGE_ATTR, value);
} else if (hasValueChange) {
return HtmlRendererUtils.renderBehaviorizedAttribute(facesContext, writer, HTML.ONCHANGE_ATTR,
uiComponent, targetClientId, ClientBehaviorEvents.VALUECHANGE, null, clientBehaviors,
HTML.ONCHANGE_ATTR, value);
} else {
return HtmlRendererUtils.renderHTMLAttribute(writer, HTML.ONCHANGE_ATTR, HTML.ONCHANGE_ATTR,
value);
}
}
private static void renderBehaviorizedEventHandlers(FacesContext facesContext, ResponseWriter writer,
UIComponent radio, UIComponent uiComponent, String targetClientId,
Map> clientBehaviors) throws IOException {
renderBehaviorizedAttribute(facesContext, writer, HTML.ONCLICK_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.CLICK, clientBehaviors, HTML.ONCLICK_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONDBLCLICK_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.DBLCLICK, clientBehaviors, HTML.ONDBLCLICK_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONMOUSEDOWN_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.MOUSEDOWN, clientBehaviors, HTML.ONMOUSEDOWN_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONMOUSEUP_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.MOUSEUP, clientBehaviors, HTML.ONMOUSEUP_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONMOUSEOVER_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.MOUSEOVER, clientBehaviors, HTML.ONMOUSEOVER_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONMOUSEMOVE_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.MOUSEMOVE, clientBehaviors, HTML.ONMOUSEMOVE_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONMOUSEOUT_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.MOUSEOUT, clientBehaviors, HTML.ONMOUSEOUT_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONKEYPRESS_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.KEYPRESS, clientBehaviors, HTML.ONKEYPRESS_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONKEYDOWN_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.KEYDOWN, clientBehaviors, HTML.ONKEYDOWN_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONKEYUP_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.KEYUP, clientBehaviors, HTML.ONKEYUP_ATTR);
}
private static void renderBehaviorizedFieldEventHandlersWithoutOnchange(FacesContext facesContext,
ResponseWriter writer, UIComponent radio, UIComponent uiComponent, String targetClientId,
Map> clientBehaviors) throws IOException {
renderBehaviorizedAttribute(facesContext, writer, HTML.ONFOCUS_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.FOCUS, clientBehaviors, HTML.ONFOCUS_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONBLUR_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.BLUR, clientBehaviors, HTML.ONBLUR_ATTR);
renderBehaviorizedAttribute(facesContext, writer, HTML.ONSELECT_ATTR, radio, uiComponent,
targetClientId, ClientBehaviorEvents.SELECT, clientBehaviors, HTML.ONSELECT_ATTR);
}
private static boolean renderBehaviorizedAttribute(FacesContext facesContext, ResponseWriter writer,
String componentProperty, UIComponent radio, UIComponent component, String targetClientId,
String eventName, Map> clientBehaviors, String htmlAttrName)
throws IOException {
String attributeValue = (String) radio.getAttributes().get(componentProperty);
if (attributeValue == null) {
attributeValue = (String) component.getAttributes().get(componentProperty);
}
return HtmlRendererUtils.renderBehaviorizedAttribute(facesContext, writer, componentProperty,
component, targetClientId, eventName, null, clientBehaviors, htmlAttrName, attributeValue);
}
@Override
protected boolean isDisabled(FacesContext facesContext, UIComponent uiComponent) {
if (!UserRoleUtils.isEnabledOnUserRole(uiComponent)) {
return true;
} else {
return super.isDisabled(facesContext, uiComponent);
}
}
@Override
public void decode(FacesContext facesContext, UIComponent uiComponent) {
if (uiComponent instanceof HtmlRadio) {
HtmlRadio radio = (HtmlRadio) uiComponent;
String forAttr = radio.getFor();
if (forAttr == null) {
throw new IllegalStateException("mandatory attribute 'for'");
}
int index = radio.getIndex();
if (index < 0) {
throw new IllegalStateException("positive index must be given");
}
UIComponent uiSelectOne = search(forAttr, radio);
if (uiSelectOne == null) {
throw new IllegalStateException("Could not find component '" + forAttr
+ "' (calling findComponent on component '" + radio.getClientId(facesContext) + "')");
}
if (!(uiSelectOne instanceof UISelectOne)) {
throw new IllegalStateException("UISelectOne expected");
}
if (uiSelectOne instanceof ClientBehaviorHolder) {
ClientBehaviorHolder clientBehaviorHolder = (ClientBehaviorHolder) uiSelectOne;
Map> clientBehaviors = clientBehaviorHolder.getClientBehaviors();
if (clientBehaviors != null && !clientBehaviors.isEmpty()) {
Map paramMap = facesContext.getExternalContext().getRequestParameterMap();
String behaviorEventName = paramMap.get("javax.faces.behavior.event");
if (behaviorEventName != null) {
List clientBehaviorList = clientBehaviors.get(behaviorEventName);
if (clientBehaviorList != null && !clientBehaviorList.isEmpty()) {
String clientId = paramMap.get("javax.faces.source");
if (radio.getClientId().equals(clientId)) {
for (ClientBehavior clientBehavior : clientBehaviorList) {
clientBehavior.decode(facesContext, radio);
}
}
}
}
}
}
} else {
super.decode(facesContext, uiComponent);
}
}
/**
* Sucht eine UIComponent über die integrierte JSF-Suche oder relativ.
*
* @param searchExpression Die Suchanfrage.
* @param base Von welchem Element aus gesucht wird.
* @return Die UI-Component.
*/
private UIComponent search(String searchExpression, UIComponent base) {
UIComponent uiComponent = null;
if (searchExpression.startsWith("relative:")) {
// Relative Suche
String search = searchExpression.substring("relative:".length());
String[] searchParts = search.split(":");
uiComponent = base;
for (String searchPart : searchParts) {
if (searchPart.equals("super")) {
uiComponent = uiComponent.getParent();
} else {
for (UIComponent uiComponentChild : uiComponent.getChildren()) {
if (searchPart.equals(uiComponentChild.getId())) {
uiComponent = uiComponentChild;
break;
}
}
}
}
} else {
uiComponent = base.findComponent(searchExpression);
}
return uiComponent;
}
}