WindTheBusiness/com/yahoo/astra/layout/modes/IAdvancedLayoutMode.as
2020-10-20 00:58:15 +02:00

41 lines
1.3 KiB
ActionScript
Executable File

/*
Copyright (c) 2009 Yahoo! Inc. All rights reserved.
The copyrights embodied in the content of this file are licensed under the BSD (revised) open source license
*/
package com.yahoo.astra.layout.modes
{
import flash.display.DisplayObject;
/**
* Defines the methods required for layout modes that have
* advanced configuration settings for individual children.
*
* @author Josh Tynjala
*/
public interface IAdvancedLayoutMode extends ILayoutMode
{
/**
* Registers a specific display object with the layout algorithm. If certain
* settings need to be specified for individual display objects, they
* should be passed to the layout algorithm here.
*
* @param target The client to add
* @param configuration An optional set of name-value pairs for the client's configuration.
*/
function addClient(target:DisplayObject, configuration:Object = null):void;
/**
* Unregisters a specific display object from the layout algorithm.
*
* @param target The client to remove
*/
function removeClient(target:DisplayObject):void;
/**
* Returns true if a display object has been registered as a client.
*
* @param The display object that may be registered
*/
function hasClient(target:DisplayObject):Boolean;
}
}