001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.uif.lifecycle.finalize;
017
018import java.util.Map;
019
020import org.kuali.rice.core.api.CoreApiServiceLocator;
021import org.kuali.rice.krad.uif.UifConstants;
022import org.kuali.rice.krad.uif.lifecycle.FinalizeComponentPhase;
023import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle;
024import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
025import org.kuali.rice.krad.uif.util.ScriptUtils;
026import org.kuali.rice.krad.uif.view.View;
027import org.kuali.rice.krad.uif.view.ViewModel;
028import org.kuali.rice.krad.util.KRADConstants;
029
030/**
031 * Perform custom finalize behavior for the component defined by the helper.
032 * 
033 * @author Kuali Rice Team (rice.collab@kuali.org)
034 */
035public class FinalizeViewTask extends ViewLifecycleTaskBase<View> {
036
037    /**
038     * Default constructor.
039     */
040    public FinalizeViewTask() {
041        super(View.class);
042    }
043
044    /**
045     * {@inheritDoc}
046     */
047    @Override
048    public FinalizeComponentPhase getElementState() {
049        return (FinalizeComponentPhase) super.getElementState();
050    }
051
052    /**
053     * {@inheritDoc}
054     */
055    @Override
056    protected void performLifecycleTask() {
057        View view = (View) getElementState().getElement();
058        assert view == ViewLifecycle.getView();
059        Object model = ViewLifecycle.getModel();
060
061        view.setPreLoadScript(ScriptUtils.appendScript(
062                view.getPreLoadScript(), buildClientSideStateScript(model)));
063    }
064
065    /**
066     * Builds script that will initialize configuration parameters and component state on the client
067     * 
068     * <p>
069     * Here client side state is initialized along with configuration variables that need exposed to
070     * script
071     * </p>
072     * 
073     * @param model model containing the client side state map.
074     * @return The client side state script associated with this model.
075     */
076    protected String buildClientSideStateScript(Object model) {
077        Map<String, Object> clientSideState = ((ViewModel) model).getClientStateForSyncing();
078
079        // script for initializing client side state on load
080        String clientStateScript = "";
081        if (!clientSideState.isEmpty()) {
082            clientStateScript = ScriptUtils.buildFunctionCall(UifConstants.JsFunctions.INITIALIZE_VIEW_STATE,
083                    clientSideState);
084        }
085
086        // add necessary configuration parameters
087        String kradImageLocation = CoreApiServiceLocator.getKualiConfigurationService().getPropertyValueAsString(
088                UifConstants.ConfigProperties.KRAD_IMAGES_URL);
089        clientStateScript += ScriptUtils.buildFunctionCall(UifConstants.JsFunctions.SET_CONFIG_PARM,
090                UifConstants.ClientSideVariables.KRAD_IMAGE_LOCATION, kradImageLocation);
091
092        String kradURL = CoreApiServiceLocator.getKualiConfigurationService().getPropertyValueAsString(
093                UifConstants.ConfigProperties.KRAD_URL);
094        clientStateScript += ScriptUtils.buildFunctionCall(UifConstants.JsFunctions.SET_CONFIG_PARM,
095                UifConstants.ClientSideVariables.KRAD_URL, kradURL);
096
097        String applicationURL = CoreApiServiceLocator.getKualiConfigurationService().getPropertyValueAsString(
098                KRADConstants.ConfigParameters.APPLICATION_URL);
099        clientStateScript += ScriptUtils.buildFunctionCall(UifConstants.JsFunctions.SET_CONFIG_PARM,
100                UifConstants.ClientSideVariables.APPLICATION_URL, applicationURL);
101
102        String scriptCleanup = CoreApiServiceLocator.getKualiConfigurationService().getPropertyValueAsString(
103                KRADConstants.ConfigParameters.KRAD_SCRIPT_CLEANUP);
104        clientStateScript += ScriptUtils.buildFunctionCall(UifConstants.JsFunctions.SET_CONFIG_PARM,
105                UifConstants.ClientSideVariables.KRAD_SCRIPT_CLEANUP, scriptCleanup);
106
107        return clientStateScript;
108    }
109
110}