org.apache.wicket.extensions.markup.html.form.select.IOptionRenderer.java Source code

Introduction

Here is the source code for org.apache.wicket.extensions.markup.html.form.select.IOptionRenderer.java

Source

/*
 * 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.wicket.extensions.markup.html.form.select;

import org.apache.wicket.model.IDetachable;
import org.apache.wicket.model.IModel;

/**
 * @param <T>
 *            the model object's type
 * @author Igor Vaynberg (ivaynberg)
 * 
 */
public interface IOptionRenderer<T> extends IDetachable {
    /**
     * Get the value for displaying to the user.
     * 
     * @param object
     *            SelectOption model object
     * @return the value for displaying to the user.
     */
    String getDisplayValue(T object);

    /**
     * Gets the model that will be used to represent the value object.
     * 
     * This is a good place to wrap the value object with a detachable model one is desired
     * 
     * @param value
     * @return model that will contain the value object
     */
    IModel<T> getModel(T value);

    /**
     * Override when needed.
     */
    @Override
    default void detach() {
    }
}