org.wings.plaf.css.CheckBoxCG Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.plaf.css;

import org.wings.*;
import org.wings.io.Device;
import org.wings.plaf.Update;
import org.wings.resource.ResourceManager;
import org.wings.script.JavaScriptEvent;
import org.wings.script.JavaScriptListener;

import java.io.IOException;

public class CheckBoxCG extends ButtonCG implements org.wings.plaf.CheckBoxCG {

    private static final long serialVersionUID = 1L;
    protected boolean useIconsInForms = false;

    public boolean isUseIconsInForm() {
        return useIconsInForms;
    }

    public void setUseIconsInForm(boolean useIconsInForm) {
        this.useIconsInForms = useIconsInForm;
    }

    @Override
    public void installCG(SComponent component) {
        super.installCG(component);
        final SAbstractButton button = (SAbstractButton) component;
        installIcons(button);
    }

    protected void installIcons(final SAbstractButton button) {
        button.setIcon((SIcon) ResourceManager.getObject("SCheckBox.icon", SIcon.class));
        button.setSelectedIcon((SIcon) ResourceManager.getObject("SCheckBox.selectedIcon", SIcon.class));
        button.setRolloverIcon((SIcon) ResourceManager.getObject("SCheckBox.rolloverIcon", SIcon.class));
        button.setRolloverSelectedIcon((SIcon) ResourceManager.getObject("SCheckBox.rolloverSelectedIcon", SIcon.class));
        button.setPressedIcon((SIcon) ResourceManager.getObject("SCheckBox.pressedIcon", SIcon.class));
        button.setDisabledIcon((SIcon) ResourceManager.getObject("SCheckBox.disabledIcon", SIcon.class));
        button.setDisabledSelectedIcon((SIcon) ResourceManager.getObject("SCheckBox.disabledSelectedIcon", SIcon.class));
    }

    @Override
    public void writeInternal(final Device device, final SComponent component)
            throws IOException {
        final SAbstractButton button = (SAbstractButton) component;

        final boolean showAsFormComponent = button.getShowAsFormComponent();
        final String text = button.getText();
        final SIcon icon = getIcon(button);

        /*
        // text only
        if (icon == null && text != null && (!showAsFormComponent || useIconsInForms && showAsFormComponent)) {
            device.print("");
            writeText(device, text, button.isWordWrap());
            device.print("");
        }
        */
        // icon or input only
        if (text == null) {
            device.print("");
            if ((showAsFormComponent && !useIconsInForms) || icon == null)
                writeInput(device, button);
            else
                writeIcon(device, icon, Utils.isMSIE(component));

            device.print("");
        }
        else {
            new IconTextCompound() {
                @Override
                protected void text(Device device) throws IOException {
                    writeText(device, text, button.isWordWrap());
                }

                @Override
                protected void icon(Device device) throws IOException {
                    if ((showAsFormComponent && !useIconsInForms) || icon == null)
                        writeInput(device, button);
                    else
                        writeIcon(device, icon, Utils.isMSIE(component));
                }

                @Override
                protected void tableAttributes(Device d) throws IOException {
                    CheckBoxCG.this.tableAttributes(d, button);
                }
            }.writeCompound(device, component, button.getHorizontalTextPosition(), button.getVerticalTextPosition(), false);
        }
    }

    @Override
    protected void tableAttributes(Device device, SAbstractButton button) throws IOException {
        final boolean showAsFormComponent = button.getShowAsFormComponent();
        // table is clickable
        if (!showAsFormComponent || useIconsInForms) {
            // Remove superfluous 'onChangeSubmitListener' (in case there is any).
            // This is because we don't want to render 'onclick' AND 'onchange'.
            Object clientProperty = button.getClientProperty("onChangeSubmitListener");
            if (clientProperty instanceof JavaScriptListener) {
                button.removeScriptListener((JavaScriptListener) clientProperty);
                button.putClientProperty("onChangeSubmitListener", null);
            }

            tableClickability(device, button);

            if (button.isFocusOwner())
                Utils.optAttribute(device, "foc", button.getName());

            Utils.optAttribute(device, "tabindex", button.getFocusTraversalIndex());
            Utils.optAttribute(device, "accesskey", button.getMnemonic());
        }

        if (button.isSelected())
            device.print(" checked=\"true\"");

        String style = button.getStyle();
        StringBuilder className = new StringBuilder(style);
        if (button.getShowAsFormComponent())
            className.append("_form");
        if (!button.isEnabled())
            className.append("_disabled");
        if (button.isSelected())
            className.append("_selected");

        button.setStyle(className.toString());
        Utils.writeAllAttributes(device, button);
        button.setStyle(style);
    }

    protected void tableClickability(Device device, SAbstractButton button) throws IOException {
        Utils.printClickability(device, button, button.getToggleSelectionParameter(), button.isEnabled(), button.getShowAsFormComponent());
    }

    protected void writeInput(Device device, SAbstractButton button) throws IOException {
        if (button.getShowAsFormComponent() && !useIconsInForms) {
            Object clientProperty = button.getClientProperty("onChangeSubmitListener");
            // If the application developer attached any ActionListeners, ItemListeners or
            // ChangeListeners to this SCheckBox or its ButtonGroup, the surrounding form
            // gets submitted as soon as the state of this SCheckBox changed.
            if (button.getActionListeners().length > 0 ||
                    button.getItemListeners().length > 0 ||
                    button.getChangeListeners().length > 0 ||
                    (button.getGroup() != null && button.getGroup().getActionListeners().length > 0)) {
                if (clientProperty == null) {
                    String event = JavaScriptEvent.ON_CHANGE;
                	String code = "wingS.request.sendEvent(event, true, " + !button.isReloadForced() + ");";
                    if (Utils.isMSIE(button)) {
                        // In IE the "onchange"-event gets fired when a control loses the
                        // input focus and its value has been modified since gaining focus.
                        // Even though this is actually the correct behavior, we want the
                        // event to get fired immediately - thats why we use IE's proprietary
                        // "onpropertychange"-event.
                        event = "onpropertychange";
                    }
                    JavaScriptListener javaScriptListener = new JavaScriptListener(event, code);
                    button.addScriptListener(javaScriptListener);
                    button.putClientProperty("onChangeSubmitListener", javaScriptListener);
                }
            } else if (clientProperty instanceof JavaScriptListener) {
                button.removeScriptListener((JavaScriptListener) clientProperty);
                button.putClientProperty("onChangeSubmitListener", null);
            }
        }

        device.print("");

        device.print("");
    }

    @Override
    public Update getTextUpdate(SCheckBox checkBox, String text) {
        return text == null ? null : new TextUpdate(checkBox, text);
    }

    @Override
    public Update getIconUpdate(SCheckBox checkBox, SIcon icon) {
        return icon == null ? null : new IconUpdate(checkBox, icon);
    }
}