2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/controls/popup/popup-impl.h>
22 #include <cstring> // for strcmp
23 #include <dali/devel-api/adaptor-framework/physical-keyboard.h>
24 #include <dali/public-api/object/type-registry-helper.h>
25 #include <dali/integration-api/debug.h>
26 #include <dali/public-api/adaptor-framework/key.h>
27 #include <dali/public-api/animation/constraints.h>
28 #include <dali/public-api/common/stage.h>
29 #include <dali/public-api/events/key-event.h>
30 #include <dali/public-api/events/touch-data.h>
31 #include <dali/public-api/images/resource-image.h>
32 #include <dali/public-api/object/type-registry.h>
33 #include <dali/devel-api/scripting/scripting.h>
34 #include <dali/public-api/size-negotiation/relayout-container.h>
37 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h>
38 #include <dali-toolkit/public-api/controls/control-impl.h>
39 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
40 #include <dali-toolkit/public-api/accessibility-manager/accessibility-manager.h>
41 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h>
58 * Creation function for main Popup type.
59 * @return Handle to the new popup object.
63 return Toolkit::Popup::New();
66 // Toast style defaults.
67 const int DEFAULT_TOAST_AUTO_HIDE_DELAY = 3000; ///< Toast will auto-hide after 3000ms (3 seconds)
68 const float DEFAULT_TOAST_TRANSITION_TIME = 0.65f; ///< Default time the toast Popup will take to show and hide.
69 const Vector3 DEFAULT_TOAST_BOTTOM_PARENT_ORIGIN( 0.5f, 0.94f, 0.5f ); ///< This is similar to BOTTOM_CENTER, but vertically higher up, as a ratio of parent height.
70 const Vector3 DEFAULT_TOAST_WIDTH_OF_STAGE_RATIO( 0.75f, 0.75f, 0.75f ); ///< Amount of the stage's width that the toast popup will take up.
73 * Creation function for named type "popupToast".
74 * @return Handle to the new toast popup object.
76 BaseHandle CreateToast()
78 Toolkit::Popup popup = Toolkit::Popup::New();
80 // Setup for Toast Popup type.
81 popup.SetSizeModeFactor( DEFAULT_TOAST_WIDTH_OF_STAGE_RATIO );
82 popup.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::WIDTH );
83 popup.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
84 popup.SetProperty( Toolkit::Popup::Property::CONTEXTUAL_MODE, Toolkit::Popup::NON_CONTEXTUAL );
85 popup.SetProperty( Toolkit::Popup::Property::ANIMATION_DURATION, DEFAULT_TOAST_TRANSITION_TIME );
86 popup.SetProperty( Toolkit::Popup::Property::TAIL_VISIBILITY, false );
88 // Disable the dimmed backing.
89 popup.SetProperty( Toolkit::Popup::Property::BACKING_ENABLED, false );
91 // The toast popup should fade in (not zoom).
92 popup.SetProperty( Toolkit::Popup::Property::ANIMATION_MODE, Toolkit::Popup::FADE );
94 // The toast popup should auto-hide.
95 popup.SetProperty( Toolkit::Popup::Property::AUTO_HIDE_DELAY, DEFAULT_TOAST_AUTO_HIDE_DELAY );
97 // Align to the bottom of the screen.
98 popup.SetParentOrigin( DEFAULT_TOAST_BOTTOM_PARENT_ORIGIN );
99 popup.SetAnchorPoint( AnchorPoint::BOTTOM_CENTER );
101 // Let events pass through the toast popup.
102 popup.SetProperty( Toolkit::Popup::Property::TOUCH_TRANSPARENT, true );
107 // Setup properties, signals and actions using the type-registry.
108 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Popup, Toolkit::Control, Create )
110 // Main content related properties.
111 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "title", MAP, TITLE )
112 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "content", MAP, CONTENT )
113 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "footer", MAP, FOOTER )
114 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "displayState", STRING, DISPLAY_STATE )
115 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "touchTransparent", BOOLEAN, TOUCH_TRANSPARENT )
117 // Contextual related properties.
118 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "tailVisibility", BOOLEAN, TAIL_VISIBILITY )
119 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "tailPosition", VECTOR3, TAIL_POSITION )
120 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "contextualMode", STRING, CONTEXTUAL_MODE )
122 // Animation related properties.
123 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "animationDuration", FLOAT, ANIMATION_DURATION )
124 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "animationMode", STRING, ANIMATION_MODE )
125 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "entryAnimation", MAP, ENTRY_ANIMATION )
126 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "exitAnimation", MAP, EXIT_ANIMATION )
127 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "autoHideDelay", INTEGER, AUTO_HIDE_DELAY )
129 // Style related properties.
130 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "backingEnabled", BOOLEAN, BACKING_ENABLED )
131 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "backingColor", VECTOR4, BACKING_COLOR )
132 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "popupBackgroundImage", STRING, POPUP_BACKGROUND_IMAGE )
133 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "tailUpImage", STRING, TAIL_UP_IMAGE )
134 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "tailDownImage", STRING, TAIL_DOWN_IMAGE )
135 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "tailLeftImage", STRING, TAIL_LEFT_IMAGE )
136 DALI_PROPERTY_REGISTRATION( Toolkit, Popup, "tailRightImage", STRING, TAIL_RIGHT_IMAGE )
139 DALI_SIGNAL_REGISTRATION( Toolkit, Popup, "touchedOutside", SIGNAL_TOUCHED_OUTSIDE )
140 DALI_SIGNAL_REGISTRATION( Toolkit, Popup, "showing", SIGNAL_SHOWING )
141 DALI_SIGNAL_REGISTRATION( Toolkit, Popup, "shown", SIGNAL_SHOWN )
142 DALI_SIGNAL_REGISTRATION( Toolkit, Popup, "hiding", SIGNAL_HIDING )
143 DALI_SIGNAL_REGISTRATION( Toolkit, Popup, "hidden", SIGNAL_HIDDEN )
145 DALI_TYPE_REGISTRATION_END()
147 // Named type registration.
149 // Toast Popup: Non-modal popup that displays information at the bottom of the screen.
150 TypeRegistration typeRegistrationToast( "PopupToast", typeid( Toolkit::Popup ), CreateToast );
152 // Enumeration to / from string conversion tables
154 const Scripting::StringEnum DisplayStateTable[] = {
155 { "SHOWING", Toolkit::Popup::SHOWING },
156 { "SHOWN", Toolkit::Popup::SHOWN },
157 { "HIDING", Toolkit::Popup::HIDING },
158 { "HIDDEN", Toolkit::Popup::HIDDEN },
159 }; const unsigned int DisplayStateTableCount = sizeof( DisplayStateTable ) / sizeof( DisplayStateTable[0] );
161 const Scripting::StringEnum AnimationModeTable[] = {
162 { "NONE", Toolkit::Popup::NONE },
163 { "ZOOM", Toolkit::Popup::ZOOM },
164 { "FADE", Toolkit::Popup::FADE },
165 { "CUSTOM", Toolkit::Popup::CUSTOM },
166 }; const unsigned int AnimationModeTableCount = sizeof( AnimationModeTable ) / sizeof( AnimationModeTable[0] );
168 const Scripting::StringEnum ContextualModeTable[] = {
169 { "NON_CONTEXTUAL", Toolkit::Popup::NON_CONTEXTUAL },
170 { "ABOVE", Toolkit::Popup::ABOVE },
171 { "RIGHT", Toolkit::Popup::RIGHT },
172 { "BELOW", Toolkit::Popup::BELOW },
173 { "LEFT", Toolkit::Popup::LEFT },
174 }; const unsigned int ContextualModeTableCount = sizeof( ContextualModeTable ) / sizeof( ContextualModeTable[0] );
177 const Vector3 DEFAULT_POPUP_PARENT_RELATIVE_SIZE( 0.75f, 1.0f, 1.0f ); ///< Default size percentage of parent.
178 const float DEFAULT_POPUP_ANIMATION_DURATION = 0.6f; ///< Duration of hide/show animations.
179 const float POPUP_OUT_MARGIN_WIDTH = 16.f; ///< Space between the screen edge and the popup edge in the horizontal dimension.
180 const float POPUP_OUT_MARGIN_HEIGHT = 36.f; ///< Space between the screen edge and the popup edge in the vertical dimension.
181 const Vector3 DEFAULT_TAIL_POSITION( 0.5f, 1.0f, 0.0f ); ///< Position the tail will be displayed when enabled without setting the position.
183 // Contextual defaults.
184 const Vector2 DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN( 10.0f, 10.0f ); ///< How close the Popup will be to it's contextual parent.
185 const Vector2 DEFAULT_CONTEXTUAL_STAGE_BORDER( 15.0f, 15.0f ); ///< How close the Popup can be to the stage edges.
187 // Popup style defaults.
188 const char* DEFAULT_BACKGROUND_IMAGE_PATH = DALI_IMAGE_DIR "00_popup_bg.9.png"; ///< Background image.
189 const char* DEFAULT_TAIL_UP_IMAGE_PATH = DALI_IMAGE_DIR "popup_tail_up.png"; ///< Tail up image.
190 const char* DEFAULT_TAIL_DOWN_IMAGE_PATH = DALI_IMAGE_DIR "popup_tail_down.png"; ///< Tail down image.
191 const char* DEFAULT_TAIL_LEFT_IMAGE_PATH = DALI_IMAGE_DIR "popup_tail_left.png"; ///< Tail left image.
192 const char* DEFAULT_TAIL_RIGHT_IMAGE_PATH = DALI_IMAGE_DIR "popup_tail_right.png"; ///< Tail right image.
194 const Vector4 DEFAULT_BACKING_COLOR( 0.0f, 0.0f, 0.0f, 0.5f ); ///< Color of the dimmed backing.
195 const Vector3 BACKGROUND_OUTER_BORDER( 40.0f, 30.0f, 0.0f ); ///< External border.
196 const Rect<float> DEFAULT_TITLE_PADDING( 20.0f, 20.0f, 20.0f, 20.0f ); ///< Title padding used on popups with content and/or controls (from Tizen GUI UX).
197 const Rect<float> DEFAULT_TITLE_ONLY_PADDING( 8.0f, 8.0f, 8.0f, 8.0f ); ///< Title padding used on popups with a title only (like toast popups).
198 const Vector3 FOOTER_SIZE( 620.0f, 96.0f,0.0f ); ///< Default size of the bottom control area.
199 const float DEFAULT_RELATIVE_PARENT_WIDTH = 0.75f; ///< If width is not fixed, relative size to parent is used by default.
201 } // Unnamed namespace
207 Dali::Toolkit::Popup Popup::New()
209 // Create the implementation
210 PopupPtr popup( new Popup() );
212 // Pass ownership to CustomActor via derived handle.
213 Dali::Toolkit::Popup handle( *popup );
215 // Second-phase initialisation of the implementation.
216 // This can only be done after the CustomActor connection has been made.
223 : Control( ControlBehaviour( REQUIRES_STYLE_CHANGE_SIGNALS ) ),
224 mTouchedOutsideSignal(),
232 mPreviousFocusedActor(),
236 mAlterAddedChild( false ),
237 mLayoutDirty( true ),
239 mTouchTransparent( false ),
243 mDisplayState( Toolkit::Popup::HIDDEN ), // Hidden until shown with SetDisplayState()
244 mTailVisible( false ),
245 mTailPosition( DEFAULT_TAIL_POSITION ),
246 mContextualMode( Toolkit::Popup::NON_CONTEXTUAL ),
247 mAnimationDuration( DEFAULT_POPUP_ANIMATION_DURATION ),
248 mAnimationMode( Toolkit::Popup::FADE ),
249 mEntryAnimationData(),
250 mExitAnimationData(),
252 mBackingEnabled( true ),
253 mBackingColor( DEFAULT_BACKING_COLOR ),
254 mPopupBackgroundImage(),
255 mBackgroundOuterBorder(),
257 mTailUpImage( DEFAULT_TAIL_UP_IMAGE_PATH ),
258 mTailDownImage( DEFAULT_TAIL_DOWN_IMAGE_PATH ),
259 mTailLeftImage( DEFAULT_TAIL_LEFT_IMAGE_PATH ),
260 mTailRightImage( DEFAULT_TAIL_RIGHT_IMAGE_PATH )
262 SetKeyboardNavigationSupport( true );
265 void Popup::OnInitialize()
268 self.SetName( "popup" );
270 // Apply some default resizing rules.
271 self.SetParentOrigin( ParentOrigin::CENTER );
272 self.SetAnchorPoint( AnchorPoint::CENTER );
274 self.SetSizeModeFactor( DEFAULT_POPUP_PARENT_RELATIVE_SIZE );
275 self.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::WIDTH );
276 self.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
278 // Create a new layer so all Popup components can appear above all other actors.
279 mLayer = Layer::New();
280 mLayer.SetName( "popupLayer" );
282 mLayer.SetParentOrigin( ParentOrigin::CENTER );
283 mLayer.SetAnchorPoint( AnchorPoint::CENTER );
284 mLayer.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
286 // Important to set as invisible as otherwise, if the popup is parented,
287 // but not shown yet it will appear statically on the screen.
288 mLayer.SetVisible( false );
290 // Add the layer to the hierarchy.
293 // Add Backing (Dimmed effect).
294 mBacking = CreateBacking();
295 mLayer.Add( mBacking );
297 mPopupContainer = Actor::New();
298 mPopupContainer.SetName( "popupContainer" );
299 mPopupContainer.SetParentOrigin( ParentOrigin::CENTER );
300 mPopupContainer.SetAnchorPoint( AnchorPoint::CENTER );
301 mPopupContainer.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
302 mLayer.Add( mPopupContainer );
304 // Create the Popup layout to contain all main content.
305 mPopupLayout = Toolkit::TableView::New( 3, 1 );
307 // Adds the default background image.
308 SetPopupBackgroundImage( Toolkit::ImageView::New( ResourceImage::New( DEFAULT_BACKGROUND_IMAGE_PATH ) ) );
310 mPopupLayout.SetName( "popupLayoutTable" );
311 mPopupLayout.SetParentOrigin( ParentOrigin::CENTER );
312 mPopupLayout.SetAnchorPoint( AnchorPoint::CENTER );
314 mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::WIDTH );
315 mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
316 mPopupLayout.SetSize( Stage::GetCurrent().GetSize().x * DEFAULT_RELATIVE_PARENT_WIDTH, 0.0f );
318 mPopupLayout.SetFitHeight( 0 ); // Set row to fit.
319 mPopupLayout.SetFitHeight( 1 ); // Set row to fit.
321 mPopupLayout.TouchSignal().Connect( this, &Popup::OnDialogTouched );
323 mPopupContainer.Add( mPopupLayout );
325 // Any content after this point which is added to Self() will be re-parented to mContent.
326 mAlterAddedChild = true;
328 SetAsKeyboardFocusGroup( true );
333 mEntryAnimationData.Clear();
334 mExitAnimationData.Clear();
337 void Popup::LayoutAnimation()
339 // Perform setup based on the currently selected animation.
340 switch( mAnimationMode )
342 case Toolkit::Popup::ZOOM:
344 // Zoom animations start fully zoomed out.
345 mPopupContainer.SetScale( Vector3::ZERO );
349 case Toolkit::Popup::FADE:
351 // Fade animations start transparent.
352 mPopupContainer.SetOpacity( 0.0f );
356 case Toolkit::Popup::CUSTOM:
358 // Initialise the custom animation by playing to the end of it's exit animation instantly.
359 // EG. If it was zooming in, then we zoom out fully instantly so the zoom in works.
360 StartTransitionAnimation( false, true );
364 case Toolkit::Popup::NONE:
371 void Popup::StartTransitionAnimation( bool transitionIn, bool instantaneous /* false */ )
373 // Stop and recreate animation.
380 float duration = GetAnimationDuration();
382 // Setup variables ready to start the animations.
383 // If we are performing the animation instantaneously, we do not want to emit a signal.
388 // Setup variables and signal that we are starting the transition.
389 // Note: We signal even if the transition is instant so signal order is consistent.
390 mShowingSignal.Emit();
394 mHidingSignal.Emit();
398 // Perform chosen animation for the Popup.
399 switch( mAnimationMode )
401 case Toolkit::Popup::NONE:
403 mAnimation = Animation::New( 0.0f );
407 case Toolkit::Popup::ZOOM:
409 mAnimation = Animation::New( duration );
410 if( duration > Math::MACHINE_EPSILON_0 )
414 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::SCALE ), Vector3::ONE, AlphaFunction::EASE_IN_OUT, TimePeriod( duration * 0.25f, duration * 0.75f ) );
418 // Zoom out animation is twice the speed. Modify the duration variable so the backing animation speed is modified also.
420 mAnimation.SetDuration( duration );
421 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::SCALE ), Vector3::ZERO, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.0f, duration ) );
426 mPopupContainer.SetScale( transitionIn ? Vector3::ONE : Vector3::ZERO );
431 case Toolkit::Popup::FADE:
433 mAnimation = Animation::New( duration );
434 if( duration > Math::MACHINE_EPSILON_0 )
438 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::COLOR_ALPHA ), 1.0f, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.30f, duration * 0.70f ) );
442 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.0f, duration * 0.70f ) );
447 mPopupContainer.SetOpacity( transitionIn ? 1.0f : 0.0f );
452 case Toolkit::Popup::CUSTOM:
454 // Use a user specified animation for in and out.
455 // Read the correct animation depending on entry or exit.
456 // Attempt to use animation data defined from script data.
457 Dali::AnimationData* animationData = transitionIn ? &mEntryAnimationData : &mExitAnimationData;
459 // Create a new animation from the pre-defined data in the AnimationData class.
460 // If there is no data, mAnimation is invalidated.
461 mAnimation = animationData->CreateAnimation( mPopupContainer, duration );
463 // If we don't have a valid animation, provide a blank one so play() can still function generically.
466 // No animation was configured (even though custom mode was specified). Create a dummy animation to avoid an exception.
467 mAnimation = Animation::New( 0.0f );
474 // Animate the backing, if enabled.
475 // This is set up last so that different animation modes can have an effect on the backing animation speed.
476 if( mBackingEnabled )
478 // Use the alpha from the user-specified color.
479 float targetAlpha = mBackingColor.a;
480 if( duration > Math::MACHINE_EPSILON_0 )
484 mAnimation.AnimateTo( Property( mBacking, Actor::Property::COLOR_ALPHA ), targetAlpha, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.0f, duration * 0.70f ) );
488 mAnimation.AnimateTo( Property( mBacking, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.30f, duration * 0.70f ) );
493 mBacking.SetProperty( Actor::Property::COLOR_ALPHA, transitionIn ? targetAlpha : 0.0f );
497 // If we are performing the animation instantaneously, jump to the position directly and do not signal.
500 mAnimation.SetCurrentProgress( 1.0f );
503 else if( duration > Math::MACHINE_EPSILON_0 )
505 // Run the animation.
506 mAnimation.FinishedSignal().Connect( this, &Popup::OnDisplayChangeAnimationFinished );
511 // We did not use an animation to achive the transition.
512 // Trigger the state change directly.
513 DisplayStateChangeComplete();
517 void Popup::OnDisplayChangeAnimationFinished( Animation& source )
519 DisplayStateChangeComplete();
522 void Popup::DisplayStateChangeComplete()
524 // Remove contents from stage if completely hidden.
525 if( mDisplayState == Toolkit::Popup::HIDING )
527 mDisplayState = Toolkit::Popup::HIDDEN;
529 mLayer.SetVisible( false );
530 mPopupLayout.SetSensitive( false );
532 // Guard against destruction during signal emission.
533 Toolkit::Popup handle( GetOwner() );
534 mHiddenSignal.Emit();
536 else if( mDisplayState == Toolkit::Popup::SHOWING )
538 mDisplayState = Toolkit::Popup::SHOWN;
539 Toolkit::Popup handle( GetOwner() );
542 // Start a timer to auto-hide if enabled.
543 if( mAutoHideDelay > 0u )
545 mAutoHideTimer = Timer::New( mAutoHideDelay );
546 mAutoHideTimer.TickSignal().Connect( this, &Popup::OnAutoHideTimeReached );
547 mAutoHideTimer.Start();
552 bool Popup::OnAutoHideTimeReached()
554 // Display timer has expired, auto hide the popup exactly as if the user had clicked outside.
555 SetDisplayState( Toolkit::Popup::HIDDEN );
559 mAutoHideTimer.Stop();
560 mAutoHideTimer.TickSignal().Disconnect( this, &Popup::OnAutoHideTimeReached );
561 mAutoHideTimer.Reset();
566 void Popup::SetPopupBackgroundImage( Actor image )
568 // Removes any previous background.
569 if( mPopupBackgroundImage )
571 mPopupContainer.Remove( mPopupBackgroundImage );
574 // Adds new background to the dialog.
575 mPopupBackgroundImage = image;
576 mPopupBackgroundImage.SetName( "popupBackgroundImage" );
577 mPopupBackgroundImage.SetAnchorPoint( AnchorPoint::CENTER );
578 mPopupBackgroundImage.SetParentOrigin( ParentOrigin::CENTER );
580 // OnDialogTouched only consumes the event. It prevents the touch event to be caught by the backing.
581 mPopupBackgroundImage.TouchSignal().Connect( this, &Popup::OnDialogTouched );
583 // Set the popup border to be slightly larger than the layout contents.
584 mPopupBackgroundImage.SetResizePolicy( ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT, Dimension::ALL_DIMENSIONS );
585 mPopupBackgroundImage.SetSizeModeFactor( BACKGROUND_OUTER_BORDER );
587 const bool prevAlter = mAlterAddedChild;
588 mAlterAddedChild = false;
589 mPopupContainer.Add( mPopupBackgroundImage );
590 mAlterAddedChild = prevAlter;
595 Actor Popup::GetPopupBackgroundImage() const
597 return mPopupBackgroundImage;
600 void Popup::SetTitle( Actor titleActor )
602 // Replaces the current title actor.
610 mPopupLayout.RemoveChildAt( Toolkit::TableView::CellPosition( 0, 0) );
616 // Set up padding to give sensible default behaviour
617 // (an application developer can later override this if they wish).
618 mTitle.SetPadding( DEFAULT_TITLE_PADDING );
620 mPopupLayout.AddChild( mTitle, Toolkit::TableView::CellPosition( 0, 0 ) );
627 Actor Popup::GetTitle() const
632 void Popup::SetContent( Actor content )
634 // Remove previous content actor.
637 mPopupLayout.RemoveChildAt( Toolkit::TableView::CellPosition( 1, 0 ) );
639 // Keep a handle to the new content.
644 mContent.SetName( "popupContent" );
646 mPopupLayout.AddChild( mContent, Toolkit::TableView::CellPosition( 1, 0 ) );
653 Actor Popup::GetContent() const
658 void Popup::SetFooter( Actor footer )
660 // Remove previous content actor.
663 mPopupLayout.RemoveChildAt( Toolkit::TableView::CellPosition( 2, 0 ) );
666 // Keep a handle to the new content.
671 mFooter.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH );
673 // The control container has a fixed height.
674 mPopupLayout.SetFitHeight( 2u );
675 mPopupLayout.AddChild( footer, Toolkit::TableView::CellPosition( 2, 0 ) );
682 Actor Popup::GetFooter() const
687 void Popup::SetDisplayState( Toolkit::Popup::DisplayState displayState )
689 // Convert the 4-way state to a bool, true for show, false for hide.
690 bool display = ( displayState == Toolkit::Popup::SHOWING ) || ( displayState == Toolkit::Popup::SHOWN );
692 // Ignore if we are already at the target display state.
693 if( display == ( ( mDisplayState == Toolkit::Popup::SHOWING ) || ( mDisplayState == Toolkit::Popup::SHOWN ) ) )
698 // Convert the bool state to the actual display state to use.
699 mDisplayState = display ? Toolkit::Popup::SHOWING : Toolkit::Popup::HIDING;
703 // Update the state to indicate the current intent.
704 mDisplayState = Toolkit::Popup::SHOWING;
706 // We are displaying so bring the popup layer to the front, and set it visible so it is rendered.
708 mLayer.SetVisible( true );
710 // Set up the layout if this is the first display or the layout has become dirty.
713 // Bake-in any style and layout options to create the Popup layout.
717 // Allow the popup to catch events.
718 mPopupLayout.SetSensitive( true );
720 // Handle the keyboard focus when popup is shown.
721 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
722 if( keyboardFocusManager )
724 mPreviousFocusedActor = keyboardFocusManager.GetCurrentFocusActor();
726 if( Self().IsKeyboardFocusable() )
728 // Setup the actgor to start focus from.
730 if( mContent && mContent.IsKeyboardFocusable() )
732 // If the content is focusable, move the focus to the content.
733 focusActor = mContent;
735 else if( mFooter && mFooter.IsKeyboardFocusable() )
737 // If the footer is focusable, move the focus to the footer.
738 focusActor = mFooter;
742 DALI_LOG_WARNING( "There is no focusable in popup\n" );
748 keyboardFocusManager.SetCurrentFocusActor( focusActor );
755 mDisplayState = Toolkit::Popup::HIDING;
756 ClearKeyInputFocus();
758 // Restore the keyboard focus when popup is hidden.
759 if( mPreviousFocusedActor && mPreviousFocusedActor.IsKeyboardFocusable() )
761 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
762 if( keyboardFocusManager )
764 keyboardFocusManager.SetCurrentFocusActor( mPreviousFocusedActor );
769 // Perform animation.
770 StartTransitionAnimation( display );
773 Toolkit::Popup::DisplayState Popup::GetDisplayState() const
775 return mDisplayState;
778 void Popup::LayoutPopup()
780 mLayoutDirty = false;
782 /* When animating in, we want to respect the origin applied to Self().
783 * For example, if zooming, not only will the final result be anchored to the
784 * selected point, but the zoom will originate from this point also.
786 * EG: ParentOrigin::TOP_LEFT, AnchorPoint::TOP_LEFT :
795 mPopupContainer.SetParentOrigin( Self().GetCurrentParentOrigin() );
796 mPopupContainer.SetAnchorPoint( Self().GetCurrentAnchorPoint() );
798 // If there is only a title, use less padding.
801 if( !mContent && !mFooter )
803 mTitle.SetPadding( DEFAULT_TITLE_ONLY_PADDING );
807 mTitle.SetPadding( DEFAULT_TITLE_PADDING );
811 // Allow derived classes to perform any layout they may need to do.
814 // Update background visibility.
815 mPopupContainer.SetVisible( !( !mFooter && mPopupLayout.GetChildCount() == 0 ) );
817 // Create / destroy / position the tail as needed.
820 // Setup any layout and initialisation required for the selected animation.
826 void Popup::LayoutTail()
828 // Removes the tail actor.
829 if( mTailImage && mTailImage.GetParent() )
831 mTailImage.GetParent().Remove( mTailImage );
840 const Vector3& position = GetTailPosition();
843 // depending on position of tail around ParentOrigin, a different tail image is used...
844 if( position.y < Math::MACHINE_EPSILON_1 )
846 image = mTailUpImage;
848 else if( position.y > 1.0f - Math::MACHINE_EPSILON_1 )
850 image = mTailDownImage;
852 else if( position.x < Math::MACHINE_EPSILON_1 )
854 image = mTailLeftImage;
856 else if( position.x > 1.0f - Math::MACHINE_EPSILON_1 )
858 image = mTailRightImage;
863 // Adds the tail actor.
864 Image tail = ResourceImage::New( image );
865 mTailImage = Toolkit::ImageView::New( tail );
866 mTailImage.SetName( "tailImage" );
867 const Vector3 anchorPoint = AnchorPoint::BOTTOM_RIGHT - position;
868 mTailImage.SetParentOrigin( position );
869 mTailImage.SetAnchorPoint( anchorPoint );
871 mPopupContainer.Add( mTailImage );
875 void Popup::SetContextualMode( Toolkit::Popup::ContextualMode mode )
877 mContextualMode = mode;
881 Toolkit::Popup::ContextualMode Popup::GetContextualMode() const
883 return mContextualMode;
886 Toolkit::Control Popup::CreateBacking()
888 Toolkit::Control backing = Control::New();
889 backing.SetBackgroundColor( Vector4( mBackingColor.r, mBackingColor.g, mBackingColor.b, 1.0f ) );
890 backing.SetName( "popupBacking" );
892 // Must always be positioned top-left of stage, regardless of parent.
893 backing.SetInheritPosition(false);
894 backing.SetAnchorPoint( AnchorPoint::TOP_LEFT );
896 // Always the full size of the stage.
897 backing.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
898 backing.SetSize( Stage::GetCurrent().GetSize() );
901 backing.SetSensitive( true );
903 // Default to being transparent.
904 backing.SetProperty( Actor::Property::COLOR_ALPHA, 0.0f );
905 backing.TouchSignal().Connect( this, &Popup::OnBackingTouched );
906 backing.WheelEventSignal().Connect( this, &Popup::OnBackingWheelEvent );
910 Toolkit::Popup::TouchedOutsideSignalType& Popup::OutsideTouchedSignal()
912 return mTouchedOutsideSignal;
915 Toolkit::Popup::DisplayStateChangeSignalType& Popup::ShowingSignal()
917 return mShowingSignal;
920 Toolkit::Popup::DisplayStateChangeSignalType& Popup::ShownSignal()
925 Toolkit::Popup::DisplayStateChangeSignalType& Popup::HidingSignal()
927 return mHidingSignal;
930 Toolkit::Popup::DisplayStateChangeSignalType& Popup::HiddenSignal()
932 return mHiddenSignal;
935 void Popup::SetTailVisibility( bool visible )
937 mTailVisible = visible;
941 const bool Popup::IsTailVisible() const
946 void Popup::SetTailPosition( Vector3 position )
948 mTailPosition = position;
952 const Vector3& Popup::GetTailPosition() const
954 return mTailPosition;
957 void Popup::SetAnimationDuration( float duration )
959 mAnimationDuration = duration;
963 float Popup::GetAnimationDuration() const
965 return mAnimationDuration;
968 void Popup::SetAnimationMode( Toolkit::Popup::AnimationMode animationMode )
970 mAnimationMode = animationMode;
974 Toolkit::Popup::AnimationMode Popup::GetAnimationMode() const
976 return mAnimationMode;
979 void Popup::SetEntryAnimationData( const Property::Map& map )
981 mEntryAnimationData.Clear();
982 Scripting::NewAnimation( map, mEntryAnimationData );
985 void Popup::SetExitAnimationData( const Property::Map& map )
987 mExitAnimationData.Clear();
988 Scripting::NewAnimation( map, mExitAnimationData );
991 void Popup::SetAutoHideDelay( int delay )
993 mAutoHideDelay = delay;
996 int Popup::GetAutoHideDelay() const
998 return mAutoHideDelay;
1001 void Popup::SetBackingEnabled( bool enabled )
1003 mBackingEnabled = enabled;
1004 mLayoutDirty = true;
1007 const bool Popup::IsBackingEnabled() const
1009 return mBackingEnabled;
1012 void Popup::SetBackingColor( Vector4 color )
1014 mBackingColor = color;
1015 mBacking.SetBackgroundColor( Vector4( color.r, color.g, color.b, 1.0f ) );
1016 mLayoutDirty = true;
1019 const Vector4& Popup::GetBackingColor() const
1021 return mBackingColor;
1024 void Popup::SetTailUpImage( std::string image )
1026 mTailUpImage = image;
1027 mLayoutDirty = true;
1030 const std::string& Popup::GetTailUpImage() const
1032 return mTailUpImage;
1035 void Popup::SetTailDownImage( std::string image )
1037 mTailDownImage = image;
1038 mLayoutDirty = true;
1041 const std::string& Popup::GetTailDownImage() const
1043 return mTailDownImage;
1046 void Popup::SetTailLeftImage( std::string image )
1048 mTailLeftImage = image;
1049 mLayoutDirty = true;
1052 const std::string& Popup::GetTailLeftImage() const
1054 return mTailLeftImage;
1057 void Popup::SetTailRightImage( std::string image )
1059 mTailRightImage = image;
1060 mLayoutDirty = true;
1063 const std::string& Popup::GetTailRightImage() const
1065 return mTailRightImage;
1068 void Popup::SetTouchTransparent( bool enabled )
1070 mTouchTransparent = enabled;
1073 const bool Popup::IsTouchTransparent() const
1075 return mTouchTransparent;
1078 void Popup::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
1080 Toolkit::Popup popup = Toolkit::Popup::DownCast( Dali::BaseHandle( object ) );
1084 Popup& popupImpl( GetImpl( popup ) );
1086 switch ( propertyIndex )
1088 case Toolkit::Popup::Property::TITLE:
1090 Property::Map valueMap;
1091 if( value.Get( valueMap ) )
1093 popupImpl.SetTitle( Scripting::NewActor( valueMap ) );
1097 case Toolkit::Popup::Property::CONTENT:
1099 Property::Map valueMap;
1100 if( value.Get( valueMap ) )
1102 popupImpl.SetContent( Scripting::NewActor( valueMap ) );
1106 case Toolkit::Popup::Property::FOOTER:
1108 Property::Map valueMap;
1109 if( value.Get( valueMap ) )
1111 popupImpl.SetFooter( Scripting::NewActor( valueMap ) );
1115 case Toolkit::Popup::Property::DISPLAY_STATE:
1117 std::string valueString;
1118 if( value.Get( valueString ) )
1120 Toolkit::Popup::DisplayState displayState( Toolkit::Popup::HIDDEN );
1121 if( Scripting::GetEnumeration< Toolkit::Popup::DisplayState >( valueString.c_str(), DisplayStateTable, DisplayStateTableCount, displayState ) )
1123 popupImpl.SetDisplayState( displayState );
1128 case Toolkit::Popup::Property::TOUCH_TRANSPARENT:
1131 if( value.Get( valueBool ) )
1133 popupImpl.SetTouchTransparent( valueBool );
1137 case Toolkit::Popup::Property::TAIL_VISIBILITY:
1140 if( value.Get( valueBool ) )
1142 popupImpl.SetTailVisibility( valueBool );
1146 case Toolkit::Popup::Property::TAIL_POSITION:
1148 Vector3 valueVector3;
1149 if( value.Get( valueVector3 ) )
1151 popupImpl.SetTailPosition( valueVector3 );
1155 case Toolkit::Popup::Property::CONTEXTUAL_MODE:
1157 std::string valueString;
1158 if( value.Get( valueString ) )
1160 Toolkit::Popup::ContextualMode contextualMode( Toolkit::Popup::BELOW );
1161 if( Scripting::GetEnumeration< Toolkit::Popup::ContextualMode >( valueString.c_str(), ContextualModeTable, ContextualModeTableCount, contextualMode ) )
1163 popupImpl.SetContextualMode( contextualMode );
1168 case Toolkit::Popup::Property::ANIMATION_DURATION:
1171 if( value.Get( valueFloat ) )
1173 popupImpl.SetAnimationDuration( valueFloat );
1177 case Toolkit::Popup::Property::ANIMATION_MODE:
1179 std::string valueString;
1180 if( value.Get( valueString ) )
1182 Toolkit::Popup::AnimationMode animationMode( Toolkit::Popup::FADE );
1183 if( Scripting::GetEnumeration< Toolkit::Popup::AnimationMode >( valueString.c_str(), AnimationModeTable, AnimationModeTableCount, animationMode ) )
1185 popupImpl.SetAnimationMode( animationMode );
1190 case Toolkit::Popup::Property::ENTRY_ANIMATION:
1192 Property::Map valueMap;
1193 if( value.Get( valueMap ) )
1195 popupImpl.SetEntryAnimationData( valueMap );
1199 case Toolkit::Popup::Property::EXIT_ANIMATION:
1201 Property::Map valueMap;
1202 if( value.Get( valueMap ) )
1204 popupImpl.SetExitAnimationData( valueMap );
1208 case Toolkit::Popup::Property::AUTO_HIDE_DELAY:
1211 if( value.Get( valueInt ) )
1213 popupImpl.SetAutoHideDelay( valueInt );
1217 case Toolkit::Popup::Property::BACKING_ENABLED:
1220 if( value.Get( valueBool ) )
1222 popupImpl.SetBackingEnabled( valueBool );
1226 case Toolkit::Popup::Property::BACKING_COLOR:
1228 Vector4 valueVector4;
1229 if( value.Get( valueVector4 ) )
1231 popupImpl.SetBackingColor( valueVector4 );
1235 case Toolkit::Popup::Property::POPUP_BACKGROUND_IMAGE:
1237 std::string valueString;
1238 if( value.Get( valueString ) )
1240 Image image = ResourceImage::New( valueString );
1243 Toolkit::ImageView actor = Toolkit::ImageView::New( image );
1244 popupImpl.SetPopupBackgroundImage( actor );
1249 case Toolkit::Popup::Property::TAIL_UP_IMAGE:
1251 std::string valueString;
1252 if( value.Get( valueString ) )
1254 popupImpl.SetTailUpImage( valueString );
1258 case Toolkit::Popup::Property::TAIL_DOWN_IMAGE:
1260 std::string valueString;
1261 if( value.Get( valueString ) )
1263 popupImpl.SetTailDownImage( valueString );
1267 case Toolkit::Popup::Property::TAIL_LEFT_IMAGE:
1269 std::string valueString;
1270 if( value.Get( valueString ) )
1272 popupImpl.SetTailLeftImage( valueString );
1276 case Toolkit::Popup::Property::TAIL_RIGHT_IMAGE:
1278 std::string valueString;
1279 if( value.Get( valueString ) )
1281 popupImpl.SetTailRightImage( valueString );
1289 Property::Value Popup::GetProperty( BaseObject* object, Property::Index propertyIndex )
1291 Property::Value value;
1293 Toolkit::Popup popup = Toolkit::Popup::DownCast( Dali::BaseHandle( object ) );
1297 Popup& popupImpl( GetImpl( popup ) );
1299 switch ( propertyIndex )
1301 case Toolkit::Popup::Property::TITLE:
1304 Scripting::CreatePropertyMap( popupImpl.GetTitle(), map );
1308 case Toolkit::Popup::Property::CONTENT:
1311 Scripting::CreatePropertyMap( popupImpl.GetContent(), map );
1315 case Toolkit::Popup::Property::FOOTER:
1318 Scripting::CreatePropertyMap( popupImpl.GetFooter(), map );
1322 case Toolkit::Popup::Property::DISPLAY_STATE:
1324 value = Scripting::GetLinearEnumerationName< Toolkit::Popup::DisplayState >( popupImpl.GetDisplayState(), DisplayStateTable, DisplayStateTableCount );
1327 case Toolkit::Popup::Property::TOUCH_TRANSPARENT:
1329 value = popupImpl.IsTouchTransparent();
1332 case Toolkit::Popup::Property::TAIL_VISIBILITY:
1334 value = popupImpl.IsTailVisible();
1337 case Toolkit::Popup::Property::TAIL_POSITION:
1339 value = popupImpl.GetTailPosition();
1342 case Toolkit::Popup::Property::CONTEXTUAL_MODE:
1344 value = Scripting::GetLinearEnumerationName< Toolkit::Popup::ContextualMode >( popupImpl.GetContextualMode(), ContextualModeTable, ContextualModeTableCount );
1347 case Toolkit::Popup::Property::ANIMATION_DURATION:
1349 value = popupImpl.GetAnimationDuration();
1352 case Toolkit::Popup::Property::ANIMATION_MODE:
1354 value = Scripting::GetLinearEnumerationName< Toolkit::Popup::AnimationMode >( popupImpl.GetAnimationMode(), AnimationModeTable, AnimationModeTableCount );
1357 case Toolkit::Popup::Property::ENTRY_ANIMATION:
1359 // Note: Cannot retrieve property map from animation.
1364 case Toolkit::Popup::Property::EXIT_ANIMATION:
1366 // Note: Cannot retrieve property map from animation.
1371 case Toolkit::Popup::Property::AUTO_HIDE_DELAY:
1373 value = popupImpl.GetAutoHideDelay();
1376 case Toolkit::Popup::Property::BACKING_ENABLED:
1378 value = popupImpl.IsBackingEnabled();
1381 case Toolkit::Popup::Property::BACKING_COLOR:
1383 value = popupImpl.GetBackingColor();
1386 case Toolkit::Popup::Property::POPUP_BACKGROUND_IMAGE:
1388 ResourceImage image = ResourceImage::DownCast( popupImpl.GetPopupBackgroundImage() );
1391 value = image.GetUrl();
1395 case Toolkit::Popup::Property::TAIL_UP_IMAGE:
1397 value = popupImpl.GetTailUpImage();
1400 case Toolkit::Popup::Property::TAIL_DOWN_IMAGE:
1402 value = popupImpl.GetTailDownImage();
1405 case Toolkit::Popup::Property::TAIL_LEFT_IMAGE:
1407 value = popupImpl.GetTailLeftImage();
1410 case Toolkit::Popup::Property::TAIL_RIGHT_IMAGE:
1412 value = popupImpl.GetTailRightImage();
1421 bool Popup::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
1423 Dali::BaseHandle handle( object );
1425 bool connected( true );
1426 Toolkit::Popup popup = Toolkit::Popup::DownCast( handle );
1428 if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCHED_OUTSIDE ) )
1430 popup.OutsideTouchedSignal().Connect( tracker, functor );
1432 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SHOWING ) )
1434 popup.ShowingSignal().Connect( tracker, functor );
1436 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SHOWN ) )
1438 popup.ShownSignal().Connect( tracker, functor );
1440 else if( 0 == strcmp( signalName.c_str(), SIGNAL_HIDING ) )
1442 popup.HidingSignal().Connect( tracker, functor );
1444 else if( 0 == strcmp( signalName.c_str(), SIGNAL_HIDDEN ) )
1446 popup.HiddenSignal().Connect( tracker, functor );
1450 // signalName does not match any signal
1457 bool Popup::OnBackingTouched( Actor actor, const TouchData& touch )
1459 // Allow events to pass through if touch transparency is enabled.
1460 if( mTouchTransparent )
1465 if( touch.GetPointCount() > 0 )
1467 if( touch.GetState( 0 ) == PointState::DOWN )
1469 // Guard against destruction during signal emission.
1470 Toolkit::Popup handle( GetOwner() );
1472 mTouchedOutsideSignal.Emit();
1476 // Block anything behind backing becoming touched.
1477 mLayer.SetTouchConsumed( true );
1481 bool Popup::OnBackingWheelEvent( Actor actor, const WheelEvent& event )
1483 // Allow events to pass through if touch transparency is enabled.
1484 if( mTouchTransparent )
1489 // Consume wheel event in dimmed backing actor.
1490 mLayer.SetTouchConsumed( true );
1494 bool Popup::OnDialogTouched( Actor actor, const TouchData& touch )
1496 // Allow events to pass through if touch transparency is enabled.
1497 if( mTouchTransparent )
1502 // Consume event (stops backing actor receiving touch events)
1503 mLayer.SetTouchConsumed( true );
1507 void Popup::OnStageConnection( int depth )
1509 Control::OnStageConnection( depth );
1511 mLayoutDirty = true;
1515 void Popup::OnChildAdd( Actor& child )
1517 Control::OnChildAdd( child );
1519 // Re-parent any children added by user to the body layer.
1520 if( mAlterAddedChild )
1522 SetContent( child );
1526 mLayoutDirty = true;
1531 void Popup::LayoutContext( const Vector2& size )
1533 // Do nothing if not in a contextual mode (or there is no parent context).
1534 Actor self = Self();
1535 Actor parent = self.GetParent();
1536 if( ( mContextualMode == Toolkit::Popup::NON_CONTEXTUAL ) || !parent )
1541 mPopupContainer.SetParentOrigin( ParentOrigin::CENTER );
1542 // We always anchor to the CENTER, rather than a different anchor point for each contextual
1543 // mode to allow code-reuse of the bound checking code (for maintainability).
1544 mPopupContainer.SetAnchorPoint( AnchorPoint::CENTER );
1546 // Setup with some pre-calculations for speed.
1547 Vector3 halfStageSize( Stage().GetCurrent().GetSize() / 2.0f );
1548 Vector3 parentPosition( parent.GetCurrentPosition() );
1549 Vector2 halfSize( size / 2.0f );
1550 Vector2 halfParentSize( parent.GetRelayoutSize( Dimension::WIDTH ) / 2.0f, parent.GetRelayoutSize( Dimension::HEIGHT ) / 2.0f );
1551 Vector3 newPosition( Vector3::ZERO );
1553 // Perform different positioning based on the specified contextual layout mode.
1554 switch( mContextualMode )
1556 case Toolkit::Popup::BELOW:
1558 newPosition.x += halfSize.x - halfParentSize.x;
1559 newPosition.y += halfSize.y + halfParentSize.y + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.y;
1562 case Toolkit::Popup::ABOVE:
1564 newPosition.x += halfSize.x - halfParentSize.x;
1565 newPosition.y -= halfSize.y + halfParentSize.y + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.y;
1568 case Toolkit::Popup::RIGHT:
1570 newPosition.x += halfSize.x + halfParentSize.x + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.x;
1571 newPosition.y += halfSize.y - halfParentSize.y;
1574 case Toolkit::Popup::LEFT:
1576 newPosition.x -= halfSize.x + halfParentSize.x + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.x;
1577 newPosition.y += halfSize.y - halfParentSize.y;
1580 case Toolkit::Popup::NON_CONTEXTUAL:
1582 // Code won't reach here (caught earlier).
1587 // On-screen position checking.
1588 // Check new position is not too far right. If so, correct it.
1589 // Note: Check for right rather than left first, so if popup is too wide, the left check overrides
1590 // the right check and we at least see the left portion of the popup (as this is more useful).
1591 if( newPosition.x >= ( halfStageSize.x - parentPosition.x - halfSize.x - DEFAULT_CONTEXTUAL_STAGE_BORDER.x ) )
1593 newPosition.x = halfStageSize.x - parentPosition.x - halfSize.x - DEFAULT_CONTEXTUAL_STAGE_BORDER.x;
1595 // Check new position is not too far left. If so, correct it.
1596 if( newPosition.x < halfSize.x - ( parentPosition.x + halfStageSize.x ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.x )
1598 newPosition.x = halfSize.x - ( parentPosition.x + halfStageSize.x ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.x;// - parentSize.x;
1600 // Check new position is not too far down. If so, correct it.
1601 if( newPosition.y >= ( halfStageSize.y - parentPosition.y - halfSize.y - DEFAULT_CONTEXTUAL_STAGE_BORDER.y ) )
1603 newPosition.y = halfStageSize.y - parentPosition.y - halfSize.y - DEFAULT_CONTEXTUAL_STAGE_BORDER.y;
1605 // Check new position is not too far up. If so, correct it.
1606 if( newPosition.y < halfSize.y - ( parentPosition.y + halfStageSize.y ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.y )
1608 newPosition.y = halfSize.y - ( parentPosition.y + halfStageSize.y ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.y;
1611 // Set the final position.
1612 mPopupContainer.SetPosition( newPosition );
1615 void Popup::OnRelayout( const Vector2& size, RelayoutContainer& container )
1617 Vector2 useSize( size );
1619 // Use the Popup layouts size, unless requested to use a fixed size.
1620 // In which case take the size set for the Popup itself.
1621 ResizePolicy::Type widthPolicy = Self().GetResizePolicy( Dimension::WIDTH );
1622 ResizePolicy::Type heightPolicy = Self().GetResizePolicy( Dimension::HEIGHT );
1624 // Width calculations:
1625 if( widthPolicy == ResizePolicy::USE_NATURAL_SIZE || widthPolicy == ResizePolicy::FIT_TO_CHILDREN )
1627 // If we using a child-based policy, take the size from the popup layout.
1628 mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::WIDTH );
1629 useSize.width = mPopupLayout.GetRelayoutSize( Dimension::WIDTH );
1631 mPopupLayout.SetFitWidth( 0u );
1635 // If we using a parent-based policy, take the size from the popup object itself (self).
1636 mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::WIDTH );
1638 mPopupLayout.SetFixedWidth( 0u, useSize.width );
1641 // Height calculations:
1642 // Title: Let the title be as high as it needs to be.
1643 mPopupLayout.SetFitHeight( 0u );
1645 // Footer: Convert the footer's resize policy to a TableView row policy.
1648 ResizePolicy::Type footerHeightPolicy = mFooter.GetResizePolicy( Dimension::HEIGHT );
1649 if( ( footerHeightPolicy == ResizePolicy::USE_NATURAL_SIZE ) ||
1650 ( footerHeightPolicy == ResizePolicy::FIT_TO_CHILDREN ) )
1652 mPopupLayout.SetFitHeight( 2u );
1654 else if( footerHeightPolicy == ResizePolicy::FIXED )
1656 mPopupLayout.SetFixedHeight( 2u, mFooter.GetRelayoutSize( Dimension::HEIGHT) );
1660 mPopupLayout.SetRelativeHeight( 2u, 1.0f );
1665 mPopupLayout.SetFixedHeight( 2u, 0.0f );
1668 // Popup contents: Adjust the tableview's policies based on the popup's policies.
1669 if( heightPolicy == ResizePolicy::USE_NATURAL_SIZE || heightPolicy == ResizePolicy::FIT_TO_CHILDREN )
1671 mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
1673 // Let both the contents expand as necessary.
1674 mPopupLayout.SetFitHeight( 1u );
1675 useSize.height = mPopupLayout.GetRelayoutSize( Dimension::HEIGHT );
1679 mPopupLayout.SetResizePolicy( heightPolicy, Dimension::HEIGHT );
1681 // Let the content expand to fill the remaining space.
1682 mPopupLayout.SetRelativeHeight( 1u, 1.0f );
1683 mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::HEIGHT );
1686 // Relayout the popup-layout to give it it's new size this frame.
1687 container.Add( mPopupLayout, useSize );
1691 container.Add( mContent, Vector2( mContent.GetRelayoutSize( Dimension::WIDTH ), mContent.GetRelayoutSize( Dimension::HEIGHT ) ) );
1694 // Perform contextual layout setup if required.
1695 // This is done each time in case the parent moves.
1696 // This will have no effect if no contextual mode is selected.
1697 LayoutContext( useSize );
1700 void Popup::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
1702 // To get the popup to emulate fit-to-children, we need to actually set use-natural-size.
1703 if( ( dimension & Dimension::HEIGHT ) && ( policy == ResizePolicy::FIT_TO_CHILDREN ) )
1705 Self().SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
1708 mLayoutDirty = true;
1712 Vector3 Popup::GetNaturalSize()
1714 return mPopupLayout.GetNaturalSize();
1717 float Popup::GetHeightForWidth( float width )
1719 return mPopupLayout.GetHeightForWidth( width );
1722 float Popup::GetWidthForHeight( float height )
1724 return mPopupLayout.GetWidthForHeight( height );
1727 bool Popup::OnKeyEvent( const KeyEvent& event )
1729 // Allow events to pass through if touch transparency is enabled.
1730 if( mTouchTransparent )
1735 bool consumed = false;
1737 if( event.state == KeyEvent::Down )
1739 if (event.keyCode == Dali::DALI_KEY_ESCAPE || event.keyCode == Dali::DALI_KEY_BACK)
1741 SetDisplayState( Toolkit::Popup::HIDDEN );
1749 void Popup::AddFocusableChildrenRecursive( Actor parent, std::vector< Actor >& focusableActors )
1753 Toolkit::Control control = Toolkit::Control::DownCast( parent );
1754 bool layoutControl = control && GetImplementation( control ).IsKeyboardNavigationSupported();
1756 if( parent.IsKeyboardFocusable() || layoutControl )
1758 focusableActors.push_back( parent );
1760 if( !layoutControl )
1762 for( unsigned int i = 0, numberChildren = parent.GetChildCount(); i < numberChildren; ++i )
1764 Actor child( parent.GetChildAt( i ) );
1765 AddFocusableChildrenRecursive( child, focusableActors );
1772 void Popup::AddFocusableChildren( Actor parent, std::vector< Actor >& focusableActors )
1776 Toolkit::Control control = Toolkit::Control::DownCast( parent );
1777 if( !GetImplementation( control ).IsKeyboardNavigationSupported() )
1779 for( unsigned int i = 0, numberChildren = parent.GetChildCount(); i < numberChildren; ++i )
1781 Actor child( parent.GetChildAt( i ) );
1782 AddFocusableChildrenRecursive( child, focusableActors );
1787 focusableActors.push_back( parent );
1792 Actor Popup::GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled )
1794 std::string currentStr;
1795 if( currentFocusedActor )
1797 currentStr = currentFocusedActor.GetName();
1800 Actor nextFocusableActor( currentFocusedActor );
1801 Actor currentFocusGroup;
1802 if( currentFocusedActor )
1804 currentFocusGroup = KeyboardFocusManager::Get().GetFocusGroup( currentFocusedActor );
1807 // TODO: Needs to be optimised
1808 // The following statement checks that if we have a current focused actor, then the current focus group is not the popup content or footer.
1809 // This is to detect if the focus is currently outside the popup, and if so, move it inside.
1810 if( !currentFocusedActor ||
1811 ( currentFocusedActor && ( ( !mContent || ( currentFocusGroup != mContent ) ) && ( !mFooter || ( currentFocusGroup != mFooter ) ) ) ) )
1813 // The current focused actor is not within popup.
1814 if( mContent && mContent.IsKeyboardFocusable() )
1816 // If the content is focusable, move the focus to the content.
1817 nextFocusableActor = mContent;
1819 else if( mFooter && mFooter.IsKeyboardFocusable() )
1821 // If the footer is focusable, move the focus to the footer.
1822 nextFocusableActor = mFooter;
1827 // Rebuild the focus chain because controls or content can be added or removed dynamically
1828 std::vector< Actor > focusableActors;
1830 AddFocusableChildren( mContent, focusableActors );
1831 AddFocusableChildren( mFooter, focusableActors );
1833 std::vector< Actor >::iterator endIterator = focusableActors.end();
1834 std::vector< Actor >::iterator currentIterator = focusableActors.begin();
1835 for( std::vector< Actor >::iterator iterator = focusableActors.begin(); iterator != endIterator; ++iterator )
1837 if( currentFocusedActor == *iterator )
1839 currentIterator = iterator;
1843 if( currentIterator != endIterator )
1847 case Toolkit::Control::KeyboardFocus::LEFT:
1849 if( currentIterator == focusableActors.begin() )
1851 nextFocusableActor = *( endIterator - 1 );
1855 nextFocusableActor = *( currentIterator - 1 );
1859 case Toolkit::Control::KeyboardFocus::RIGHT:
1861 if( currentIterator == endIterator - 1 )
1863 nextFocusableActor = *( focusableActors.begin() );
1867 nextFocusableActor = *( currentIterator + 1 );
1872 case Toolkit::Control::KeyboardFocus::UP:
1874 nextFocusableActor = *( focusableActors.begin() );
1878 case Toolkit::Control::KeyboardFocus::DOWN:
1880 nextFocusableActor = *( endIterator - 1 );
1885 if( !nextFocusableActor )
1887 DALI_LOG_WARNING( "Can not decide next focusable actor\n" );
1892 return nextFocusableActor;
1896 } // namespace Internal
1898 } // namespace Toolkit