org.valkyriercp.application.PageComponentDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of valkyrie-rcp-core Show documentation

There is a newer version: 1.3

package org.valkyriercp.application;

import org.valkyriercp.core.DescribedElement;
import org.valkyriercp.core.PropertyChangePublisher;
import org.valkyriercp.core.VisualizedElement;

/**
 * Metadata about a page component; a page component is effectively a
 * singleton page component definition. A descriptor also acts as a factory
 * which produces new instances of a given page component when requested,
 * typically by a requesting application page. A page component descriptor
 * can also produce a command which launches a page component for display
 * on the page within the current active window.
 */
public interface PageComponentDescriptor extends PropertyChangePublisher, DescribedElement, VisualizedElement {

    /**
     * Returns the identifier of this descriptor.
     * @return The descriptor id.
     */
    public String getId();

    /**
     * Creates the page component defined by this descriptor.
     * @return The page component, never null.
     */
    public PageComponent createPageComponent();

}