सीन डेकोरेटर की मदद से, आपके ऐप्लिकेशन की सीन स्ट्रेटजी से कैलकुलेट किए गए सीन में बदलाव किया जा सकता है. असल में, इनका इस्तेमाल NavDisplay से दिखाए जाने वाले कॉन्टेंट को बनाने के दूसरे चरण के लिए किया जाता है.
इस तरीके से, खास फ़ंक्शन को अलग-अलग सीन डेकोरेटर में शामिल किया जा सकता है. जैसे, सामान्य यूज़र इंटरफ़ेस (यूआई) कॉम्पोनेंट दिखाना.
उदाहरण के लिए, बेहतर ढंग से काम करने में मदद करने वाले किसी ऐप्लिकेशन में तीन टॉप-लेवल रूट हैं: ईमेल इनबॉक्स, डायरेक्ट मैसेज इनबॉक्स, और कैलेंडर व्यू. इस तरह का ऐप्लिकेशन, दो सीन डेकोरेटर का इस्तेमाल कर सकता है. पहला, टॉप ऐप्लिकेशन बार जोड़ने के लिए, जो मौजूदा टॉप-लेवल रूट की जानकारी और कंट्रोल दिखाता है. दूसरा, रूट के बीच नेविगेट करने के लिए, परसिस्टेंट नेविगेशन बार या रेल जोड़ने के लिए.
सीन डेकोरेटर रणनीति बनाना
सीन डेकोरेटर, सीन स्ट्रेटजी की तरह ही काम करते हैं. सीन डेकोरेटर को तय करने के लिए, SceneDecoratorStrategy इंटरफ़ेस लागू करें. इस इंटरफ़ेस में एक तरीका, decorateScene है. यह SceneStrategy इंटरफ़ेस के calculateScene तरीके से मिलता-जुलता है.
decorateScene यह तय करता है कि वह सीन को सजा सकता है या नहीं:
- अगर आपकी सीन डेकोरेटर स्ट्रेटजी को इनपुट सीन को डेकोरेट नहीं करना चाहिए, तो यह इनपुट सीन को पहले जैसा ही दिखाती है.
- अगर इसे इनपुट सीन को सजाना चाहिए, तो यह एक नया
Sceneदिखाता है. आम तौर पर, रिटर्न किया गया सीन, इनपुट सीन को पैरामीटर के तौर पर लेता है. साथ ही, अपनेcontentतरीके में इनपुट सीन केcontentतरीके को कॉल करता है.
इनपुट सीन को सजाया जाना चाहिए या नहीं और कैसे सजाया जाना चाहिए, यह तय करने के लिए सीन डेकोरेटर की रणनीति, इनपुट Scene और उस सीन में मौजूद एंट्री, दोनों के मेटाडेटा का इस्तेमाल कर सकती है.
class MySceneDecoratorStrategy<T : Any> : SceneDecoratorStrategy<T> { override fun SceneDecoratorStrategyScope<T>.decorateScene(scene: Scene<T>): Scene<T> { // `shouldDecorate` determines if the scene should be decorated based on scene.metadata, // scene.entries.metadata, or any other relevant state. return if (shouldDecorate(scene)) { MyDecoratingScene(scene) } else { scene } } } data class MyDecoratingScene<T : Any>( val scene: Scene<T> ) : Scene<T> { // ... override val content = @Composable { scene.content() } }
सीन डेकोरेटर रणनीतियों का इस्तेमाल करना
सीन डेकोरेटर की रणनीतियों का इस्तेमाल करने के लिए, उन्हें sceneDecoratorStrategies पैरामीटर का इस्तेमाल करके, अपने NavDisplay को दें. सीन को सजाते समय, NavDisplay हर रणनीति के decorateScene तरीके को एक के बाद एक कॉल करता है. साथ ही, हर कॉल के आउटपुट को अगले कॉल के इनपुट के तौर पर पास करता है.
NavDisplay( // ... sceneDecoratorStrategies = listOf(firstSceneDecoratorStrategy, secondSceneDecoratorStrategy) )
सीन डेकोरेटर के लिए सामान्य पैटर्न
सीन डेकोरेटर लागू करते समय, इन सामान्य पैटर्न के बारे में जानना ज़रूरी है:
प्रॉपर्टी कॉपी करना
ज़्यादातर मामलों में, किसी सीन को सजाने के बाद मिलने वाले सीन में वही एंट्री होनी चाहिए जो सजाए जा रहे सीन में मौजूद हैं. साथ ही, इसमें पिछली एंट्री भी वही होनी चाहिए जो सजाए जा रहे सीन में मौजूद हैं. इसके अलावा, यह उस सीन के मेटाडेटा को इनहेरिट (या उसमें बदलाव) कर सकता है जिसे यह सजा रहा है. इसके लिए, डिफ़ॉल्ट ऐक्शन और सेटिंग का इस्तेमाल करने की ज़रूरत नहीं है. यहां दिए गए कोड में, ऐसा करने का तरीका बताया गया है:
data class CopyingScene<T : Any>( val scene: Scene<T> ) : Scene<T> { override val entries = scene.entries override val previousEntries = scene.previousEntries override val metadata = scene.metadata // ... }
ऐनिमेशन बनाए रखना
एक डेस्टिनेशन से दूसरे डेस्टिनेशन पर जाने के लिए ऐनिमेशन का इस्तेमाल करना लेख में बताया गया है कि जब मौजूदा सीन की क्लास और उसकी key प्रॉपर्टी से मिली कुंजी में बदलाव होता है, तो NavDisplay सीन के बीच के ट्रांज़िशन को अपने-आप ऐनिमेट करता है.
अपने ऐप्लिकेशन में सीन डेकोरेटर को शामिल करते समय, सीन डेकोरेशन के बाद मिलने वाले सीन की क्लास एक जैसी रह सकती है. भले ही, सीन कैलकुलेशन के दौरान मिलने वाले सीन की क्लास बदल जाए. जब ऐसा होता है और
सजावट वाले सीन, सजाए जा रहे सीन के key को सीधे कॉपी करते हैं, तो
पहले से मौजूद ऐनिमेशन अब नहीं होते, क्योंकि डेरिव्ड की नहीं बदलती.
पहले से मौजूद ऐनिमेशन की सुविधा को बनाए रखने के लिए, डेकोरेटिंग सीन में क्लास से मिली कुंजी और calculateScene से मिले सीन के key का इस्तेमाल करना चाहिए.
data class DerivedKeyScene<T : Any>( val scene: Scene<T> ) : Scene<T> { override val key = scene::class to scene.key // ... }