/*
* Copyright (C) 2012 The Cat Hive Developers.
*
* Licensed 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 com.cathive.fx.guice.controllerlookup;
import com.cathive.fx.guice.FXMLController;
import javafx.scene.Parent;
/**
* {@link IdentifiableController} should be implemented by JavaFX controller
* classes that need to be looked up via {@link ControllerLookup}.
*
* @author Andy Till
*
* @see FXMLController
* @see ParentIDFinder
*/
public interface IdentifiableController {
/**
* @return The string ID that can be used to lookup this controller. This
* could be hard coded or could return the ID set on the FXML for
* this control in the {@link Parent}.
*/
String getId();
}