org.jacpfx.api.component.ComponentView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jacpfx.API Show documentation
The newest version!
/*
 * **********************************************************************
 *
 *  Copyright (C) 2010 - 2015
 *
 *  [ComponentView.java]
 *  JACPFX Project (https://github.com/JacpFX/JacpFX/)
 *  All rights reserved.
 *
 *  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.
 *
 *
 * *********************************************************************
 */
package org.jacpfx.api.component;

import org.jacpfx.api.message.Message;

/**
 * Represents an UI component handled by a perspective. A IVComponent is an // *
 * visible UI component displayed in a defined area of perspective.
 *
 * @param  defines the base component where others extend from
 * @param  defines the basic event type
 * @param  defines the basic message type
 * @author Andy Moncsek
 */
public interface ComponentView extends ComponentHandle {

    /**
     * To avoid toolkit specific threading issues the postHandle method always
     * called after the handle method. While the handle method is executed in a
     * separate thread the postHandle method is guaranteed to run in application
     * main thread. It is mostly save to create new component outside the main
     * thread in the handle method but when you like to recycle your component
     * you should use the postHandle method. In the postHandle method you should
     * avoid long running tasks. Use it only to create or update your ui
     * component.
     *
     * @param node    , the ui node
     * @param message ,  the trigger message
     * @return an ui component
     * @throws java.lang.Exception , this method can throw any Exception because it will be implemented in any component.
     */
    C postHandle(final C node, final Message message) throws Exception;


}
Related Artifacts