DisplayNameChangedViewEvent.java

/*
 * Copyright (c) 2011 Petter Holmström
 *
 * 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 com.github.peholmst.mvp4vaadin.events;

import com.github.peholmst.mvp4vaadin.View;
import com.github.peholmst.mvp4vaadin.ViewEvent;

/**
 * Event indicating that the display name of a view has changed.
 * 
 * @see View#getDisplayName()
 * 
 * @author Petter Holmström
 * @since 1.0
 */
public class DisplayNameChangedViewEvent extends ViewEvent {

	private static final long serialVersionUID = -3367822228239486408L;

	private final String oldDisplayName;
	private final String newDisplayName;

	/**
	 * Creates a new <code>DisplayNameChangedViewEvent</code>.
	 * 
	 * @param source
	 *            the view in which the event originally occurred (must not be
	 *            <code>null</code>).
	 * @param oldDisplayName
	 *            the old display name (may be <code>null</code>).
	 * @param newDisplayName
	 *            the new display name (may be <code>null</code>).
	 */
	public DisplayNameChangedViewEvent(View source, String oldDisplayName,
			String newDisplayName) {
		super(source);
		this.oldDisplayName = oldDisplayName;
		this.newDisplayName = newDisplayName;
	}

	/**
	 * Returns the old display name of the view.
	 */
	public String getOldDisplayName() {
		return oldDisplayName;
	}

	/**
	 * Returns the new display name of the view.
	 */
	public String getNewDisplayName() {
		return newDisplayName;
	}
}