com.tcdng.unify.web.ui.response.HintUserResponse 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.response;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.annotation.Component;
import com.tcdng.unify.web.annotation.ResultMapping;
import com.tcdng.unify.web.ui.AbstractJsonPageControllerResponse;
import com.tcdng.unify.web.ui.widget.Page;
import com.tcdng.unify.web.ui.widget.ResponseWriter;
import com.tcdng.unify.web.ui.widget.data.Hint;
import com.tcdng.unify.web.ui.widget.data.Hints;

/**
 * Used for generating a hint user response. This response is implicitly added
 * to every result, so there's no need to explicitly add when defining an action
 * result with {@link ResultMapping}.
 * 
 * @author The Code Department
 * @since 1.0
 */
@Component("hintuserresponse")
public class HintUserResponse extends AbstractJsonPageControllerResponse {

    public HintUserResponse() {
        super("hintUserHdl", false);
    }

    @Override
    protected void doGenerate(ResponseWriter writer, Page page) throws UnifyException {
        logDebug("Preparing hint user response: path ID = [{0}]", page.getPathId());
        Hints hints = getRequestContextUtil().getUserHints();
        if (hints != null && hints.isPresent()) {
            writer.write(",\"hintUserHtml\":");
            StringBuilder hsb = new StringBuilder();
            hsb.append("");
            for (Hint hint : hints.getHints()) {
                hsb.append("");
                hsb.append(hint.getMessage());
                hsb.append("");
            }
            hsb.append("");
            writer.writeJsonQuote(hsb.toString());
        }
    }
}