org.csstudio.display.builder.representation.WidgetRepresentationFactory Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2015-2016 Oak Ridge National Laboratory.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package org.csstudio.display.builder.representation;

import org.csstudio.display.builder.model.Widget;

/** Factory for creating Toolkit representation of a widget
 *
 *  @author Kay Kasemir
 *  @param  Toolkit widget parent class (JFX 'Parent')
 *  @param  Toolkit widget base class (JFX 'Node')
 */
@FunctionalInterface
@SuppressWarnings("nls")
public interface WidgetRepresentationFactory
{
    /** Type used to represent unknown widgets */
    public static final String UNKNOWN = "UNKNOWN";

    /** Construct representation for a model widget
     *  @return {@link WidgetRepresentation}
     *  @throws Exception on error
     */
	public WidgetRepresentation create() throws Exception;
}