org.pushingpixels.substance.api.SubstanceComponentPlugin Maven / Gradle / Ivy
/*
* Copyright (c) 2005-2019 Substance Kirill Grouchnikov and contributors. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of the copyright holder nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.substance.api;
/**
* Basic interface for look-and-feel plugins.
*
* @author Kirill Grouchnikov
* @author Erik Vickroy
* @author Robert Beeger
* @author Frederic Lavigne
* @author Pattrick Gotthardt
*/
public interface SubstanceComponentPlugin {
/**
* Initializes this plugin.
*/
default void initialize() {}
/**
* Unitializes this plugin.
*/
default void uninitialize() {}
/**
* Retrieves a collection of custom settings based on the specified skin. The entries in the
* array should be pairwise, odd being symbolic name of a setting, and even being the setting
* value.
*
* @param skin
* Skin.
* @return Collection of custom settings based on the specified skin. The entries in the array
* should be pairwise, odd being symbolic name of a setting, and even being the setting
* value.
*/
Object[] getDefaults(SubstanceSkin skin);
}