com.tcdng.unify.web.ui.response.RefreshSectionResponse 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.constant.UnifyWebRequestAttributeConstants;
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.Widget;
import com.tcdng.unify.web.ui.widget.data.RefreshSection;
/**
* Used for generating a refresh section response. A section is a division
* rendered with a div tag. Refresh section data is gotten from request context.
*
* @author The Code Department
* @since 1.0
*/
@Component("refreshsectionresponse")
public class RefreshSectionResponse extends AbstractJsonPageControllerResponse {
public RefreshSectionResponse() {
super("refreshSectionHdl", false);
}
@Override
protected void doGenerate(ResponseWriter writer, Page page) throws UnifyException {
RefreshSection refreshSection =
(RefreshSection) getRequestAttribute(UnifyWebRequestAttributeConstants.REFRESH_SECTION);
if (refreshSection != null) {
Widget widget = refreshSection.getWidget();
String sectionPageName = refreshSection.getSectionPageName();
logDebug("Preparing refresh section response: path ID = [{0}], component = [{1}], section= [{2}]",
page.getPathId(), widget.getLongName(), sectionPageName);
writer.write(",\"section\":").writeJsonSection(widget, sectionPageName);
appendRegisteredDebounceWidgets(writer, false);
} else {
logDebug("Preparing refresh section response: Can not get section information from request context");
}
}
}