com.jwebmp.plugins.dynamicsourcecode.DynamicSourceCodePageConfigurator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jwebmp-dynamic-source-code-viewer Show documentation
The JWebSwing implementation for the Dynamic Source Code Viewer
The newest version!
/*
 * Copyright (C) 2017 Marc Magon
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.jwebmp.plugins.dynamicsourcecode;

import com.jwebmp.core.Page;
import com.jwebmp.core.plugins.PluginInformation;
import com.jwebmp.core.services.IPageConfigurator;

import javax.validation.constraints.NotNull;

/**
 * @author GedMarc
 * @since 28 Feb 2017
 */
@PluginInformation(pluginName = "Source Code View",
		pluginUniqueName = "jw-source-code-viewer",
		pluginDescription = "A basic screen with buttons to load sources, a format drop down, and a source display screen. Completely themable with a switch",
		pluginVersion = "1.0.0",
		pluginDependancyUniqueIDs = "jquery,google-code-prettify",
		pluginCategories = "jquery, ui, source display, web, framework",
		pluginSubtitle = "A custom built widget that provides a source code viewer, which will load and display source from pretty much anywhere",
		pluginGitUrl = "https://github.com/GedMarc/JWebMP-DynamicSourceCodeViewerPlugin",
		pluginSourceUrl = "https://github.com/GedMarc/JWebMP-DynamicSourceCodeViewerPlugin",
		pluginWikiUrl = "https://github.com/GedMarc/JWebMP-DynamicSourceCodeViewerPlugin/wiki",
		pluginOriginalHomepage = "http://www.jwebswing.com/",
		pluginIconUrl = "dynamicSourceCodeFetcher/dynamicviewerlogo.png",
		pluginIconImageUrl = "dynamicSourceCodeFetcher/dynamicviewerlogo.png",
		pluginDownloadUrl = "https://sourceforge.net/projects/jwebswing/files/plugins/DynamicSourceCodeViewerPlugin.jar/download",
		pluginCommercial = false)
@SuppressWarnings("unused")
public class DynamicSourceCodePageConfigurator
		implements IPageConfigurator
{
	/**
	 * If this configurator is enabled
	 */
	private static boolean enabled = true;

	/**
	 * The source page configurator
	 */
	public DynamicSourceCodePageConfigurator()
	{
		//Nothing needed
	}

	/**
	 * Method isEnabled returns the enabled of this AngularAnimatedChangePageConfigurator object.
	 * 
	 * If this configurator is enabled
	 *
	 * @return the enabled (type boolean) of this AngularAnimatedChangePageConfigurator object.
	 */
	public static boolean isEnabled()
	{
		return DynamicSourceCodePageConfigurator.enabled;
	}

	/**
	 * Method setEnabled sets the enabled of this AngularAnimatedChangePageConfigurator object.
	 * 
	 * If this configurator is enabled
	 *
	 * @param mustEnable
	 * 		the enabled of this AngularAnimatedChangePageConfigurator object.
	 */
	public static void setEnabled(boolean mustEnable)
	{
		DynamicSourceCodePageConfigurator.enabled = mustEnable;
	}

	@NotNull
	@Override
	public Page configure(Page page)
	{
		return page;
	}

	@Override
	public boolean enabled()
	{
		return DynamicSourceCodePageConfigurator.enabled;
	}
}