HasRuntimePlaceholder.java

/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2013 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 */

package com.servoy.j2db.ui.runtime;

import org.mozilla.javascript.annotations.JSGetter;
import org.mozilla.javascript.annotations.JSSetter;

import com.servoy.base.scripting.annotations.ServoyClientSupport;

/**
 * Interface for components with placeholder support.
 * 
 * @author lvostinar
 * 
 * @since 7.0
 *
 */
@ServoyClientSupport(mc = true, wc = true, sc = true)
public interface HasRuntimePlaceholder
{
	/**
	 * Gets or sets the placeholder text in a field.
	 *
	 * @sample
	 * //get the placeholder text
	 * var placeholderText = %%prefix%%%%elementName%%.placeholderText;
	 * //set another placeholder
	 * %%prefix%%%%elementName%%.placeholderText = 'Search..';
	 */
	@JSGetter
	public String getPlaceholderText();

	@JSSetter
	public void setPlaceholderText(String placeholder);
}