001/**
002 * Copyright 2005-2016 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.model;
017
018import org.kuali.rice.krad.uif.component.Component;
019import org.kuali.rice.krad.uif.field.DataField;
020import org.kuali.rice.krad.uif.lifecycle.LifecycleElementState;
021import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle;
022import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
023import org.kuali.rice.krad.uif.util.ObjectPropertyUtils;
024
025/**
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public class RefreshStateModifyTask extends ViewLifecycleTaskBase<Component> {
029
030    /**
031     * Default constructor.
032     */
033    public RefreshStateModifyTask() {
034        super(Component.class);
035    }
036
037    /**
038     * @see org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase#performLifecycleTask()
039     */
040    @Override
041    protected void performLifecycleTask() {
042        LifecycleElementState phase = getElementState();
043        if (!ViewLifecycle.isRefreshComponent(phase.getViewPhase(), phase.getViewPath())) {
044            return;
045        }
046
047        Component component = (Component) getElementState().getElement();
048
049        // force the component to render on a refresh
050        component.setRender(true);
051
052        // reset data if needed
053        if (component.isResetDataOnRefresh()) {
054            // TODO: this should handle groups as well, going through nested data fields
055            if (component instanceof DataField) {
056                // TODO: should check default value
057
058                // clear value
059                ObjectPropertyUtils.initializeProperty(ViewLifecycle.getModel(),
060                        ((DataField) component).getBindingInfo().getBindingPath());
061            }
062        }
063    }
064
065}