frameworks/projects/spark/src/spark/skins/IHighlightBitmapCaptureClient.as

////////////////////////////////////////////////////////////////////////////////
//
//  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 spark.skins
{
	

/**
 *  The IHighlightBitmapCaptureClient defines the interface for skins that support
 *  highlight bitmap capture.
 * 
 *  @langversion 3.0
 *  @playerversion Flash 10
 *  @playerversion AIR 2.5
 *  @productversion Flex 4.5
 */
public interface IHighlightBitmapCaptureClient
{
	/**
	 *  Called before a bitmap capture is made for this skin. 
	 * 
	 *  Return true if the skin needs to be updated before the bitmap is captured.
	 * 
	 *  @langversion 3.0
	 *  @playerversion Flash 10
	 *  @playerversion AIR 2.5
	 *  @productversion Flex 4.5
	 */
	function beginHighlightBitmapCapture():Boolean;
	
	/**
	 *  Called after a bitmap capture is made for this skin. 
	 * 
	 *  Return true if the skin needs to be updated.
	 * 
	 *  @langversion 3.0
	 *  @playerversion Flash 10
	 *  @playerversion AIR 2.5
	 *  @productversion Flex 4.5
	 */
	function endHighlightBitmapCapture():Boolean;
	
	/**
	 *  Validate the skin.
	 * 
	 *  @langversion 3.0
	 *  @playerversion Flash 10
	 *  @playerversion AIR 2.5
	 *  @productversion Flex 4.5
	 */
	function validateNow():void;
}
}