/*
* 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.reference;
import org.apache.wicket.AttributeModifier;
import org.apache.wicket.Component;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.FormComponentLabel;
import org.apache.wicket.model.Model;
import org.apache.wicket.validation.IValidatable;
import org.apache.wicket.validation.IValidator;
import org.apache.wicket.validation.ValidationError;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.viewer.wicket.model.models.EntityModel;
import org.apache.isis.viewer.wicket.model.models.ScalarModel;
import org.apache.isis.viewer.wicket.ui.ComponentType;
import org.apache.isis.viewer.wicket.ui.components.scalars.ScalarPanelAbstract;
import org.apache.isis.viewer.wicket.ui.components.widgets.entitylink.EntityLinkSelect2Panel;
import org.apache.isis.viewer.wicket.ui.util.CssClassAppender;
/**
* Panel for rendering scalars which of are of reference type (as opposed to
* value types).
*/
public class ReferencePanel extends ScalarPanelAbstract {
private static final long serialVersionUID = 1L;
private static final String ID_SCALAR_IF_REGULAR = "scalarIfRegular";
private static final String ID_SCALAR_NAME = "scalarName";
private static final String ID_SCALAR_IF_COMPACT = "scalarIfCompact";
private EntityLinkSelect2Panel entityLink;
public ReferencePanel(final String id, final ScalarModel scalarModel) {
super(id, scalarModel);
}
@Override
protected void onBeforeRenderWhenEnabled() {
super.onBeforeRenderWhenEnabled();
entityLink.setEnabled(true);
entityLink.syncVisibilityAndUsability();
}
@Override
protected void onBeforeRenderWhenViewMode() {
super.onBeforeRenderWhenViewMode();
entityLink.setEnabled(true);
entityLink.syncVisibilityAndUsability();
}
@Override
protected void onBeforeRenderWhenDisabled(final String disableReason) {
super.onBeforeRenderWhenDisabled(disableReason);
final EntityModel entityLinkModel = (EntityModel) entityLink.getModel();
entityLinkModel.toViewMode();
setTitleAttribute(disableReason);
entityLink.syncVisibilityAndUsability();
}
private void setTitleAttribute(final String titleAttribute) {
entityLink.add(new AttributeModifier("title", Model.of(titleAttribute)));
}
@Override
protected FormComponentLabel addComponentForRegular() {
final ScalarModel scalarModel = getModel();
final String name = scalarModel.getName();
entityLink = (EntityLinkSelect2Panel) getComponentFactoryRegistry().createComponent(ComponentType.ENTITY_LINK, getModel());
setOutputMarkupId(true);
entityLink.setOutputMarkupId(true);
entityLink.setLabel(Model.of(name));
final FormComponentLabel labelIfRegular = new FormComponentLabel(ID_SCALAR_IF_REGULAR, entityLink);
labelIfRegular.add(entityLink);
final String describedAs = getModel().getDescribedAs();
if(describedAs != null) {
labelIfRegular.add(new AttributeModifier("title", Model.of(describedAs)));
}
final Label scalarName = new Label(ID_SCALAR_NAME, getRendering().getLabelCaption(entityLink));
labelIfRegular.add(scalarName);
addOrReplace(labelIfRegular);
addFeedbackTo(labelIfRegular, entityLink);
addAdditionalLinksTo(labelIfRegular);
addStandardSemantics();
addSemantics();
if(getModel().isRequired()) {
labelIfRegular.add(new CssClassAppender("mandatory"));
}
return labelIfRegular;
}
protected void addStandardSemantics() {
setRequiredIfSpecified();
}
private void setRequiredIfSpecified() {
final ScalarModel scalarModel = getModel();
final boolean required = scalarModel.isRequired();
entityLink.setRequired(required);
}
protected void addSemantics() {
addObjectAdapterValidator();
}
private void addObjectAdapterValidator() {
final ScalarModel scalarModel = getModel();
entityLink.add(new IValidator<ObjectAdapter>() {
private static final long serialVersionUID = 1L;
@Override
public void validate(final IValidatable<ObjectAdapter> validatable) {
final ObjectAdapter proposedAdapter = validatable.getValue();
final String reasonIfAny = scalarModel.validate(proposedAdapter);
if (reasonIfAny != null) {
final ValidationError error = new ValidationError();
error.setMessage(reasonIfAny);
validatable.error(error);
}
}
});
}
/**
* Mandatory hook method to build the component to render the model when in
* {@link Rendering#COMPACT compact} format.
*/
@Override
protected Component addComponentForCompact() {
final ScalarModel scalarModel = getModel();
final String name = scalarModel.getName();
final Component entityLinkComponent = getComponentFactoryRegistry().createComponent(ComponentType.ENTITY_LINK, getModel());
entityLink = (EntityLinkSelect2Panel) entityLinkComponent;
entityLink.setOutputMarkupId(true);
entityLink.setLabel(Model.of(name));
final FormComponentLabel labelIfCompact = new FormComponentLabel(ID_SCALAR_IF_COMPACT, entityLink);
labelIfCompact.add(entityLink);
addOrReplace(labelIfCompact);
return labelIfCompact;
}
// //////////////////////////////////////
@Override
protected void addFormComponentBehavior(Behavior behavior) {
entityLink.addFormComponentBehavior(behavior);
}
@Override
public boolean updateChoices(ObjectAdapter[] argsIfAvailable) {
return entityLink.updateChoices(argsIfAvailable);
}
}