org.pepstock.charba.client.configuration.Padding Maven / Gradle / Ivy

Go to download
/**
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you 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.pepstock.charba.client.configuration;

import org.pepstock.charba.client.callbacks.NativeCallback;
import org.pepstock.charba.client.callbacks.PaddingCallback;
import org.pepstock.charba.client.options.IsPadding;
import org.pepstock.charba.client.options.IsScriptablePaddingProvider;

/**
 * Maps the additional space to apply to the sides of elements (left, top, right, bottom), in pixels.
 * 
 * @author Andrea "Stock" Stocchero
 *
 */
public final class Padding extends AbstractDynamicConfiguration implements IsPadding {

	// instance of scriptable padding configuration container
	private final IsScriptablePaddingProvider scriptablePaddingProvider;

	/**
	 * Builds the object by a padding provider used to get the padding element for storing properties.
	 * 
	 * @param provider padding provider used to get the padding element for storing properties.
	 */
	Padding(IsProvider provider) {
		this(null, provider);
	}

	/**
	 * Builds the object by a padding provider used to get the padding element for storing properties.
	 * 
	 * @param scriptablePaddingProvider the provider of padding callback
	 * @param provider padding provider used to get the padding element for storing properties.
	 */
	Padding(IsScriptablePaddingProvider scriptablePaddingProvider, IsProvider provider) {
		super(provider);
		// stores padding container
		this.scriptablePaddingProvider = scriptablePaddingProvider;
	}

	/**
	 * Sets the padding left in pixel.
	 * 
	 * @param padding the padding left in pixel.
	 */
	@Override
	public void setLeft(int padding) {
		// resets callback
		resetCallback();
		// stores value
		checkAndGet().setLeft(padding);
	}

	/**
	 * Returns the padding left in pixel.
	 * 
	 * @return the padding left in pixel.
	 */
	@Override
	public int getLeft() {
		return checkAndGet().getLeft();
	}

	/**
	 * Sets the padding right in pixel.
	 * 
	 * @param padding the padding right in pixel.
	 */
	@Override
	public void setRight(int padding) {
		// resets callback
		resetCallback();
		// stores value
		checkAndGet().setRight(padding);
	}

	/**
	 * Returns the padding right in pixel.
	 * 
	 * @return the padding right in pixel.
	 */
	@Override
	public int getRight() {
		return checkAndGet().getRight();
	}

	/**
	 * Sets the padding top in pixel.
	 * 
	 * @param padding the padding top in pixel.
	 */
	@Override
	public void setTop(int padding) {
		// resets callback
		resetCallback();
		// stores value
		checkAndGet().setTop(padding);
	}

	/**
	 * Returns the padding top in pixel.
	 * 
	 * @return the padding top in pixel.
	 */
	@Override
	public int getTop() {
		return checkAndGet().getTop();
	}

	/**
	 * Sets the padding bottom in pixel.
	 * 
	 * @param padding the padding bottom in pixel.
	 */
	@Override
	public void setBottom(int padding) {
		// resets callback
		resetCallback();
		// stores value
		checkAndGet().setBottom(padding);
	}

	/**
	 * Returns the padding bottom in pixel.
	 * 
	 * @return the padding bottom in pixel.
	 */
	@Override
	public int getBottom() {
		return checkAndGet().getBottom();
	}

	/**
	 * Invokes when any property of the padding is being set, in order to reset the {@link PaddingCallback} if exists
	 */
	protected void resetCallback() {
		// checks if the padding has been set previously as a callback
		if (scriptablePaddingProvider != null && scriptablePaddingProvider.getPaddingCallback() != null) {
			// if yes, resets it
			// resets by native callback to avoid conflicts on generics
			scriptablePaddingProvider.setPadding((NativeCallback) null);
		}
	}

}