/*
* 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 java.io.Serializable;
import com.google.common.base.Strings;
import org.apache.wicket.AttributeModifier;
import org.apache.wicket.Component;
import org.apache.wicket.MarkupContainer;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.AbstractTextComponent;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.markup.html.panel.Fragment;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.isis.core.metamodel.facets.SingleIntValueFacet;
import org.apache.isis.core.metamodel.facets.propparam.maxlen.MaxLengthFacet;
import org.apache.isis.core.metamodel.facets.objpropparam.typicallen.TypicalLengthFacet;
import org.apache.isis.viewer.wicket.model.models.ScalarModel;
import org.apache.isis.viewer.wicket.ui.components.widgets.bootstrap.FormGroup;
import org.apache.isis.viewer.wicket.ui.util.CssClassAppender;
/**
* Adapter for {@link ScalarPanelAbstract scalar panel}s that are implemented
* using a simple {@link TextField}.
*/
public abstract class ScalarPanelTextFieldAbstract<T extends Serializable> extends ScalarPanelAbstract {
private static final long serialVersionUID = 1L;
private static final String ID_SCALAR_TYPE_CONTAINER = "scalarTypeContainer";
protected final Class<T> cls;
protected WebMarkupContainer scalarTypeContainer;
private AbstractTextComponent<T> textField;
public ScalarPanelTextFieldAbstract(final String id, final ScalarModel scalarModel, final Class<T> cls) {
super(id, scalarModel);
this.cls = cls;
}
@Override
protected void onInitialize() {
super.onInitialize();
scalarTypeContainer = new WebMarkupContainer(ID_SCALAR_TYPE_CONTAINER);
scalarTypeContainer.add(new CssClassAppender(getScalarPanelType()));
addOrReplace(scalarTypeContainer);
}
protected AbstractTextComponent<T> getTextField() {
return textField;
}
protected AbstractTextComponent<T> createTextFieldForRegular() {
return createTextField(ID_SCALAR_VALUE);
}
protected TextField<T> createTextField(final String id) {
return new TextField<>(id, newTextFieldValueModel(), cls);
}
protected TextFieldValueModel<T> newTextFieldValueModel() {
return new TextFieldValueModel<>(this);
}
@Override
protected MarkupContainer addComponentForRegular() {
textField = createTextFieldForRegular();
textField.setOutputMarkupId(true);
addStandardSemantics();
addSemantics();
final MarkupContainer labelIfRegular = createFormComponentLabel();
scalarTypeContainer.add(labelIfRegular);
final Label scalarName = new Label(ID_SCALAR_NAME, getRendering().getLabelCaption(textField));
applyLabelAtRule(scalarName, labelIfRegular);
if(getModel().isRequired()) {
final String label = scalarName.getDefaultModelObjectAsString();
if(!Strings.isNullOrEmpty(label)) {
scalarName.add(new CssClassAppender("mandatory"));
}
}
labelIfRegular.add(scalarName);
final String describedAs = getModel().getDescribedAs();
if(describedAs != null) {
labelIfRegular.add(new AttributeModifier("title", Model.of(describedAs)));
}
addFeedbackTo(labelIfRegular, textField);
addAdditionalLinksTo(labelIfRegular);
return labelIfRegular;
}
protected abstract IModel<String> getScalarPanelType();
/**
* Optional hook method
*/
protected void addSemantics() {
// we don't call textField.setType(), since we want more control
// over the parsing (using custom subclasses of TextField etc)
}
private MarkupContainer createFormComponentLabel() {
Fragment textFieldFragment = createTextFieldFragment("scalarValueContainer");
final AbstractTextComponent<T> textField = getTextField();
final String name = getModel().getName();
textField.setLabel(Model.of(name));
final FormGroup scalarNameAndValue = new FormGroup(ID_SCALAR_IF_REGULAR, textField);
textFieldFragment.add(textField);
scalarNameAndValue.add(textFieldFragment);
return scalarNameAndValue;
}
protected Fragment createTextFieldFragment(String id) {
return new Fragment(id, "text", ScalarPanelTextFieldAbstract.this);
}
protected void addStandardSemantics() {
textField.setRequired(getModel().isRequired());
setTextFieldSizeAndMaxLengthIfSpecified(textField);
}
protected void setTextFieldSizeAndMaxLengthIfSpecified(AbstractTextComponent<T> textField) {
final Integer maxLength = getValueOf(getModel(), MaxLengthFacet.class);
Integer typicalLength = getValueOf(getModel(), TypicalLengthFacet.class);
// doesn't make sense for typical length to be > maxLength
if(typicalLength != null && maxLength != null && typicalLength > maxLength) {
typicalLength = maxLength;
}
if (typicalLength != null) {
textField.add(new AttributeModifier("size", Model.of("" + typicalLength)));
}
if(maxLength != null) {
textField.add(new AttributeModifier("maxlength", Model.of("" + maxLength)));
}
}
private static Integer getValueOf(ScalarModel model, Class<? extends SingleIntValueFacet> facetType) {
final SingleIntValueFacet facet = model.getFacet(facetType);
return facet != null ? facet.value() : null;
}
/**
* Mandatory hook method to build the component to render the model when in
* {@link Rendering#COMPACT compact} format.
*
* <p>
* This default implementation uses a {@link Label}, however it may be overridden if required.
*/
@Override
protected Component addComponentForCompact() {
Fragment compactFragment = getCompactFragment(CompactType.SPAN);
final Label labelIfCompact = new Label(ID_SCALAR_IF_COMPACT, getModel().getObjectAsString());
compactFragment.add(labelIfCompact);
scalarTypeContainer.addOrReplace(compactFragment);
return labelIfCompact;
}
@Override
protected void onBeforeRenderWhenViewMode() {
super.onBeforeRenderWhenViewMode();
textField.setEnabled(false);
setTitleAttribute("");
}
@Override
protected void onBeforeRenderWhenDisabled(final String disableReason) {
super.onBeforeRenderWhenDisabled(disableReason);
textField.setEnabled(false);
setTitleAttribute(disableReason);
}
@Override
protected void onBeforeRenderWhenEnabled() {
super.onBeforeRenderWhenEnabled();
textField.setEnabled(true);
setTitleAttribute("");
}
private void setTitleAttribute(final String titleAttribute) {
textField.add(new AttributeModifier("title", Model.of(titleAttribute)));
}
@Override
protected void addFormComponentBehavior(Behavior behavior) {
textField.add(behavior);
}
}