Implantación de un componente local

La instancia de componente la crea el objeto de fábrica de componentes.

La entrada del objeto de fábrica de componentes en el archivo de registro del componente es initData.componentFactory. Se trata de una referencia a un archivo JavaScript que utiliza RequireJS para cargar la fábrica de componentes. Esta debe devolver un objeto JavaScript que implante la interfaz de componentFactory.

El objeto de fábrica de componentes debe implantar la API customComponentFactory.createComponent(args), que crea cada instancia del componente.

args contiene los siguientes valores:

  • SitesSDK: SDK de Sites de Oracle Content Management.

  • id: identificador único (GUID) del componente agregado a la página.

  • viewMode: modo actual que está representando la página. Si se está editando una página, es "Editar". Si se está mostrando la vista previa de una página, es "Navegar". En tiempo de ejecución (es decir, cuando el sitio está publicado), el valor no está definido. Puede proporcionar implantaciones diferentes según la funcionalidad que debe mostrarse para cada modo. Por ejemplo, los enlaces no deben estar activos cuando se ejecuta la página en el modo Editar.

Nota:

No es un requisito utilizar JQuery ni Knockout para el componente, pero si desea aprovechar funciones de Oracle Content Management tales como los componentes anidados, debe utilizar la versión de Knockout que se proporciona con Oracle Content Management. Esta versión de Knockout ha ampliado el registro y los manejadores del componente, los cuales no estarían disponibles de otro modo.

En el propio componente, cuando este se instancia, se transfiere el SDK para que el componente pueda comunicarse con el ciclo de vida de la página. El componente debe implantar las funciones de ciclo de vida de la página, a las que llama Oracle Content Management para representar el componente en la página.

Se proporcionan API obligatorias y opcionales para implantar un componente.

API obligatorias

customComponent.render(container): pide al componente que se inserte en el elemento de contenedor DOM proporcionado.

  • container: elemento de contenedor DOM del código HTML del componente personalizado.

API opcionales

customComponent.dispose(): se llama cuando se elimina el componente de la página. Proporciona al componente la oportunidad de eliminar todos los recursos que ya no sean necesarios.