OrderedComponent.java

/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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 net.java.sip.communicator.plugin.desktoputil;

/**
 * Components (like buttons) implement this interface to be able to
 * order them in a Ordered Transparent Panels.
 *
 * @author Damian Minkov
 */
public interface OrderedComponent
{
    /**
     * Change component index when we want to order it.
     * @param index the button index.
     */
    public void setIndex(int index);

    /**
     * Returns the current component index we have set, or -1 if none used.
     * @return
     */
    public int getIndex();
}