com.sibvisions.rad.ui.vaadin.ext.ui.ExtendedGrid Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jvxvaadin-server Show documentation
Vaadin UI implementation for JVx
The newest version!
/*
 * Copyright 2014 SIB Visions GmbH
 * 
 * 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.
 *
 *
 * History
 *
 * 24.07.2018 - [HM] - creation
 */
package com.sibvisions.rad.ui.vaadin.ext.ui;

import jvx.rad.genui.UIFactoryManager;

import com.vaadin.event.FieldEvents.BlurEvent;
import com.vaadin.event.FieldEvents.BlurListener;
import com.vaadin.event.FieldEvents.BlurNotifier;
import com.vaadin.event.FieldEvents.FocusEvent;
import com.vaadin.event.FieldEvents.FocusListener;
import com.vaadin.event.FieldEvents.FocusNotifier;
import com.vaadin.shared.Registration;
import com.vaadin.shared.communication.FieldRpc.FocusAndBlurServerRpc;
import com.vaadin.ui.Grid;

/**
 * Extended Grid with focus events. 
 * 
 * @author Martin Handsteiner
 * @param  the grid bean type
 */
public class ExtendedGrid extends Grid implements FocusNotifier, BlurNotifier, Runnable
{
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Class members
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	
	/** InvokeLater is registered. */
	boolean invokeLater = false;
	
	/** The last event when invoke later is called. */
	protected boolean focus = false;

	/**
	 * Creates a new ExtendedTable.
	 */
	public ExtendedGrid()
	{
		super();
		
		registerRpc(new PropagatingFocusAndBlurServerRpc());
	}

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Interface implementation
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public Registration addBlurListener(BlurListener pBlurListener)
	{
        return addListener(BlurEvent.EVENT_ID, BlurEvent.class, pBlurListener, BlurListener.blurMethod);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public Registration addFocusListener(FocusListener pFocusListener)
	{
        return addListener(FocusEvent.EVENT_ID, FocusEvent.class, pFocusListener, FocusListener.focusMethod);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void run()
	{
		invokeLater = false;
		
		if (!focus)
		{
			fireEvent(new BlurEvent(this));
		}
	}

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// User-defined methods
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	
	/**
	 * Removes a blur listener.
	 * 
	 * @param pBlurListener the blur listener.
	 */
	@SuppressWarnings("deprecation")
	public void removeBlurListener(BlurListener pBlurListener)
	{
        removeListener(BlurEvent.EVENT_ID, BlurEvent.class, pBlurListener);
	}
	
	/**
	 * Removes a focus listener.
	 * 
	 * @param pFocusListener the focus listener.
	 */
	@SuppressWarnings("deprecation")
	public void removeFocusListener(FocusListener pFocusListener)
	{
        removeListener(FocusEvent.EVENT_ID, FocusEvent.class, pFocusListener);
	}
	
	/**
	 * Fires the blur event.
	 */
	protected void fireBlurEvent()
	{
		focus = false;
		if (!invokeLater)
		{
			invokeLater = true;
			UIFactoryManager.getFactory().invokeLater(this);
		}
	}
	
	/**
	 * Fires the focus event.
	 */
	protected void fireFocusEvent()
	{
		focus = true;
		if (!invokeLater)
		{
			invokeLater = true;
			UIFactoryManager.getFactory().invokeLater(this);
			
			fireEvent(new FocusEvent(this));
		}
	}

	/**
	 * Focus and Blur Rpc.
	 * 
	 * @author Robert Zenz
	 */
	private final class PropagatingFocusAndBlurServerRpc implements FocusAndBlurServerRpc
	{
		
		/**
		 * {@inheritDoc}
		 */
		@Override
		public void blur()
		{
			fireBlurEvent();
		}
		
		/**
		 * {@inheritDoc}
		 */
		@Override
		public void focus()
		{
			fireFocusEvent();
		}
		
	}
	
}