org.fujion.component.Detail Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fujion-core Show documentation
There is a newer version: 3.1.0
/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2018 Fujion Framework
 * %%
 * Licensed 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.
 *
 * #L%
 */
package org.fujion.component;

import org.fujion.annotation.Component;
import org.fujion.annotation.Component.ChildTag;
import org.fujion.annotation.Component.ContentHandling;
import org.fujion.annotation.Component.PropertyGetter;
import org.fujion.annotation.Component.PropertySetter;
import org.fujion.annotation.EventHandler;
import org.fujion.event.CloseEvent;
import org.fujion.event.OpenEvent;

/**
 * A collapsible detail component.
 */
@Component(tag = "detail", widgetModule = "fujion-detail", widgetClass = "Detail", content = ContentHandling.AS_CHILD, parentTag = "*", childTag = @ChildTag("*"), description = "A collapsible detail component.")
public class Detail extends BaseLabeledComponent {
    
    private boolean open;
    
    public Detail() {
        super();
    }
    
    public Detail(String label) {
        super(label);
    }

    /**
     * Returns true if the detail view is open.
     *
     * @return True if the detail view is open.
     */
    @PropertyGetter(value = "open", description = "True if the detail view is open.")
    public boolean isOpen() {
        return open;
    }

    /**
     * Set the detail view open state.
     *
     * @param open The detail view open state.
     */
    @PropertySetter(value = "open", defaultValue = "false", description = "True if the detail view is open.")
    public void setOpen(boolean open) {
        _setOpen(open, true);
    }
    
    /**
     * Set the detail view open state, optionally notifying the client
     *
     * @param open The new open state.
     * @param notifyClient If true, notify the client.
     */
    private void _setOpen(boolean open, boolean notifyClient) {
        propertyChange("open", this.open, this.open = open, notifyClient);
    }

    /**
     * Handles an open event from the client.
     *
     * @param event An open event.
     */
    @EventHandler(value = "open", syncToClient = false, mode = "init")
    private void _onOpen(OpenEvent event) {
        _setOpen(true, false);
    }

    /**
     * Handles an close event from the client.
     *
     * @param event A close event.
     */
    @EventHandler(value = "close", syncToClient = false, mode = "init")
    private void _onClose(CloseEvent event) {
        _setOpen(false, false);
    }
}