001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.extensions.markup.html.form.select;
018
019import org.apache.wicket.model.IDetachable;
020import org.apache.wicket.model.IModel;
021
022/**
023 * @param <T>
024 *            the model object's type
025 * @author Igor Vaynberg (ivaynberg)
026 * 
027 */
028public interface IOptionRenderer<T> extends IDetachable
029{
030        /**
031         * Get the value for displaying to the user.
032         * 
033         * @param object
034         *            SelectOption model object
035         * @return the value for displaying to the user.
036         */
037        String getDisplayValue(T object);
038
039        /**
040         * Gets the model that will be used to represent the value object.
041         * 
042         * This is a good place to wrap the value object with a detachable model one is desired
043         * 
044         * @param value
045         * @return model that will contain the value object
046         */
047        IModel<T> getModel(T value);
048
049        /**
050         * Override when needed.
051         */
052        @Override
053        default void detach()
054        {
055        }
056}