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/devel-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-event.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/default-controls/solid-color-actor.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_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS ) ),
225 mAlterAddedChild( false ),
226 mLayoutDirty( true ),
227 mTouchTransparent( false ),
229 // Property variables:
230 mDisplayState( Toolkit::Popup::HIDDEN ), // Hidden until shown with SetDisplayState()
231 mTailVisible( false ),
232 mTailPosition( DEFAULT_TAIL_POSITION ),
233 mContextualMode( Toolkit::Popup::NON_CONTEXTUAL ),
234 mAnimationDuration( DEFAULT_POPUP_ANIMATION_DURATION ),
235 mAnimationMode( Toolkit::Popup::FADE ),
237 mBackingEnabled( true ),
238 mBackingColor( DEFAULT_BACKING_COLOR ),
239 mTailUpImage( DEFAULT_TAIL_UP_IMAGE_PATH ),
240 mTailDownImage( DEFAULT_TAIL_DOWN_IMAGE_PATH ),
241 mTailLeftImage( DEFAULT_TAIL_LEFT_IMAGE_PATH ),
242 mTailRightImage( DEFAULT_TAIL_RIGHT_IMAGE_PATH )
244 SetKeyboardNavigationSupport( true );
247 void Popup::OnInitialize()
250 self.SetName( "popup" );
252 // Apply some default resizing rules.
253 self.SetParentOrigin( ParentOrigin::CENTER );
254 self.SetAnchorPoint( AnchorPoint::CENTER );
256 self.SetSizeModeFactor( DEFAULT_POPUP_PARENT_RELATIVE_SIZE );
257 self.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::WIDTH );
258 self.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
260 // Create a new layer so all Popup components can appear above all other actors.
261 mLayer = Layer::New();
262 mLayer.SetName( "popupLayer" );
264 mLayer.SetParentOrigin( ParentOrigin::CENTER );
265 mLayer.SetAnchorPoint( AnchorPoint::CENTER );
266 mLayer.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
268 // Important to set as invisible as otherwise, if the popup is parented,
269 // but not shown yet it will appear statically on the screen.
270 mLayer.SetVisible( false );
272 // Add the layer to the hierarchy.
275 // Add Backing (Dimmed effect).
276 mBacking = CreateBacking();
277 mLayer.Add( mBacking );
279 mPopupContainer = Actor::New();
280 mPopupContainer.SetName( "popupContainer" );
281 mPopupContainer.SetParentOrigin( ParentOrigin::CENTER );
282 mPopupContainer.SetAnchorPoint( AnchorPoint::CENTER );
283 mPopupContainer.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
284 mLayer.Add( mPopupContainer );
286 // Create the Popup layout to contain all main content.
287 mPopupLayout = Toolkit::TableView::New( 3, 1 );
289 // Adds the default background image.
290 SetPopupBackgroundImage( ImageActor::New( ResourceImage::New( DEFAULT_BACKGROUND_IMAGE_PATH ) ) );
292 mPopupLayout.SetName( "popupLayoutTable" );
293 mPopupLayout.SetParentOrigin( ParentOrigin::CENTER );
294 mPopupLayout.SetAnchorPoint( AnchorPoint::CENTER );
296 mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::WIDTH );
297 mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
298 mPopupLayout.SetSize( Stage::GetCurrent().GetSize().x * DEFAULT_RELATIVE_PARENT_WIDTH, 0.0f );
300 mPopupLayout.SetFitHeight( 0 ); // Set row to fit.
301 mPopupLayout.SetFitHeight( 1 ); // Set row to fit.
303 mPopupLayout.TouchedSignal().Connect( this, &Popup::OnDialogTouched );
305 mPopupContainer.Add( mPopupLayout );
307 // Any content after this point which is added to Self() will be re-parented to mContent.
308 mAlterAddedChild = true;
310 // Make self keyboard focusable and a focus group.
311 self.SetKeyboardFocusable( true );
312 SetAsKeyboardFocusGroup( true );
317 mEntryAnimationData.Clear();
318 mExitAnimationData.Clear();
321 void Popup::LayoutAnimation()
323 // Perform setup based on the currently selected animation.
324 switch( mAnimationMode )
326 case Toolkit::Popup::ZOOM:
328 // Zoom animations start fully zoomed out.
329 mPopupContainer.SetScale( Vector3::ZERO );
333 case Toolkit::Popup::FADE:
335 // Fade animations start transparent.
336 mPopupContainer.SetOpacity( 0.0f );
340 case Toolkit::Popup::CUSTOM:
342 // Initialise the custom animation by playing to the end of it's exit animation instantly.
343 // EG. If it was zooming in, then we zoom out fully instantly so the zoom in works.
344 StartTransitionAnimation( false, true );
348 case Toolkit::Popup::NONE:
355 void Popup::StartTransitionAnimation( bool transitionIn, bool instantaneous /* false */ )
357 // Stop and recreate animation.
364 float duration = GetAnimationDuration();
366 // Setup variables ready to start the animations.
367 // If we are performing the animation instantaneously, we do not want to emit a signal.
372 // Setup variables and signal that we are starting the transition.
373 // Note: We signal even if the transition is instant so signal order is consistent.
374 mShowingSignal.Emit();
378 mHidingSignal.Emit();
382 // Perform chosen animation for the Popup.
383 switch( mAnimationMode )
385 case Toolkit::Popup::NONE:
387 mAnimation = Animation::New( 0.0f );
391 case Toolkit::Popup::ZOOM:
393 mAnimation = Animation::New( duration );
394 if( duration > Math::MACHINE_EPSILON_0 )
398 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::SCALE ), Vector3::ONE, AlphaFunction::EASE_IN_OUT, TimePeriod( duration * 0.25f, duration * 0.75f ) );
402 // Zoom out animation is twice the speed. Modify the duration variable so the backing animation speed is modified also.
404 mAnimation.SetDuration( duration );
405 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::SCALE ), Vector3::ZERO, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.0f, duration ) );
410 mPopupContainer.SetScale( transitionIn ? Vector3::ONE : Vector3::ZERO );
415 case Toolkit::Popup::FADE:
417 mAnimation = Animation::New( duration );
418 if( duration > Math::MACHINE_EPSILON_0 )
422 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::COLOR_ALPHA ), 1.0f, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.30f, duration * 0.70f ) );
426 mAnimation.AnimateTo( Property( mPopupContainer, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.0f, duration * 0.70f ) );
431 mPopupContainer.SetOpacity( transitionIn ? 1.0f : 0.0f );
436 case Toolkit::Popup::CUSTOM:
438 // Use a user specified animation for in and out.
439 // Read the correct animation depending on entry or exit.
440 // Attempt to use animation data defined from script data.
441 Dali::AnimationData* animationData = transitionIn ? &mEntryAnimationData : &mExitAnimationData;
443 // Create a new animation from the pre-defined data in the AnimationData class.
444 // If there is no data, mAnimation is invalidated.
445 mAnimation = animationData->CreateAnimation( mPopupContainer, duration );
447 // If we don't have a valid animation, provide a blank one so play() can still function generically.
450 // No animation was configured (even though custom mode was specified). Create a dummy animation to avoid an exception.
451 mAnimation = Animation::New( 0.0f );
458 // Animate the backing, if enabled.
459 // This is set up last so that different animation modes can have an effect on the backing animation speed.
460 if( mBackingEnabled )
462 // Use the alpha from the user-specified color.
463 float targetAlpha = mBackingColor.a;
464 if( duration > Math::MACHINE_EPSILON_0 )
468 mAnimation.AnimateTo( Property( mBacking, Actor::Property::COLOR_ALPHA ), targetAlpha, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.0f, duration * 0.70f ) );
472 mAnimation.AnimateTo( Property( mBacking, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN_OUT, TimePeriod( 0.30f, duration * 0.70f ) );
477 mBacking.SetProperty( Actor::Property::COLOR_ALPHA, transitionIn ? targetAlpha : 0.0f );
481 // If we are performing the animation instantaneously, jump to the position directly and do not signal.
484 mAnimation.SetCurrentProgress( 1.0f );
487 else if( duration > Math::MACHINE_EPSILON_0 )
489 // Run the animation.
490 mAnimation.FinishedSignal().Connect( this, &Popup::OnDisplayChangeAnimationFinished );
495 // We did not use an animation to achive the transition.
496 // Trigger the state change directly.
497 DisplayStateChangeComplete();
501 void Popup::OnDisplayChangeAnimationFinished( Animation& source )
503 DisplayStateChangeComplete();
506 void Popup::DisplayStateChangeComplete()
508 // Remove contents from stage if completely hidden.
509 if( mDisplayState == Toolkit::Popup::HIDING )
511 mDisplayState = Toolkit::Popup::HIDDEN;
513 mLayer.SetVisible( false );
514 mPopupLayout.SetSensitive( false );
516 // Guard against destruction during signal emission.
517 Toolkit::Popup handle( GetOwner() );
518 mHiddenSignal.Emit();
520 else if( mDisplayState == Toolkit::Popup::SHOWING )
522 mDisplayState = Toolkit::Popup::SHOWN;
523 Toolkit::Popup handle( GetOwner() );
526 // Start a timer to auto-hide if enabled.
527 if( mAutoHideDelay > 0u )
529 mAutoHideTimer = Timer::New( mAutoHideDelay );
530 mAutoHideTimer.TickSignal().Connect( this, &Popup::OnAutoHideTimeReached );
531 mAutoHideTimer.Start();
536 bool Popup::OnAutoHideTimeReached()
538 // Display timer has expired, auto hide the popup exactly as if the user had clicked outside.
539 SetDisplayState( Toolkit::Popup::HIDDEN );
543 mAutoHideTimer.Stop();
544 mAutoHideTimer.TickSignal().Disconnect( this, &Popup::OnAutoHideTimeReached );
545 mAutoHideTimer.Reset();
550 void Popup::SetPopupBackgroundImage( Actor image )
552 // Removes any previous background.
553 if( mPopupBackgroundImage )
555 mPopupContainer.Remove( mPopupBackgroundImage );
558 // Adds new background to the dialog.
559 mPopupBackgroundImage = image;
560 mPopupBackgroundImage.SetName( "popupBackgroundImage" );
561 mPopupBackgroundImage.SetAnchorPoint( AnchorPoint::CENTER );
562 mPopupBackgroundImage.SetParentOrigin( ParentOrigin::CENTER );
564 // OnDialogTouched only consumes the event. It prevents the touch event to be caught by the backing.
565 mPopupBackgroundImage.TouchedSignal().Connect( this, &Popup::OnDialogTouched );
567 // Set the popup border to be slightly larger than the layout contents.
568 mPopupBackgroundImage.SetResizePolicy( ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT, Dimension::ALL_DIMENSIONS );
569 mPopupBackgroundImage.SetSizeModeFactor( BACKGROUND_OUTER_BORDER );
571 const bool prevAlter = mAlterAddedChild;
572 mAlterAddedChild = false;
573 mPopupContainer.Add( mPopupBackgroundImage );
574 mAlterAddedChild = prevAlter;
579 Actor Popup::GetPopupBackgroundImage() const
581 return mPopupBackgroundImage;
584 void Popup::SetTitle( Actor titleActor )
586 // Replaces the current title actor.
594 mPopupLayout.RemoveChildAt( Toolkit::TableView::CellPosition( 0, 0) );
600 // Set up padding to give sensible default behaviour
601 // (an application developer can later override this if they wish).
602 mTitle.SetPadding( DEFAULT_TITLE_PADDING );
604 mPopupLayout.AddChild( mTitle, Toolkit::TableView::CellPosition( 0, 0 ) );
611 Actor Popup::GetTitle() const
616 void Popup::SetContent( Actor content )
618 // Remove previous content actor.
621 mPopupLayout.RemoveChildAt( Toolkit::TableView::CellPosition( 1, 0 ) );
623 // Keep a handle to the new content.
628 mContent.SetName( "popupContent" );
630 mPopupLayout.AddChild( mContent, Toolkit::TableView::CellPosition( 1, 0 ) );
637 Actor Popup::GetContent() const
642 void Popup::SetFooter( Actor footer )
644 // Remove previous content actor.
647 mPopupLayout.RemoveChildAt( Toolkit::TableView::CellPosition( 2, 0 ) );
650 // Keep a handle to the new content.
655 mFooter.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH );
657 // The control container has a fixed height.
658 mPopupLayout.SetFitHeight( 2u );
659 mPopupLayout.AddChild( footer, Toolkit::TableView::CellPosition( 2, 0 ) );
666 Actor Popup::GetFooter() const
671 void Popup::SetDisplayState( Toolkit::Popup::DisplayState displayState )
673 // Convert the 4-way state to a bool, true for show, false for hide.
674 bool display = ( displayState == Toolkit::Popup::SHOWING ) || ( displayState == Toolkit::Popup::SHOWN );
676 // Ignore if we are already at the target display state.
677 if( display == ( ( mDisplayState == Toolkit::Popup::SHOWING ) || ( mDisplayState == Toolkit::Popup::SHOWN ) ) )
682 // Convert the bool state to the actual display state to use.
683 mDisplayState = display ? Toolkit::Popup::SHOWING : Toolkit::Popup::HIDING;
687 // Update the state to indicate the current intent.
688 mDisplayState = Toolkit::Popup::SHOWING;
690 // We are displaying so bring the popup layer to the front, and set it visible so it is rendered.
692 mLayer.SetVisible( true );
694 // Set up the layout if this is the first display or the layout has become dirty.
697 // Bake-in any style and layout options to create the Popup layout.
701 // Allow the popup to catch events.
702 mPopupLayout.SetSensitive( true );
705 // Handle the keyboard focus when popup is shown.
706 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
707 if( keyboardFocusManager )
709 mPreviousFocusedActor = keyboardFocusManager.GetCurrentFocusActor();
711 if( mContent && mContent.IsKeyboardFocusable() )
713 // If content is focusable, move the focus to content.
714 keyboardFocusManager.SetCurrentFocusActor( mContent );
718 DALI_LOG_WARNING( "There is no focusable in popup\n" );
724 mDisplayState = Toolkit::Popup::HIDING;
725 ClearKeyInputFocus();
727 // Restore the keyboard focus when popup is hidden.
728 if( mPreviousFocusedActor && mPreviousFocusedActor.IsKeyboardFocusable() )
730 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
731 if( keyboardFocusManager )
733 keyboardFocusManager.SetCurrentFocusActor( mPreviousFocusedActor );
738 // Perform animation.
739 StartTransitionAnimation( display );
742 Toolkit::Popup::DisplayState Popup::GetDisplayState() const
744 return mDisplayState;
747 void Popup::LayoutPopup()
749 mLayoutDirty = false;
751 /* When animating in, we want to respect the origin applied to Self().
752 * For example, if zooming, not only will the final result be anchored to the
753 * selected point, but the zoom will originate from this point also.
755 * EG: ParentOrigin::TOP_LEFT, AnchorPoint::TOP_LEFT :
764 mPopupContainer.SetParentOrigin( Self().GetCurrentParentOrigin() );
765 mPopupContainer.SetAnchorPoint( Self().GetCurrentAnchorPoint() );
767 // If there is only a title, use less padding.
770 if( !mContent && !mFooter )
772 mTitle.SetPadding( DEFAULT_TITLE_ONLY_PADDING );
776 mTitle.SetPadding( DEFAULT_TITLE_PADDING );
780 // Allow derived classes to perform any layout they may need to do.
783 // Update background visibility.
784 mPopupContainer.SetVisible( !( !mFooter && mPopupLayout.GetChildCount() == 0 ) );
786 // Create / destroy / position the tail as needed.
789 // Setup any layout and initialisation required for the selected animation.
795 void Popup::LayoutTail()
797 // Removes the tail actor.
798 if( mTailImage && mTailImage.GetParent() )
800 mTailImage.GetParent().Remove( mTailImage );
809 const Vector3& position = GetTailPosition();
812 // depending on position of tail around ParentOrigin, a different tail image is used...
813 if( position.y < Math::MACHINE_EPSILON_1 )
815 image = mTailUpImage;
817 else if( position.y > 1.0f - Math::MACHINE_EPSILON_1 )
819 image = mTailDownImage;
821 else if( position.x < Math::MACHINE_EPSILON_1 )
823 image = mTailLeftImage;
825 else if( position.x > 1.0f - Math::MACHINE_EPSILON_1 )
827 image = mTailRightImage;
832 // Adds the tail actor.
833 Image tail = ResourceImage::New( image );
834 mTailImage = ImageActor::New( tail );
835 mTailImage.SetName( "tailImage" );
836 const Vector3 anchorPoint = AnchorPoint::BOTTOM_RIGHT - position;
837 mTailImage.SetParentOrigin( position );
838 mTailImage.SetAnchorPoint( anchorPoint );
840 mPopupContainer.Add( mTailImage );
844 void Popup::SetContextualMode( Toolkit::Popup::ContextualMode mode )
846 mContextualMode = mode;
850 Toolkit::Popup::ContextualMode Popup::GetContextualMode() const
852 return mContextualMode;
855 Toolkit::Control Popup::CreateBacking()
857 Toolkit::Control backing = Control::New();
858 backing.SetBackgroundColor( Vector4( mBackingColor.r, mBackingColor.g, mBackingColor.b, 1.0f ) );
859 backing.SetName( "popupBacking" );
861 // Must always be positioned top-left of stage, regardless of parent.
862 backing.SetPositionInheritanceMode( DONT_INHERIT_POSITION );
863 backing.SetAnchorPoint( AnchorPoint::TOP_LEFT );
865 // Always the full size of the stage.
866 backing.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
867 backing.SetSize( Stage::GetCurrent().GetSize() );
870 backing.SetSensitive( true );
872 // Default to being transparent.
873 backing.SetProperty( Actor::Property::COLOR_ALPHA, 0.0f );
874 backing.TouchedSignal().Connect( this, &Popup::OnBackingTouched );
875 backing.WheelEventSignal().Connect( this, &Popup::OnBackingWheelEvent );
879 Toolkit::Popup::TouchedOutsideSignalType& Popup::OutsideTouchedSignal()
881 return mTouchedOutsideSignal;
884 Toolkit::Popup::DisplayStateChangeSignalType& Popup::ShowingSignal()
886 return mShowingSignal;
889 Toolkit::Popup::DisplayStateChangeSignalType& Popup::ShownSignal()
894 Toolkit::Popup::DisplayStateChangeSignalType& Popup::HidingSignal()
896 return mHidingSignal;
899 Toolkit::Popup::DisplayStateChangeSignalType& Popup::HiddenSignal()
901 return mHiddenSignal;
904 void Popup::SetTailVisibility( bool visible )
906 mTailVisible = visible;
910 const bool Popup::IsTailVisible() const
915 void Popup::SetTailPosition( Vector3 position )
917 mTailPosition = position;
921 const Vector3& Popup::GetTailPosition() const
923 return mTailPosition;
926 void Popup::SetAnimationDuration( float duration )
928 mAnimationDuration = duration;
932 float Popup::GetAnimationDuration() const
934 return mAnimationDuration;
937 void Popup::SetAnimationMode( Toolkit::Popup::AnimationMode animationMode )
939 mAnimationMode = animationMode;
943 Toolkit::Popup::AnimationMode Popup::GetAnimationMode() const
945 return mAnimationMode;
948 void Popup::SetEntryAnimationData( const Property::Map& map )
950 mEntryAnimationData.Clear();
951 Scripting::NewAnimation( map, mEntryAnimationData );
954 void Popup::SetExitAnimationData( const Property::Map& map )
956 mExitAnimationData.Clear();
957 Scripting::NewAnimation( map, mExitAnimationData );
960 void Popup::SetAutoHideDelay( int delay )
962 mAutoHideDelay = delay;
965 int Popup::GetAutoHideDelay() const
967 return mAutoHideDelay;
970 void Popup::SetBackingEnabled( bool enabled )
972 mBackingEnabled = enabled;
976 const bool Popup::IsBackingEnabled() const
978 return mBackingEnabled;
981 void Popup::SetBackingColor( Vector4 color )
983 mBackingColor = color;
984 mBacking.SetBackgroundColor( Vector4( color.r, color.g, color.b, 1.0f ) );
988 const Vector4& Popup::GetBackingColor() const
990 return mBackingColor;
993 void Popup::SetTailUpImage( std::string image )
995 mTailUpImage = image;
999 const std::string& Popup::GetTailUpImage() const
1001 return mTailUpImage;
1004 void Popup::SetTailDownImage( std::string image )
1006 mTailDownImage = image;
1007 mLayoutDirty = true;
1010 const std::string& Popup::GetTailDownImage() const
1012 return mTailDownImage;
1015 void Popup::SetTailLeftImage( std::string image )
1017 mTailLeftImage = image;
1018 mLayoutDirty = true;
1021 const std::string& Popup::GetTailLeftImage() const
1023 return mTailLeftImage;
1026 void Popup::SetTailRightImage( std::string image )
1028 mTailRightImage = image;
1029 mLayoutDirty = true;
1032 const std::string& Popup::GetTailRightImage() const
1034 return mTailRightImage;
1037 void Popup::SetTouchTransparent( bool enabled )
1039 mTouchTransparent = enabled;
1042 const bool Popup::IsTouchTransparent() const
1044 return mTouchTransparent;
1047 void Popup::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
1049 Toolkit::Popup popup = Toolkit::Popup::DownCast( Dali::BaseHandle( object ) );
1053 Popup& popupImpl( GetImpl( popup ) );
1055 switch ( propertyIndex )
1057 case Toolkit::Popup::Property::TITLE:
1059 Property::Map valueMap;
1060 if( value.Get( valueMap ) )
1062 popupImpl.SetTitle( Scripting::NewActor( valueMap ) );
1066 case Toolkit::Popup::Property::CONTENT:
1068 Property::Map valueMap;
1069 if( value.Get( valueMap ) )
1071 popupImpl.SetContent( Scripting::NewActor( valueMap ) );
1075 case Toolkit::Popup::Property::FOOTER:
1077 Property::Map valueMap;
1078 if( value.Get( valueMap ) )
1080 popupImpl.SetFooter( Scripting::NewActor( valueMap ) );
1084 case Toolkit::Popup::Property::DISPLAY_STATE:
1086 std::string valueString;
1087 if( value.Get( valueString ) )
1089 Toolkit::Popup::DisplayState displayState( Toolkit::Popup::HIDDEN );
1090 if( Scripting::GetEnumeration< Toolkit::Popup::DisplayState >( valueString.c_str(), DisplayStateTable, DisplayStateTableCount, displayState ) )
1092 popupImpl.SetDisplayState( displayState );
1097 case Toolkit::Popup::Property::TOUCH_TRANSPARENT:
1100 if( value.Get( valueBool ) )
1102 popupImpl.SetTouchTransparent( valueBool );
1106 case Toolkit::Popup::Property::TAIL_VISIBILITY:
1109 if( value.Get( valueBool ) )
1111 popupImpl.SetTailVisibility( valueBool );
1115 case Toolkit::Popup::Property::TAIL_POSITION:
1117 Vector3 valueVector3;
1118 if( value.Get( valueVector3 ) )
1120 popupImpl.SetTailPosition( valueVector3 );
1124 case Toolkit::Popup::Property::CONTEXTUAL_MODE:
1126 std::string valueString;
1127 if( value.Get( valueString ) )
1129 Toolkit::Popup::ContextualMode contextualMode( Toolkit::Popup::BELOW );
1130 if( Scripting::GetEnumeration< Toolkit::Popup::ContextualMode >( valueString.c_str(), ContextualModeTable, ContextualModeTableCount, contextualMode ) )
1132 popupImpl.SetContextualMode( contextualMode );
1137 case Toolkit::Popup::Property::ANIMATION_DURATION:
1140 if( value.Get( valueFloat ) )
1142 popupImpl.SetAnimationDuration( valueFloat );
1146 case Toolkit::Popup::Property::ANIMATION_MODE:
1148 std::string valueString;
1149 if( value.Get( valueString ) )
1151 Toolkit::Popup::AnimationMode animationMode( Toolkit::Popup::FADE );
1152 if( Scripting::GetEnumeration< Toolkit::Popup::AnimationMode >( valueString.c_str(), AnimationModeTable, AnimationModeTableCount, animationMode ) )
1154 popupImpl.SetAnimationMode( animationMode );
1159 case Toolkit::Popup::Property::ENTRY_ANIMATION:
1161 Property::Map valueMap;
1162 if( value.Get( valueMap ) )
1164 popupImpl.SetEntryAnimationData( valueMap );
1168 case Toolkit::Popup::Property::EXIT_ANIMATION:
1170 Property::Map valueMap;
1171 if( value.Get( valueMap ) )
1173 popupImpl.SetExitAnimationData( valueMap );
1177 case Toolkit::Popup::Property::AUTO_HIDE_DELAY:
1180 if( value.Get( valueInt ) )
1182 popupImpl.SetAutoHideDelay( valueInt );
1186 case Toolkit::Popup::Property::BACKING_ENABLED:
1189 if( value.Get( valueBool ) )
1191 popupImpl.SetBackingEnabled( valueBool );
1195 case Toolkit::Popup::Property::BACKING_COLOR:
1197 Vector4 valueVector4;
1198 if( value.Get( valueVector4 ) )
1200 popupImpl.SetBackingColor( valueVector4 );
1204 case Toolkit::Popup::Property::POPUP_BACKGROUND_IMAGE:
1206 std::string valueString;
1207 if( value.Get( valueString ) )
1209 Image image = ResourceImage::New( valueString );
1212 ImageActor actor = ImageActor::New( image );
1213 popupImpl.SetPopupBackgroundImage( actor );
1218 case Toolkit::Popup::Property::TAIL_UP_IMAGE:
1220 std::string valueString;
1221 if( value.Get( valueString ) )
1223 popupImpl.SetTailUpImage( valueString );
1227 case Toolkit::Popup::Property::TAIL_DOWN_IMAGE:
1229 std::string valueString;
1230 if( value.Get( valueString ) )
1232 popupImpl.SetTailDownImage( valueString );
1236 case Toolkit::Popup::Property::TAIL_LEFT_IMAGE:
1238 std::string valueString;
1239 if( value.Get( valueString ) )
1241 popupImpl.SetTailLeftImage( valueString );
1245 case Toolkit::Popup::Property::TAIL_RIGHT_IMAGE:
1247 std::string valueString;
1248 if( value.Get( valueString ) )
1250 popupImpl.SetTailRightImage( valueString );
1258 Property::Value Popup::GetProperty( BaseObject* object, Property::Index propertyIndex )
1260 Property::Value value;
1262 Toolkit::Popup popup = Toolkit::Popup::DownCast( Dali::BaseHandle( object ) );
1266 Popup& popupImpl( GetImpl( popup ) );
1268 switch ( propertyIndex )
1270 case Toolkit::Popup::Property::TITLE:
1273 Scripting::CreatePropertyMap( popupImpl.GetTitle(), map );
1277 case Toolkit::Popup::Property::CONTENT:
1280 Scripting::CreatePropertyMap( popupImpl.GetContent(), map );
1284 case Toolkit::Popup::Property::FOOTER:
1287 Scripting::CreatePropertyMap( popupImpl.GetFooter(), map );
1291 case Toolkit::Popup::Property::DISPLAY_STATE:
1293 value = Scripting::GetLinearEnumerationName< Toolkit::Popup::DisplayState >( popupImpl.GetDisplayState(), DisplayStateTable, DisplayStateTableCount );
1296 case Toolkit::Popup::Property::TOUCH_TRANSPARENT:
1298 value = popupImpl.IsTouchTransparent();
1301 case Toolkit::Popup::Property::TAIL_VISIBILITY:
1303 value = popupImpl.IsTailVisible();
1306 case Toolkit::Popup::Property::TAIL_POSITION:
1308 value = popupImpl.GetTailPosition();
1311 case Toolkit::Popup::Property::CONTEXTUAL_MODE:
1313 value = Scripting::GetLinearEnumerationName< Toolkit::Popup::ContextualMode >( popupImpl.GetContextualMode(), ContextualModeTable, ContextualModeTableCount );
1316 case Toolkit::Popup::Property::ANIMATION_DURATION:
1318 value = popupImpl.GetAnimationDuration();
1321 case Toolkit::Popup::Property::ANIMATION_MODE:
1323 value = Scripting::GetLinearEnumerationName< Toolkit::Popup::AnimationMode >( popupImpl.GetAnimationMode(), AnimationModeTable, AnimationModeTableCount );
1326 case Toolkit::Popup::Property::ENTRY_ANIMATION:
1328 // Note: Cannot retrieve property map from animation.
1333 case Toolkit::Popup::Property::EXIT_ANIMATION:
1335 // Note: Cannot retrieve property map from animation.
1340 case Toolkit::Popup::Property::AUTO_HIDE_DELAY:
1342 value = popupImpl.GetAutoHideDelay();
1345 case Toolkit::Popup::Property::BACKING_ENABLED:
1347 value = popupImpl.IsBackingEnabled();
1350 case Toolkit::Popup::Property::BACKING_COLOR:
1352 value = popupImpl.GetBackingColor();
1355 case Toolkit::Popup::Property::POPUP_BACKGROUND_IMAGE:
1357 ResourceImage image = ResourceImage::DownCast( popupImpl.GetPopupBackgroundImage() );
1360 value = image.GetUrl();
1364 case Toolkit::Popup::Property::TAIL_UP_IMAGE:
1366 value = popupImpl.GetTailUpImage();
1369 case Toolkit::Popup::Property::TAIL_DOWN_IMAGE:
1371 value = popupImpl.GetTailDownImage();
1374 case Toolkit::Popup::Property::TAIL_LEFT_IMAGE:
1376 value = popupImpl.GetTailLeftImage();
1379 case Toolkit::Popup::Property::TAIL_RIGHT_IMAGE:
1381 value = popupImpl.GetTailRightImage();
1390 bool Popup::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
1392 Dali::BaseHandle handle( object );
1394 bool connected( true );
1395 Toolkit::Popup popup = Toolkit::Popup::DownCast( handle );
1397 if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCHED_OUTSIDE ) )
1399 popup.OutsideTouchedSignal().Connect( tracker, functor );
1401 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SHOWING ) )
1403 popup.ShowingSignal().Connect( tracker, functor );
1405 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SHOWN ) )
1407 popup.ShownSignal().Connect( tracker, functor );
1409 else if( 0 == strcmp( signalName.c_str(), SIGNAL_HIDING ) )
1411 popup.HidingSignal().Connect( tracker, functor );
1413 else if( 0 == strcmp( signalName.c_str(), SIGNAL_HIDDEN ) )
1415 popup.HiddenSignal().Connect( tracker, functor );
1419 // signalName does not match any signal
1426 bool Popup::OnBackingTouched( Actor actor, const TouchEvent& event )
1428 // Allow events to pass through if touch transparency is enabled.
1429 if( mTouchTransparent )
1434 if( event.GetPointCount() > 0 )
1436 const TouchPoint& point = event.GetPoint( 0 );
1438 if( point.state == TouchPoint::Down )
1440 // Guard against destruction during signal emission.
1441 Toolkit::Popup handle( GetOwner() );
1443 mTouchedOutsideSignal.Emit();
1447 // Block anything behind backing becoming touched.
1448 mLayer.SetTouchConsumed( true );
1452 bool Popup::OnBackingWheelEvent( Actor actor, const WheelEvent& event )
1454 // Allow events to pass through if touch transparency is enabled.
1455 if( mTouchTransparent )
1460 // Consume wheel event in dimmed backing actor.
1461 mLayer.SetTouchConsumed( true );
1465 bool Popup::OnDialogTouched(Actor actor, const TouchEvent& event)
1467 // Allow events to pass through if touch transparency is enabled.
1468 if( mTouchTransparent )
1473 // Consume event (stops backing actor receiving touch events)
1474 mLayer.SetTouchConsumed( true );
1478 void Popup::OnControlStageConnection()
1480 mLayoutDirty = true;
1484 void Popup::OnControlChildAdd( Actor& child )
1486 // Re-parent any children added by user to the body layer.
1487 if( mAlterAddedChild )
1489 SetContent( child );
1493 mLayoutDirty = true;
1498 void Popup::LayoutContext( const Vector2& size )
1500 // Do nothing if not in a contextual mode (or there is no parent context).
1501 Actor self = Self();
1502 Actor parent = self.GetParent();
1503 if( ( mContextualMode == Toolkit::Popup::NON_CONTEXTUAL ) || !parent )
1508 mPopupContainer.SetParentOrigin( ParentOrigin::CENTER );
1509 // We always anchor to the CENTER, rather than a different anchor point for each contextual
1510 // mode to allow code-reuse of the bound checking code (for maintainability).
1511 mPopupContainer.SetAnchorPoint( AnchorPoint::CENTER );
1513 // Setup with some pre-calculations for speed.
1514 Vector3 halfStageSize( Stage().GetCurrent().GetSize() / 2.0f );
1515 Vector3 parentPosition( parent.GetCurrentPosition() );
1516 Vector2 halfSize( size / 2.0f );
1517 Vector2 halfParentSize( parent.GetRelayoutSize( Dimension::WIDTH ) / 2.0f, parent.GetRelayoutSize( Dimension::HEIGHT ) / 2.0f );
1518 Vector3 newPosition( Vector3::ZERO );
1520 // Perform different positioning based on the specified contextual layout mode.
1521 switch( mContextualMode )
1523 case Toolkit::Popup::BELOW:
1525 newPosition.x += halfSize.x - halfParentSize.x;
1526 newPosition.y += halfSize.y + halfParentSize.y + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.y;
1529 case Toolkit::Popup::ABOVE:
1531 newPosition.x += halfSize.x - halfParentSize.x;
1532 newPosition.y -= halfSize.y + halfParentSize.y + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.y;
1535 case Toolkit::Popup::RIGHT:
1537 newPosition.x += halfSize.x + halfParentSize.x + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.x;
1538 newPosition.y += halfSize.y - halfParentSize.y;
1541 case Toolkit::Popup::LEFT:
1543 newPosition.x -= halfSize.x + halfParentSize.x + DEFAULT_CONTEXTUAL_ADJACENCY_MARGIN.x;
1544 newPosition.y += halfSize.y - halfParentSize.y;
1547 case Toolkit::Popup::NON_CONTEXTUAL:
1549 // Code won't reach here (caught earlier).
1554 // On-screen position checking.
1555 // Check new position is not too far right. If so, correct it.
1556 // Note: Check for right rather than left first, so if popup is too wide, the left check overrides
1557 // the right check and we at least see the left portion of the popup (as this is more useful).
1558 if( newPosition.x >= ( halfStageSize.x - parentPosition.x - halfSize.x - DEFAULT_CONTEXTUAL_STAGE_BORDER.x ) )
1560 newPosition.x = halfStageSize.x - parentPosition.x - halfSize.x - DEFAULT_CONTEXTUAL_STAGE_BORDER.x;
1562 // Check new position is not too far left. If so, correct it.
1563 if( newPosition.x < halfSize.x - ( parentPosition.x + halfStageSize.x ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.x )
1565 newPosition.x = halfSize.x - ( parentPosition.x + halfStageSize.x ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.x;// - parentSize.x;
1567 // Check new position is not too far down. If so, correct it.
1568 if( newPosition.y >= ( halfStageSize.y - parentPosition.y - halfSize.y - DEFAULT_CONTEXTUAL_STAGE_BORDER.y ) )
1570 newPosition.y = halfStageSize.y - parentPosition.y - halfSize.y - DEFAULT_CONTEXTUAL_STAGE_BORDER.y;
1572 // Check new position is not too far up. If so, correct it.
1573 if( newPosition.y < halfSize.y - ( parentPosition.y + halfStageSize.y ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.y )
1575 newPosition.y = halfSize.y - ( parentPosition.y + halfStageSize.y ) + DEFAULT_CONTEXTUAL_STAGE_BORDER.y;
1578 // Set the final position.
1579 mPopupContainer.SetPosition( newPosition );
1582 void Popup::OnRelayout( const Vector2& size, RelayoutContainer& container )
1584 Vector2 useSize( size );
1586 // Use the Popup layouts size, unless requested to use a fixed size.
1587 // In which case take the size set for the Popup itself.
1588 ResizePolicy::Type widthPolicy = Self().GetResizePolicy( Dimension::WIDTH );
1589 ResizePolicy::Type heightPolicy = Self().GetResizePolicy( Dimension::HEIGHT );
1591 // Width calculations:
1592 if( widthPolicy == ResizePolicy::USE_NATURAL_SIZE || widthPolicy == ResizePolicy::FIT_TO_CHILDREN )
1594 // If we using a child-based policy, take the size from the popup layout.
1595 mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::WIDTH );
1596 useSize.width = mPopupLayout.GetRelayoutSize( Dimension::WIDTH );
1598 mPopupLayout.SetFitWidth( 0u );
1602 // If we using a parent-based policy, take the size from the popup object itself (self).
1603 mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::WIDTH );
1605 mPopupLayout.SetFixedWidth( 0u, useSize.width );
1608 // Height calculations:
1609 // Title: Let the title be as high as it needs to be.
1610 mPopupLayout.SetFitHeight( 0u );
1612 // Footer: Convert the footer's resize policy to a TableView row policy.
1615 ResizePolicy::Type footerHeightPolicy = mFooter.GetResizePolicy( Dimension::HEIGHT );
1616 if( ( footerHeightPolicy == ResizePolicy::USE_NATURAL_SIZE ) ||
1617 ( footerHeightPolicy == ResizePolicy::FIT_TO_CHILDREN ) )
1619 mPopupLayout.SetFitHeight( 2u );
1621 else if( footerHeightPolicy == ResizePolicy::FIXED )
1623 mPopupLayout.SetFixedHeight( 2u, mFooter.GetRelayoutSize( Dimension::HEIGHT) );
1627 mPopupLayout.SetRelativeHeight( 2u, 1.0f );
1632 mPopupLayout.SetFixedHeight( 2u, 0.0f );
1635 // Popup contents: Adjust the tableview's policies based on the popup's policies.
1636 if( heightPolicy == ResizePolicy::USE_NATURAL_SIZE || heightPolicy == ResizePolicy::FIT_TO_CHILDREN )
1638 mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
1640 // Let both the contents expand as necessary.
1641 mPopupLayout.SetFitHeight( 1u );
1642 useSize.height = mPopupLayout.GetRelayoutSize( Dimension::HEIGHT );
1646 mPopupLayout.SetResizePolicy( heightPolicy, Dimension::HEIGHT );
1648 // Let the content expand to fill the remaining space.
1649 mPopupLayout.SetRelativeHeight( 1u, 1.0f );
1650 mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::HEIGHT );
1653 // Relayout the popup-layout to give it it's new size this frame.
1654 container.Add( mPopupLayout, useSize );
1658 container.Add( mContent, Vector2( mContent.GetRelayoutSize( Dimension::WIDTH ), mContent.GetRelayoutSize( Dimension::HEIGHT ) ) );
1661 // Perform contextual layout setup if required.
1662 // This is done each time in case the parent moves.
1663 // This will have no effect if no contextual mode is selected.
1664 LayoutContext( useSize );
1667 void Popup::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
1669 // To get the popup to emulate fit-to-children, we need to actually set use-natural-size.
1670 if( ( dimension & Dimension::HEIGHT ) && ( policy == ResizePolicy::FIT_TO_CHILDREN ) )
1672 Self().SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
1675 mLayoutDirty = true;
1679 Vector3 Popup::GetNaturalSize()
1681 return mPopupLayout.GetNaturalSize();
1684 float Popup::GetHeightForWidth( float width )
1686 return mPopupLayout.GetHeightForWidth( width );
1689 float Popup::GetWidthForHeight( float height )
1691 return mPopupLayout.GetWidthForHeight( height );
1694 bool Popup::OnKeyEvent( const KeyEvent& event )
1696 // Allow events to pass through if touch transparency is enabled.
1697 if( mTouchTransparent )
1702 bool consumed = false;
1704 if( event.state == KeyEvent::Down )
1706 if (event.keyCode == Dali::DALI_KEY_ESCAPE || event.keyCode == Dali::DALI_KEY_BACK)
1708 SetDisplayState( Toolkit::Popup::HIDDEN );
1716 Actor Popup::GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled )
1718 Actor nextFocusableActor( currentFocusedActor );
1720 // TODO: Needs to be optimised
1721 if( !currentFocusedActor || ( currentFocusedActor && KeyboardFocusManager::Get().GetFocusGroup( currentFocusedActor ) != Self() ) )
1723 // The current focused actor is not within popup
1724 if( mContent && mContent.IsKeyboardFocusable() )
1726 // If content is focusable, move the focus to content
1727 nextFocusableActor = mContent;
1732 // Rebuild the focus chain because controls or content can be added or removed dynamically
1733 std::vector< Actor > focusableActors;
1734 if( mContent && mContent.IsKeyboardFocusable() )
1736 focusableActors.push_back( mContent );
1739 for( std::vector< Actor >::iterator iter = focusableActors.begin(), end = focusableActors.end(); iter != end; ++iter )
1741 if( currentFocusedActor == *iter )
1745 case Toolkit::Control::KeyboardFocus::LEFT:
1747 if( iter == focusableActors.begin() )
1749 nextFocusableActor = *( focusableActors.end() - 1 );
1753 nextFocusableActor = *( iter - 1 );
1757 case Toolkit::Control::KeyboardFocus::RIGHT:
1759 if( iter == focusableActors.end() - 1 )
1761 nextFocusableActor = *( focusableActors.begin() );
1765 nextFocusableActor = *( iter + 1 );
1770 case Toolkit::Control::KeyboardFocus::UP:
1772 if( mContent && *iter == mContent )
1774 nextFocusableActor = *( focusableActors.end() - 1 );
1778 if( mContent && mContent.IsKeyboardFocusable() )
1780 nextFocusableActor = mContent;
1784 if ( iter == focusableActors.begin() )
1786 nextFocusableActor = *( focusableActors.end() - 1 );
1790 nextFocusableActor = *( iter - 1 );
1797 case Toolkit::Control::KeyboardFocus::DOWN:
1799 if( mContent && mContent.IsKeyboardFocusable() )
1801 nextFocusableActor = mContent;
1805 if( iter == focusableActors.end() - 1 )
1807 nextFocusableActor = *( focusableActors.begin() );
1811 nextFocusableActor = *( iter + 1 );
1818 if( !nextFocusableActor )
1820 DALI_LOG_WARNING( "Can not decide next focusable actor\n" );
1828 return nextFocusableActor;
1831 } // namespace Internal
1833 } // namespace Toolkit