org.drombler.commons.docking.fx.FXDockableData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of drombler-commons-docking-fx Show documentation
Drombler Commons - Docking - FX provides a docking framework for JavaFX.
There is a newer version: 1.0
Show newest version
/*
 *         COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Notice
 *
 * The contents of this file are subject to the COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.opensource.org/licenses/cddl1.txt
 *
 * The Original Code is Drombler.org. The Initial Developer of the
 * Original Code is Florian Brunner (Sourceforge.net user: puce).
 * Copyright 2014 Drombler.org. All Rights Reserved.
 *
 * Contributor(s): .
 */
package org.drombler.commons.docking.fx;

import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.SimpleStringProperty;
import javafx.beans.property.StringProperty;
import javafx.scene.Node;
import javafx.scene.control.ContextMenu;
import javafx.scene.control.Tooltip;
import org.drombler.commons.docking.DockableData;
import org.drombler.commons.client.graphic.GraphicFactory;

/**
 * Data about a Dockable.
 *
 * @author puce
 */
public class FXDockableData implements DockableData {

//    private final ResourceBundle resourceBundle;
//
//    public FXDockableData(ResourceBundle resourceBundle) {
//        this.resourceBundle = resourceBundle;
//    }
//
//    /**
//     * @return the resourceBundle
//     */
//    public ResourceBundle getResourceBundle() {
//        return resourceBundle;
//    }
    /**
     * The title of this Dockable. It is used to represent this Dockable e.g. in menus or tabs.
     */
    private final StringProperty title = new SimpleStringProperty(this, TITLE_PROPERTY_NAME, "");
    /**
     * The tooltip for this Dockable. It is used to provide additional information about this Dockable.
     */
    private final ObjectProperty tooltip = new SimpleObjectProperty<>(this, "tooltip", null);
    /**
     * The graphic of this Dockable. It is used to represent this Dockable e.g. in menus or tabs. TODO: needed?
     */
    private final ObjectProperty graphic = new SimpleObjectProperty<>(this, "graphic", null);

    /**
     * The {@link GraphicFactory}.
     */
    private final ObjectProperty> graphicFactory = new SimpleObjectProperty<>(this, "graphicFactory", null);

    /**
     * The {@link ContextMenu}. TODO: needed?
     */
    private final ObjectProperty contextMenu = new SimpleObjectProperty<>(this, "contextMenu", null);

    /**
     * The modified flag indicates if the data represented by the Dockable has been modified.
     */
    private final BooleanProperty modified = new SimpleBooleanProperty(this, MODIFIED_PROPERTY_NAME, false);

    private final PropertyChangeSupport propertyChangeSupport = new PropertyChangeSupport(this);

    /**
     * Creates a new instance of this class.
     */
    public FXDockableData() {
        title.addListener((observable, oldValue, newValue) -> propertyChangeSupport.firePropertyChange(TITLE_PROPERTY_NAME, oldValue, newValue));
        modified.addListener((observable, oldValue, newValue) -> propertyChangeSupport.firePropertyChange(MODIFIED_PROPERTY_NAME, oldValue, newValue));
    }

    @Override
    public final String getTitle() {
        return titleProperty().get();
    }

    @Override
    public final void setTitle(String title) {
        titleProperty().set(title);
    }

    public StringProperty titleProperty() {
        return title;
    }

    public final Tooltip getTooltip() {
        return tooltipProperty().get();
    }

    public final void setTooltip(Tooltip tooltip) {
        tooltipProperty().set(tooltip);
    }

    public ObjectProperty tooltipProperty() {
        return tooltip;
    }

    public final Node getGraphic() {
        return graphicProperty().get();
    }

    public final void setGraphic(Node graphic) {
        graphicProperty().set(graphic);
    }

    public ObjectProperty graphicProperty() {
        return graphic;
    }

    public final GraphicFactory getGraphicFactory() {
        return graphicFactoryProperty().get();
    }

    public final void setGraphicFactory(GraphicFactory graphicFactory) {
        graphicFactoryProperty().set(graphicFactory);
    }

    public ObjectProperty> graphicFactoryProperty() {
        return graphicFactory;
    }

    public final ContextMenu getContextMenu() {
        return contextMenuProperty().get();
    }

    public final void setContextMenu(ContextMenu contextMenu) {
        contextMenuProperty().set(contextMenu);
    }

    public ObjectProperty contextMenuProperty() {
        return contextMenu;
    }

    @Override
    public final boolean isModified() {
        return modifiedProperty().get();
    }

    @Override
    public final void setModified(boolean modified) {
        modifiedProperty().set(modified);
    }

    public BooleanProperty modifiedProperty() {
        return modified;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public final void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) {
        propertyChangeSupport.addPropertyChangeListener(propertyName, listener);
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public final void removePropertyChangeListener(String propertyName, PropertyChangeListener listener) {
        propertyChangeSupport.removePropertyChangeListener(propertyName, listener);
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public String toString() {
        return "FXDockableData[title=" + getTitle() + "]";
    }

}