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.breadcrumb.panel;
018
019import org.apache.wicket.extensions.breadcrumb.IBreadCrumbModel;
020import org.apache.wicket.util.io.IClusterable;
021
022
023/**
024 * Factory interface to enabled deferred creation of a bread crumb panel while getting the proper id
025 * for creation. Mainly meant for supporting
026 * {@link BreadCrumbPanel#activate(IBreadCrumbPanelFactory)}.
027 */
028@FunctionalInterface
029public interface IBreadCrumbPanelFactory extends IClusterable
030{
031        /**
032         * Creates a new {@link BreadCrumbPanel bread crumb panel} instance. The provided component id
033         * must be used when creating the panel.
034         * 
035         * @param componentId
036         *            The component id for the new panel.
037         * @param breadCrumbModel
038         *            The bread crumb model
039         * @return A new bread crumb panel instance
040         */
041        BreadCrumbPanel create(String componentId, IBreadCrumbModel breadCrumbModel);
042}