wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraAlertSkin.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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 org.apache.pivot.wtk.skin.terra;

import java.awt.Color;

import org.apache.pivot.beans.BXMLSerializer;
import org.apache.pivot.collections.Sequence;
import org.apache.pivot.util.Utils;
import org.apache.pivot.util.Vote;
import org.apache.pivot.wtk.Alert;
import org.apache.pivot.wtk.AlertListener;
import org.apache.pivot.wtk.Border;
import org.apache.pivot.wtk.BoxPane;
import org.apache.pivot.wtk.Button;
import org.apache.pivot.wtk.ButtonPressListener;
import org.apache.pivot.wtk.Component;
import org.apache.pivot.wtk.Dialog;
import org.apache.pivot.wtk.GraphicsUtilities;
import org.apache.pivot.wtk.ImageView;
import org.apache.pivot.wtk.Label;
import org.apache.pivot.wtk.MessageType;
import org.apache.pivot.wtk.PushButton;
import org.apache.pivot.wtk.Style;
import org.apache.pivot.wtk.Theme;
import org.apache.pivot.wtk.Window;
import org.apache.pivot.wtk.util.ColorUtilities;

/**
 * Alert skin.
 */
public class TerraAlertSkin extends TerraDialogSkin implements AlertListener {
    private ImageView typeImageView = null;
    private Label messageLabel = null;
    private Border messageBorder = null;
    private BoxPane messageBoxPane = null;
    private BoxPane optionButtonBoxPane = null;
    private Color borderBackgroundColor = null;
    private Color borderColor = null;
    private static final String BUTTON_STYLE_NAME =
            TerraAlertSkin.class.getPackage().getName() + "." + TerraTheme.COMMAND_BUTTON_STYLE;

    private ButtonPressListener optionButtonPressListener = new ButtonPressListener() {
        @Override
        public void buttonPressed(Button button) {
            int optionIndex = optionButtonBoxPane.indexOf(button);

            if (optionIndex >= 0) {
                Alert alert = (Alert) getComponent();
                alert.setSelectedOptionIndex(optionIndex);
                alert.close(true);
            }
        }
    };

    public TerraAlertSkin() {
        Theme theme = currentTheme();

        Color backgroundColor = theme.getColor(9);
        setBackgroundColor(ColorUtilities.setTransparencyInColor(backgroundColor, ALPHA));

        setBorderBackgroundColor(theme.getColor(10));
        setBorderColor(theme.getColor(7));
    }

    @Override
    public void install(Component component) {
        super.install(component);

        Alert alert = (Alert) component;
        alert.setPreferredWidth(320);
        alert.setMinimumWidth(160);

        alert.getAlertListeners().add(this);

        // Load the alert content
        BXMLSerializer bxmlSerializer = new BXMLSerializer();

        Component content;
        try {
            content = (Component) bxmlSerializer.readObject(TerraAlertSkin.class,
                "terra_alert_skin.bxml");
        } catch (Exception exception) {
            throw new RuntimeException(exception);
        }

        alert.setContent(content);

        typeImageView = (ImageView) bxmlSerializer.getNamespace().get("typeImageView");
        messageLabel = (Label) bxmlSerializer.getNamespace().get("messageLabel");
        messageBorder = (Border) bxmlSerializer.getNamespace().get("messageBorder");
        messageBoxPane = (BoxPane) bxmlSerializer.getNamespace().get("messageBoxPane");
        optionButtonBoxPane = (BoxPane) bxmlSerializer.getNamespace().get("optionButtonBoxPane");

        // Explicitly set the message border color and background color, this can't be done properly in the constructor
        // as messageBorder is null at that point.
        setBorderBackgroundColor(borderBackgroundColor);
        setBorderColor(borderColor);

        for (Object option : alert.getOptions()) {
            PushButton optionButton = new PushButton(option);
            optionButton.setStyleName(BUTTON_STYLE_NAME);
            optionButton.getButtonPressListeners().add(optionButtonPressListener);

            optionButtonBoxPane.add(optionButton);
        }

        messageTypeChanged(alert, null);
        messageChanged(alert, null);
        bodyChanged(alert, null);
    }

    @Override
    public void windowOpened(Window window) {
        super.windowOpened(window);

        Alert alert = (Alert) window;
        int index = alert.getSelectedOptionIndex();

        if (index >= 0) {
            optionButtonBoxPane.get(index).requestFocus();
        } else {
            window.requestFocus();
        }
    }

    @Override
    public void messageTypeChanged(Alert alert, MessageType previousMessageType) {
        TerraTheme theme = (TerraTheme) currentTheme();
        typeImageView.setImage(theme.getMessageIcon(alert.getMessageType()));
    }

    @Override
    public void messageChanged(Alert alert, String previousMessage) {
        messageLabel.setText(alert.getMessage());
    }

    @Override
    public void bodyChanged(Alert alert, Component previousBody) {
        if (previousBody != null) {
            messageBoxPane.remove(previousBody);
        }

        Component body = alert.getBody();
        if (body != null) {
            messageBoxPane.add(body);
        }
    }

    @Override
    public void optionInserted(Alert alert, int index) {
        Object option = alert.getOptions().get(index);

        PushButton optionButton = new PushButton(option);
        optionButton.setStyleName(BUTTON_STYLE_NAME);
        optionButton.getButtonPressListeners().add(optionButtonPressListener);

        optionButtonBoxPane.insert(optionButton, index);
    }

    @Override
    public void optionsRemoved(Alert alert, int index, Sequence<?> removed) {
        optionButtonBoxPane.remove(index, removed.getLength());
    }

    @Override
    public void selectedOptionChanged(Alert alert, int previousSelectedOption) {
        int index = alert.getSelectedOptionIndex();

        if (alert.isOpen() && index >= 0) {
            optionButtonBoxPane.get(index).requestFocus();
        }
    }

    @Override
    public Vote previewWindowOpen(Window window) {
        Vote vote = super.previewWindowOpen(window);
        if (vote == Vote.APPROVE) {
            // If this is the second or subsequent open, then the
            // image view has been cleared, so set it up again
            messageTypeChanged((Alert) window, null);
        }
        return vote;
    }

    @Override
    public void dialogClosed(Dialog dialog, boolean modal) {
        super.dialogClosed(dialog, modal);
        typeImageView.clearImage();
    }

    public void setBorderBackgroundColor(Color borderBackgroundColor) {
        Utils.checkNull(borderBackgroundColor, "borderBackgroundColor");

        this.borderBackgroundColor = borderBackgroundColor;

        if (messageBorder != null) {
            messageBorder.getStyles().put(Style.backgroundColor, borderBackgroundColor);
        }
    }

    public final void setBorderBackgroundColor(String borderBackgroundColor) {
        setBorderBackgroundColor(GraphicsUtilities.decodeColor(borderBackgroundColor,
            "borderBackgroundColor"));
    }

    public final void setBorderBackgroundColor(int borderBackgroundColor) {
        Theme theme = currentTheme();
        setBorderBackgroundColor(theme.getColor(borderBackgroundColor));
    }

    public Color getBorderBackgroundColor() {
        return borderBackgroundColor;
    }

    public void setBorderColor(Color borderColor) {
        Utils.checkNull(borderColor, "borderColor");

        this.borderColor = borderColor;

        if (messageBorder != null) {
            messageBorder.getStyles().put(Style.color, borderColor);
        }
    }

    public final void setBorderColor(String borderColor) {
        setBorderColor(GraphicsUtilities.decodeColor(borderColor, "borderColor"));
    }

    public final void setBorderColor(int borderColor) {
        Theme theme = currentTheme();
        setBorderColor(theme.getColor(borderColor));
    }

    public Color getBorderColor() {
        return borderColor;
    }

}