/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.isis.viewer.wicket.ui.components.scalars;
import de.agilecoders.wicket.core.markup.html.bootstrap.common.NotificationPanel;
import java.util.List;
import com.google.common.collect.Lists;
import org.apache.wicket.AttributeModifier;
import org.apache.wicket.Component;
import org.apache.wicket.MarkupContainer;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior;
import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.feedback.ComponentFeedbackMessageFilter;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.LabeledWebMarkupContainer;
import org.apache.wicket.markup.html.panel.Fragment;
import org.apache.wicket.model.Model;
import org.apache.isis.applib.annotation.Where;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.facets.members.cssclass.CssClassFacet;
import org.apache.isis.core.metamodel.facets.propparam.labelat.LabelAtFacet;
import org.apache.isis.core.runtime.system.DeploymentType;
import org.apache.isis.core.runtime.system.context.IsisContext;
import org.apache.isis.viewer.wicket.model.links.LinkAndLabel;
import org.apache.isis.viewer.wicket.model.mementos.ObjectAdapterMemento;
import org.apache.isis.viewer.wicket.model.models.*;
import org.apache.isis.viewer.wicket.model.models.EntityModel.RenderingHint;
import org.apache.isis.viewer.wicket.ui.components.additionallinks.AdditionalLinksPanel;
import org.apache.isis.viewer.wicket.ui.components.additionallinks.EntityActionUtil;
import org.apache.isis.viewer.wicket.ui.components.scalars.TextFieldValueModel.ScalarModelProvider;
import org.apache.isis.viewer.wicket.ui.panels.PanelAbstract;
import org.apache.isis.viewer.wicket.ui.util.Components;
import org.apache.isis.viewer.wicket.ui.util.CssClassAppender;
/**
* Adapter for {@link PanelAbstract panel}s that use a {@link ScalarModel} as
* their backing model.
*
* <p>
* Supports the concept of being {@link Rendering#COMPACT} (eg within a table) or
* {@link Rendering#REGULAR regular} (eg within a form).
*/
public abstract class ScalarPanelAbstract extends PanelAbstract<ScalarModel> implements ScalarModelProvider {
private static final long serialVersionUID = 1L;
protected static final String ID_SCALAR_IF_REGULAR = "scalarIfRegular";
protected static final String ID_SCALAR_NAME = "scalarName";
protected static final String ID_SCALAR_VALUE = "scalarValue";
protected static final String ID_SCALAR_IF_COMPACT = "scalarIfCompact";
private static final String ID_ADDITIONAL_LINKS = "additionalLinks";
private static final String ID_FEEDBACK = "feedback";
public enum CompactType {
INPUT_CHECKBOX,
SPAN
}
public enum Rendering {
/**
* Does not show labels, eg for use in tables
*/
COMPACT {
@Override
public String getLabelCaption(final LabeledWebMarkupContainer labeledContainer) {
return "";
}
@Override
public void buildGui(final ScalarPanelAbstract panel) {
panel.getComponentForRegular().setVisible(false);
}
@Override
public Where getWhere() {
return Where.PARENTED_TABLES;
}
},
/**
* Does show labels, eg for use in forms.
*/
REGULAR {
@Override
public String getLabelCaption(final LabeledWebMarkupContainer labeledContainer) {
return labeledContainer.getLabel().getObject();
}
@Override
public void buildGui(final ScalarPanelAbstract panel) {
panel.getLabelForCompact().setVisible(false);
}
@Override
public Where getWhere() {
return Where.OBJECT_FORMS;
}
};
public abstract String getLabelCaption(LabeledWebMarkupContainer labeledContainer);
public abstract void buildGui(ScalarPanelAbstract panel);
public abstract Where getWhere();
private static Rendering renderingFor(RenderingHint renderingHint) {
return renderingHint.isInTable()? Rendering.COMPACT: Rendering.REGULAR;
}
}
protected Component componentIfCompact;
private Component componentIfRegular;
protected final ScalarModel scalarModel;
public ScalarPanelAbstract(final String id, final ScalarModel scalarModel) {
super(id, scalarModel);
this.scalarModel = scalarModel;
}
protected Fragment getCompactFragment(CompactType type) {
Fragment compactFragment;
switch (type) {
case INPUT_CHECKBOX:
compactFragment = new Fragment("scalarIfCompact", "compactAsInputCheckbox", ScalarPanelAbstract.this);
break;
case SPAN:
default:
compactFragment = new Fragment("scalarIfCompact", "compactAsSpan", ScalarPanelAbstract.this);
break;
}
return compactFragment;
}
protected Rendering getRendering() {
return Rendering.renderingFor(getModel().getRenderingHint());
}
protected Component getLabelForCompact() {
return componentIfCompact;
}
public Component getComponentForRegular() {
return componentIfRegular;
}
private boolean guiForceBuilt = false;
/**
* Bit of a hack, but is an API to force the eager building of this component such that focus can be placed on it.
*
* <p>
* This is used in {@link org.apache.isis.viewer.wicket.ui.components.widgets.cssmenu.ActionLinkFactoryAbstract}
* when creating the action prompt parameters panel.
* </p>
*/
public void forceBuildGui() {
buildGui();
guiForceBuilt = true;
}
@Override
protected void onBeforeRender() {
if ((!hasBeenRendered() || alwaysRebuildGui())) {
if(!guiForceBuilt) {
// skip building, as was forced previously
buildGui();
} else {
// reset flag, so preserve original behaviour before the 'forced' hack.
guiForceBuilt = false;
}
}
final ScalarModel scalarModel = getModel();
if (scalarModel.isViewMode()) {
onBeforeRenderWhenViewMode();
} else {
final String disableReasonIfAny = scalarModel.disable(getRendering().getWhere());
if (disableReasonIfAny != null) {
onBeforeRenderWhenDisabled(disableReasonIfAny);
} else {
onBeforeRenderWhenEnabled();
}
}
super.onBeforeRender();
}
/**
* hook for highly dynamic components, eg conditional choices.
*
* <p>
* Returning <tt>true</tt> means that the component is always rebuilt prior to
* every {@link #onBeforeRender() render}ing.
*/
protected boolean alwaysRebuildGui() {
return false;
}
/**
* Builds GUI lazily prior to first render.
*
* <p>
* This design allows the panel to be configured first.
*
* @see #onBeforeRender()
*/
private void buildGui() {
// REVIEW: this is nasty, both write to the same entityLink field
// even though only one is used
componentIfCompact = addComponentForCompact();
componentIfRegular = addComponentForRegular();
getRendering().buildGui(this);
addCssForMetaModel();
if(!subscribers.isEmpty()) {
addFormComponentBehavior(new AjaxFormComponentUpdatingBehavior("change"){
private static final long serialVersionUID = 1L;
@Override
protected void onUpdate(AjaxRequestTarget target) {
for (ScalarModelSubscriber subscriber : subscribers) {
subscriber.onUpdate(target, ScalarPanelAbstract.this);
}
}
@Override
protected void onError(AjaxRequestTarget target, RuntimeException e) {
super.onError(target, e);
for (ScalarModelSubscriber subscriber : subscribers) {
subscriber.onError(target, ScalarPanelAbstract.this);
}
}
});
}
}
/**
* Mandatory hook.
*/
protected abstract void addFormComponentBehavior(Behavior behavior);
private void addCssForMetaModel() {
final String cssForMetaModel = getModel().getLongName();
if (cssForMetaModel != null) {
add(new AttributeAppender("class", Model.of(cssForMetaModel), " "));
}
ScalarModel model = getModel();
final CssClassFacet facet = model.getFacet(CssClassFacet.class);
if(facet != null) {
add(new CssClassAppender(facet.value()));
}
}
/**
* Mandatory hook method to build the component to render the model when in
* {@link Rendering#REGULAR regular} format.
*/
protected abstract MarkupContainer addComponentForRegular();
protected abstract Component addComponentForCompact();
protected void addFeedbackTo(MarkupContainer markupContainer, Component component) {
markupContainer.addOrReplace(new NotificationPanel(ID_FEEDBACK, component, new ComponentFeedbackMessageFilter(component)));
}
protected void addAdditionalLinksTo(final MarkupContainer labelIfRegular) {
final List<LinkAndLabel> entityActions;
if(scalarModel.getKind() == ScalarModel.Kind.PROPERTY) {
final ObjectAdapterMemento parentMemento = scalarModel.getParentObjectAdapterMemento();
final EntityModel parentEntityModel = new EntityModel(parentMemento);
final ActionPromptProvider actionPromptProvider = ActionPromptProvider.Util.getFrom(this);
entityActions = EntityActionUtil.entityActionsForAssociation(
parentEntityModel, scalarModel.getPropertyMemento().getProperty(), actionPromptProvider, getDeploymentType());
} else {
entityActions = null;
}
addAdditionalLinks(labelIfRegular, entityActions);
}
private void addAdditionalLinks(MarkupContainer markupContainer, List<LinkAndLabel> links) {
if(links == null || links.isEmpty()) {
Components.permanentlyHide(markupContainer, ID_ADDITIONAL_LINKS);
return;
}
links = Lists.newArrayList(links); // copy, to serialize any lazy evaluation
final WebMarkupContainer views = new AdditionalLinksPanel(ID_ADDITIONAL_LINKS, links);
markupContainer.addOrReplace(views);
}
/**
* Optional hook.
*/
protected void onBeforeRenderWhenViewMode() {
}
/**
* Optional hook.
*/
protected void onBeforeRenderWhenDisabled(final String disableReason) {
}
/**
* Optional hook.
*/
protected void onBeforeRenderWhenEnabled() {
}
/**
* Applies the {@literal @}{@link org.apache.isis.applib.annotation.LabelAt LabelAt} facet
*
* @param scalarName The label for the input
* @param formGroup The form group element
*/
protected void applyLabelAtRule(Label scalarName, MarkupContainer formGroup) {
final LabelAtFacet facet = getModel().getFacet(LabelAtFacet.class);
// TODO mgrigorov: Remove this. It is for debugging
scalarName.add(new AttributeModifier("title", "labelAt=" + (facet != null? facet.value(): "(null)")));
if (facet != null) {
switch (facet.value()) {
case LEFT:
formGroup.add(new CssClassAppender("label-left"));
break;
case NONE:
scalarName.setVisible(false);
break;
case TOP:
formGroup.add(new CssClassAppender("label-top"));
break;
default:
break;
}
} else {
formGroup.add(new CssClassAppender("label-left"));
}
}
// //////////////////////////////////////
private final List<ScalarModelSubscriber> subscribers = Lists.newArrayList();
public void notifyOnChange(final ScalarModelSubscriber subscriber) {
subscribers.add(subscriber);
}
// //////////////////////////////////////
/**
* Optional hook method
*
* @return true - indicates has been updated, so update dynamically via ajax
*/
public boolean updateChoices(ObjectAdapter[] pendingArguments) {
return false;
}
// ///////////////////////////////////////////////////////////////////
protected DeploymentType getDeploymentType() {
return IsisContext.getDeploymentType();
}
}