com.tcdng.unify.web.ui.widget.control.Link Maven / Gradle / Ivy

/*
 * Copyright 2018-2023 The Code Department.
 * 
 * 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 com.tcdng.unify.web.ui.widget.control;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.annotation.Component;
import com.tcdng.unify.core.annotation.UplAttribute;
import com.tcdng.unify.core.annotation.UplAttributes;
import com.tcdng.unify.core.format.Formatter;
import com.tcdng.unify.core.util.DataUtils;
import com.tcdng.unify.core.util.StringUtils;
import com.tcdng.unify.web.ui.widget.AbstractTargetControl;

/**
 * A link control.
 * 
 * @author The Code Department
 * @since 1.0
 */
@Component("ui-link")
@UplAttributes({ @UplAttribute(name = "preferredCaption", type = String.class),
        @UplAttribute(name = "preferredCaptionBinding", type = String.class),
        @UplAttribute(name = "formatter", type = Formatter.class) })
public class Link extends AbstractTargetControl {

    @Override
    public boolean isLayoutCaption() {
        return false;
    }

    public String getPreferredCaption() throws UnifyException {
        String preferredCaptionBinding = getUplAttribute(String.class, "preferredCaptionBinding");
        if (preferredCaptionBinding != null) {
            return DataUtils.convert(String.class, getValue(preferredCaptionBinding), getFormatter());
        }

        return getUplAttribute(String.class, "preferredCaption");
    }

    public boolean isUsePreferredCaption() throws UnifyException {
        return StringUtils.isNotBlank(getUplAttribute(String.class, "preferredCaption"))
                || StringUtils.isNotBlank(getUplAttribute(String.class, "preferredCaptionBinding"));
    }

    @SuppressWarnings("unchecked")
    public Formatter