jakarta.faces.view.facelets.ConverterHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
The newest version!
/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * Licensed 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 jakarta.faces.view.facelets;

import jakarta.faces.view.ValueHolderAttachedObjectHandler;

/**
 * 
 * Handles setting a {@link jakarta.faces.convert.Converter} instance on a {@link jakarta.faces.component.ValueHolder}
 * parent. Will wire all attributes set to the Converter instance created/fetched. Uses the "binding"
 * attribute for grabbing instances to apply attributes to.
 * 
 *
 * 
 * Will only set/create Converter if the passed UIComponent's parent is
 * null, signifying that it wasn't restored from an existing tree.
 * 
 *
 */
public class ConverterHandler extends FaceletsAttachedObjectHandler implements ValueHolderAttachedObjectHandler {

    private String converterId;
    private TagHandlerDelegate helper;

    /**
     * Creates a new ConverterHandler using the given config.
     *
     * @param config converter config where the converter Id is taken from.
     */
    public ConverterHandler(ConverterConfig config) {
        super(config);
        converterId = config.getConverterId();
    }

    @Override
    protected TagHandlerDelegate getTagHandlerDelegate() {
        if (helper == null) {
            helper = delegateFactory.createConverterHandlerDelegate(this);
        }

        return helper;
    }

    /**
     * Returns the converter Id.
     *
     * 
     * The converter Id is taken from the attribute "converterId"
     *
     * @param ctx facelet context used to resolve the converter Id from an attribute.
     * @return the converter Id.
     */
    public String getConverterId(FaceletContext ctx) {
        if (converterId == null) {
            TagAttribute idAttr = getAttribute("converterId");
            if (idAttr == null) {
                return null;
            }

            return idAttr.getValue(ctx);
        }

        return converterId;
    }

}