SquirrelJME/SquirrelJME

// -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
// ---------------------------------------------------------------------------
// SquirrelJME
//     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
// ---------------------------------------------------------------------------
// SquirrelJME is under the Mozilla Public License Version 2.0.
// See license.mkd for licensing and copyright information.
// ---------------------------------------------------------------------------

package cc.squirreljme.emulator.uiform;

import cc.squirreljme.jvm.mle.brackets.UIFormBracket;
import cc.squirreljme.jvm.mle.brackets.UIItemBracket;
import cc.squirreljme.jvm.mle.brackets.UIWidgetBracket;
import cc.squirreljme.jvm.mle.callbacks.UIFormCallback;
import cc.squirreljme.jvm.mle.constants.UIWidgetProperty;
import cc.squirreljme.jvm.mle.exceptions.MLECallError;

/**
 * This is a widget.
 *
 * @since 2020/09/21
 */
public interface SwingWidget
    extends UIWidgetBracket
{
    /**
     * Returns the widget's callback
     * 
     * @return The callback for this widget.
     * @since 2020/10/17
     */
    UIFormCallback callback();
    
    /**
     * Returns the form that owns this.
     * 
     * @return The form that owns this.
     * @since 2020/10/17
     */
    UIFormBracket form();
    
    /**
     * Returns the item, if this is one.
     * 
     * @return The item.
     * @since 2020/10/17
     */
    UIItemBracket item();
    
    /**
     * Sets the given property.
     * 
     * @param __intProp The {@link UIWidgetProperty} to set.
     * @param __sub The sub-index.
     * @param __newValue The new value to set.
     * @throws MLECallError If the property is not valid.
     * @since 2020/09/13
     */
    void property(int __intProp, int __sub, int __newValue)
        throws MLECallError;
    
    /**
     * Sets the given property.
     * 
     * @param __strProp The {@link UIWidgetProperty} to set.
     * @param __sub The sub-value.
     * @param __newValue The new value to set.
     * @throws MLECallError If the property is not valid.
     * @since 2020/09/13
     */
    void property(int __strProp, int __sub, String __newValue);
    
    /**
     * Returns the given property.
     * 
     * @param __intProp The {@link UIWidgetProperty} to get.
     * @param __sub The sub-index.
     * @return The property.
     * @throws MLECallError If not a valid property.
     * @since 2020/09/21
     */
    int propertyInt(int __intProp, int __sub)
        throws MLECallError;
    
    /**
     * Returns the given property.
     * 
     * @param __strProp The {@link UIWidgetProperty} to get.
     * @param __sub The sub-index.
     * @return The property.
     * @throws MLECallError If not a valid property.
     * @since 2020/09/21
     */
    String propertyStr(int __strProp, int __sub)
        throws MLECallError;
}