패키지 | com.adobe.icomm.assetplacement.model |
클래스 | public class PackageDefinition |
상속 | PackageDefinition Object |
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package definition is divided into two broad sections: <controllers> and <assets>. The <controllers> section contains entries for each AssetPlacement component used in the statement: each PromoImage, PromoImageSlideShow, AttachmentLoader, etc. that is added to the statement will have a <controller> entry automatically added to the package definition file by the Interactive Document Plugin. The <controller> entries are meant to be used later in the statement development cycle, to help choose appropriate advertising content to place in each component.
The <assets> section is used at runtime. Each AssetPlacement component will attempt to load
assets at runtime. A component looks up the <resource> or <attachment> entry with the matching
controller
attribute to the components' id
attribute and if a match is found
attempts to load the source
specified.
It is possible to access the various assets of the package definition by calling the
appropriate methods; assets are divided into two types: attachments and resources. Attachments are
assets that are part of the PDF Navigator and must be accessed through Navigator APIs. Resources
are content that can be loaded directly such as images and SWFs. Generally, an asset is recovered
through its controller id. The controller id is the key that connects a Flex component (such
as a PromoImage) to a resource in the package definition. The component's id
property is the lookup key. Note that many assets may be returned for one ID lookup.
This class is a singleton. Calls to the constructor will result in an exception being thrown. In order to use this class, use the PackageDefinitionLoader class.
관련 API 요소
속성 | 정의 주체 | ||
---|---|---|---|
attachments : IList [읽기 전용]
A list that contains all of <attachment> entries in the package definition,
wrapped in Attachment objects. | PackageDefinition | ||
constructor : Object
지정된 객체 인스턴스의 클래스 객체 또는 생성자 함수에 대한 참조입니다. | Object | ||
controllers : IList [읽기 전용]
A list that contains all of <controllers> entries in the package definition,
wrapped in Controller objects. | PackageDefinition | ||
packageDefinitionFile : String [정적] [읽기 전용]
The file path of the package definition file that underlies this object. | PackageDefinition | ||
packageLoaded : Boolean [읽기 전용]
Check to see if the package is loaded. | PackageDefinition | ||
resources : IList [읽기 전용]
A list that contains all of the <resource> (non expired) entries in the package definition,
wrapped in Resource objects. | PackageDefinition |
메서드 | 정의 주체 | ||
---|---|---|---|
Creates a PackageDefinition object. | PackageDefinition | ||
Return a list that contains all of the expired <resource> entries in the package definition,
wrapped in Resource objects. | PackageDefinition | ||
A convenience method that searches through the attachments and returns a list
containing only the attachments that match the given id. | PackageDefinition | ||
A convenience method that searches through the contollers and returns the
controller with the matching id and XML namespace. | PackageDefinition | ||
A convenience method that searches through the resources and returns a list
containing only the resources that match the given id. | PackageDefinition | ||
The PackageDefinition version. | PackageDefinition | ||
지정된 속성이 객체에 정의되어 있는지 여부를 나타냅니다. | Object | ||
Object 클래스의 인스턴스가 매개 변수로 지정된 객체의 프로토타입 체인에 있는지 여부를 나타냅니다. | Object | ||
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
지정된 속성이 존재하고 열거 가능한지 여부를 나타냅니다. | Object | ||
루프 작업에서 동적 속성을 사용할 수 있는지 여부를 설정합니다. | Object | ||
로캘별 규칙에 따라 서식이 지정된 이 객체의 문자열 표현을 반환합니다. | Object | ||
지정된 객체의 문자열 표현을 반환합니다. | Object | ||
지정된 객체의 프리미티브 값을 반환합니다. | Object |
상수 | 정의 주체 | ||
---|---|---|---|
PACKAGE_VERSION_1_0 : Number = 1.0 [정적] The package version 1.0. | PackageDefinition | ||
PACKAGE_VERSION_2_0 : Number = 2.0 [정적] The package version 2.0. | PackageDefinition |
attachments | 속성 |
controllers | 속성 |
packageDefinitionFile | 속성 |
packageLoaded | 속성 |
resources | 속성 |
resources:IList
[읽기 전용] 언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
A list that contains all of the <resource> (non expired) entries in the package definition, wrapped in Resource objects.
구현
public function get resources():IList
관련 API 요소
PackageDefinition | () | 생성자 |
public function PackageDefinition()
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a PackageDefinition object. The PackageDefinition is meant to be a singleton object - there is only one package definition that wraps the XML package definition file. Callers should not invoke the constructor, which will throw an error. Rather, use the PackageDefinitionLoader class.
관련 API 요소
expiredResources | () | 메서드 |
public function expiredResources():IList
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
Return a list that contains all of the expired <resource> entries in the package definition, wrapped in Resource objects.
반환값IList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
관련 API 요소
getAttachmentsByControllerId | () | 메서드 |
public function getAttachmentsByControllerId(id:String):IList
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
A convenience method that searches through the attachments
and returns a list
containing only the attachments that match the given id
.
The id
is usually the id
property of a component such
as a PromoImage. The key it is looking up corresponds to the controller
attribute on the <attachment>'s parent <attachments> node.
매개 변수
id:String — The id of a component, such as a PromoImage.
|
IList — A list of Attachment objects who's controller ID match the given id.
|
관련 API 요소
getControllerById | () | 메서드 |
public function getControllerById(id:String, ns:String = null):Controller
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
A convenience method that searches through the contollers
and returns the
controller with the matching id
and XML namespace
.
매개 변수
id:String — The id of a controller. This id should match an MXML id in the project as
well as a controller id in the <assets> section of the package definition.
| |
ns:String (default = null ) — The XML namespace of a controller. If null the first controller with the matching the id will be returned.
|
Controller — The Controller object that matches this id and XML namespace or null if there is no matching controller.
|
관련 API 요소
getResourcesByControllerId | () | 메서드 |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
A convenience method that searches through the resources
and returns a list
containing only the resources that match the given id
. The caller indicates
whether to include expired resources via the includeExpired parameter.
The id
is usually the id
property of a component such
as a PromoImage. The key it is looking up corresponds to the controller
attribute on the <resource>'s parent <resources> node.
매개 변수
id:String — The id of a component, such as a PromoImage.
| |
includeExpired:Boolean (default = false ) — Boolean whether to include expired resources in the returned list.
|
IList — A list of Resource objects who's controller ID match the given id.
|
관련 API 요소
getVersion | () | 메서드 |
packageObjectReady | () | 메서드 |
public function packageObjectReady(packageObject:IPackageObject):void
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 9.5 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
Broadcast an IPackageObjectReadyEvent. When an IPackageObject is ready to be used, it asks the package definition to brodcast the PackageObjectReadyEvent. This allows the hosting application to be notified anytime a new statement object is created.
매개 변수
packageObject:IPackageObject — An IPackageObject that is loaded and ready to be used.
|
관련 API 요소
PACKAGE_VERSION_1_0 | 상수 |
public static const PACKAGE_VERSION_1_0:Number = 1.0
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 10 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 1.0.
PACKAGE_VERSION_2_0 | 상수 |
public static const PACKAGE_VERSION_2_0:Number = 2.0
언어 버전: | ActionScript 3.0 |
제품 버전: | Asset Placement Building Block 10 |
런타임 버전: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Tue Jun 12 2018, 03:17 PM Z