Uygulama Programı Arabirimleri ile Özel Bölüm Yerleşimleri Geliştirme

Görüntüleme Uygulama Programı Arabirimlerini ve Düzenleme Uygulama Programı Arabirimlerini içeren Bölüm Yerleşim Uygulama Programı Arabirimi olan Oracle Content Management uygulamasında özel bölüm yerleşimleri geliştirebilirsiniz.

Başlangıç dosyaları için bkz. Bölüm Yerleşimi Oluşturma. Bölüm yerleşimleri için başlangıç dosyaları bölüm-yerleşim dosyalarının yapıları hakkında detaylar olan açıklamalar içerir.

Görüntüleme Uygulama Programı Arabirimleri

render.js modülünden yüklenen Görüntüleme Uygulama Programı Arabirimleri Site Oluşturucuda ve çalıştırma sırasında kullanılırlar.

Görüntüleme Uygulama Programı Arabirimi Açıklama Girdi Parametreleri Döndürülen Sonuç
(Yapılandırıcı) Bölüm Yerleşim görüntüleme modülünü başlatır.

Bir JavaScript nesnesi şu nitelikleri içerir:

  • sectionlayoutData (Nesne) : Sayfa modelinde bulunan bölüm yerleşimi verileri.

  • componentId (String): Bölüm yerleşiminin componentId değeri, genellikle global benzersiz tanımlayıcıdır.

  • renderMode (Dize, isteğe bağlı): Görüntüleme işlemi için görüntüleme modu.

  • customSettingsData (Nesne): sectionLayoutData içinde bulunan customSettingsData kopyası.

Bölüm Yerleşim Görüntüleme Uygulama Programı Arabirimleri başlatılır.
render

Bölüm yerleşimi için uygun Belge Nesne Modeli öğelerini alt bileşenler için kapsayıcı div'ler dahil olmak üzere sayfaya yayar.

container (Öğe) : Bölüm yerleşiminin biçimlendirmesinin görüntülenmesi gereken Belge Nesne Modeli öğesi.

Bu yöntem geri döndükten sonra, alt bileşenler görüntülenir.

Alt div[id] öğelerini bularak alt bileşenleri belirleyebilirsiniz.

addComponent

Alt bileşenleri bölüm yerleşimine dinamik olarak eklemek için içerik listesi bileşenleri ile kullanılır.

Bu fonksiyon isteğe bağlıdır.

container (Öğe): Yeni bileşenin görüntülenmesi gereken Belge Nesne Modeli öğesi.

componentId (Dize): Bölüm yerleşimine eklenecek yeni bileşen No'su.

Bu yöntem geri döndükten sonra, No'su componentId girişi ile eşleşen öğe görüntülenir.

Düzenleme Uygulama Programı Arabirimleri

edit.js modülü if şu durumda yüklenir: hasEditHandlers niteliği bölüm yerleşimi ile ilişkili appinfo.json dosyasında true olarak ayarlanmışsa.

Düzenleme Uygulama Programı Arabirimleri Site Oluşturucuda kullanılır.

Bu modüldeki tüm fonksiyonlar Yapılandırıcı dışında isteğe bağlıdır.

Düzenleme Uygulama Programı Arabirimi Açıklama Girdi Parametreleri Döndürülen Sonuç
(Yapılandırıcı) Bölüm Yerleşim düzenleme modülünü başlatır.

Bir JavaScript nesnesi şu niteliği içerir:

  • componentId (String): Bölüm yerleşiminin componentId değeri, genellikle global benzersiz tanımlayıcıdır.

Bölüm Yerleşim Düzenleme Uygulama Programı Arabirimleri başlatılır.

getCapabilities

Bölüm yerleşiminin düzenleme yeteneklerini açıklayan bir nesneyi döndürür.

Bölüm yerleşiminin düzenleme yeteneklerini açıklayan bir JavaScript nesnesi.

Girildikten sonra yetenek öndeğerleri fonksiyona sağlanır. Fonksiyon, Yetenekler nesnesini gerektiği şekilde değiştirebilir.

Yetenekler nesnesi şu yetenekleri içerebilir:

  • title (Dize): Kullanıcıya görüntülenecek bölüm yerleşiminin başlığı.

  • settingsTitle (Dize): Ayarlar Paneli iletişim kutusunda görüntülenecek başlık.

  • hasSettings (Mantıksal Değer): Bölüm yerleşiminin bir Ayarlar Panelini destekleyip desteklemediğini gösterir.

  • allowMove (Mantıksal Değer): Bölüm yerleşiminin alt öğelerin taşınmalarına izin verip vermediğini gösterir.

  • allowDelete (Mantıksal Değer): Bölüm yerleşiminin alt öğelerin silinmesine izin verip vermediğini gösterir.

  • isHidden (Mantıksal Değer): Bölüm yerleşiminin mevcut durumda kullanıcı seçeneklerine yanıt olarak gizlenip gizlenmediğini gösterir.

  • dropTarget (Mantıksal Değer): Bölüm yerleşiminin sürükle ve bırak işlemlerinin hedefi olup olmadığını gösterir.

  • customMenuOptions (Dizi): Bölüm Yerleşimi içerik menüsüne eklenecek özel menü seçenekleri. Her menu-options nesnesi şu nitelikleri içerir:

    • label (Dize) : Menü öğesinin görüntüleme metni.

    • action (Fonksiyon): Menü öğesi tıklandığında çağrılacak fonksiyon.

    • disabled (Mantıksal Değer): Menü öğesinin devre dışı bırakılmış durumda görüntülenip görüntülenmeyeceğini gösterir.

    • icon (Dize): Menü öğesindeki etiketin yanında görüntülenecek URL. (Bu nitelik ileride kullanmak üzere ayrılmıştır.)

    • checkmark (Mantıksal Değer): Menü öğesindeki etiketin yanında bir onay işaretinin görünüp görünmeyeceğini gösterir.

    • subMenuItems (Dizi): Alt menüde görüntülenecek menü seçenekleri.

(Nesne): Bölüm yerleşimine ilişkin yetenekler.

getCaptionContent

Kullanıcı Arayüzü öğelerinde görünecek bölüm yerleşiminin görünen adını döndürür.

Hiçbiri.

(Dize): Bölüm yerleşiminin görünen adı.

filterCapabilities

Menüler kullanıcıya görüntülenmeden önce bölüm yerleşiminin Yetenekler nesnesini değiştirmesini sağlar.

Bu Uygulama Programı Arabirimini kullanarak menü seçeneklerini ayarlayabilir veya kaldırabilirsiniz. (Ayrıca bkz. getCapabilities.)

Bölüm yerleşiminin düzenleme yeteneklerini açıklayan bir JavaScript nesnesi. Girişte, yetenek öndeğerleri fonksiyona sağlanır.

(Nesne) Bölüm yerleşimine ilişkin yetenekler.
onDragOver Sürüklenen öğenin bölüm yerleşimine bırakılabileceğini göstermek üzere bir Sürükle ve Bırak işlemi sırasında çağrılır.

eventObject (Olay Nesnesi): Sürükleme olayı hakkındaki bilgileri içeren bir olay nesnesi.

dataTransfer (VeriAktarım Nesnesi): Bölüm yerleşimine sürüklenen öğe hakkında bilgi saklayan DataTransfer nesnesi.

(Mantıksal Değer) Sürüklenen öğenin bölüm yerleşimi tarafından kabul edilip edilmeyeceğini gösteren değer.

Bölüm yerleşimi sürüklenen öğeyi kabul edebilirse doğru, aksi takdirde yanlış döndürür.

onDrop Sürüklenen öğenin bölüm yerleşimine yerleştirilmesi gerektiğini göstermek üzere bir Sürükle ve Bırak işleminin bırakma bölümünde çağrılır.

eventObject (Olay Nesnesi) : Bırakma olayı hakkında bilgileri içeren bir olay nesnesi.

dataTransfer (Veri Aktarım Nesnesi) Bölüm yerleşimine bırakılan öğe hakkında bilgi saklayan Veri Aktarım nesnesi.

(Mantıksal Değer) Bırakma işleminin bölüm yerleşimi tarafından idare edilip edilmediğini gösteren değer.

Doğru değerinin dönmesi mantık öndeğerini atlar.

onAddComponent Sürükle ve Bırak işleminin, bölüm yerleşiminde bir öğeyi taşıması ile ilgili olarak Bölüm Yerleşimini bilgilendirir.

eventObject (Olay Nesnesi): Sürükleme olayı hakkındaki bilgileri içeren bir olay nesnesi.

dataTransfer (Veri Aktarım Nesnesi): Bölüm yerleşimine bırakılan öğe hakkında bilgi saklayan Veri Aktarım nesnesi.

componentId (Dize): Yeni eklenen öğenin componentId değeri.

Bölüm yerleşimi bildirimi.
onMoveComponent

Sürükle ve Bırak işleminin, bölüm yerleşiminde bir öğeyi taşıması ile ilgili olarak bölüm yerleşimini bilgilendirir.

eventObject (Olay Nesnesi): Sürükleme olayı hakkındaki bilgileri içeren bir olay nesnesi.

dataTransfer (Veri Aktarım Nesnesi): Bölüm yerleşimine bırakılan öğe hakkında bilgi saklayan Veri Aktarım nesnesi.

componentId (Dize): Taşınan öğenin componentId değeri.

Bölüm yerleşimi bildirimi.
getSettingsData

Ayarlar Paneli görüntülenmeden önce bölüm yerleşiminin Ayarlar verisini değiştirmesini sağlar.

settingsData (Nesne): Bölüm Yerleşimi için hesaplanan ayarlar verisi öndeğeri

(Nesne) Bölüm yerleşimi için ayarlar verisi.
updateSettings

Ayarlar Paneli kapatıldıktan sonra, bölüm yerleşiminin ayarlarını değiştirmesini sağlar.

Bu Uygulama Programı Arabirimi, ayarlar sayfa modelinde saklanmadan hemen önce çağrılır.

parameters (Nesne): Ayarlar Panelinden dönen ham parametreler nesnesi.

sectionLayoutData (Nesne) : Saklanacak bölüm yerleşim verileri. Veri öndeğeri parameters (Object) nesnesinden oluşturulur ve fonksiyona bu parametrede iletilir.

(Nesne) Sayfa modelinde saklanacak bölüm yerleşim verileri.
elden çıkart

Düzenleme modülünün belleği boşaltmasını, olayları ayırmasını ve düzenleme idarecileri ile ilişkili kaynakları serbest bırakmasını sağlar.

Bu Uygulama Programı Arabirimi, Geri Alma/Yineleme işleminde olduğu gibi bölüm yerleşiminin tamamen yeniden çizilmesi gerektiğinde çağrılır.

Hiçbiri. Bölüm yerleşiminin yeniden çizilmesi etkin.