com.adobe.xfa.HrefHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18598.20241113T125352Z-241000

/*
 * ADOBE CONFIDENTIAL
 *
 * Copyright 2005 Adobe Systems Incorporated All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property of
 * Adobe Systems Incorporated and its suppliers, if any. The intellectual and
 * technical concepts contained herein are proprietary to Adobe Systems
 * Incorporated and its suppliers and may be covered by U.S. and Foreign
 * Patents, patents in process, and are protected by trade secret or copyright
 * law. Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained from
 * Adobe Systems Incorporated.
 */
package com.adobe.xfa;


/**
 * This interface defines the services that handle href related actions in an XFA based form.
 */
public interface HrefHandler {

   /**
     * Resolves the usehref attribute in the given ProtoableNode and
     * loads the referenced document into a new AppModel.
	 * Any fragment identifier in the URL is ignored.
     * @param protoableNode a ProtoableNode with a usehref attribute.
     * @return the newly created AppModel containing the document loaded
     * from the referenced location, or null upon error.
     */
	public AppModel loadFragment(ProtoableNode protoableNode);
	
	/**
     * Resolves a URL and loads the reference XFA document into a new AppModel.
	 * Any fragment identifier in the URL is ignored.
     * @param appModel the AppModel containing the URL.
     * @param sUrl the URL that references the external XFA document
     * @return the newly created AppModel containing the document loaded
     * from the referenced location.
     */
	public AppModel loadFragment(AppModel appModel, String sUrl);

	/**
     * Gets the TemplateModel associated with the
	 * given AppModel.
     * @param appModel an AppModel
     * @return the TemplateModel from appModel 
     * or null if there is no TemplateModel.
     */
	public Model getDocument(AppModel appModel);
}