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/text/decorator/text-decorator.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/actors/actor.h>
24 #include <dali/public-api/adaptor-framework/timer.h>
25 #include <dali/public-api/actors/image-actor.h>
26 #include <dali/public-api/actors/layer.h>
27 #include <dali/public-api/actors/mesh-actor.h>
28 #include <dali/public-api/animation/constraint.h>
29 #include <dali/public-api/common/constants.h>
30 #include <dali/public-api/common/stage.h>
31 #include <dali/public-api/events/tap-gesture.h>
32 #include <dali/public-api/events/tap-gesture-detector.h>
33 #include <dali/public-api/events/pan-gesture.h>
34 #include <dali/public-api/events/pan-gesture-detector.h>
35 #include <dali/public-api/geometry/mesh.h>
36 #include <dali/public-api/geometry/mesh-data.h>
37 #include <dali/public-api/images/resource-image.h>
38 #include <dali/public-api/math/rect.h>
39 #include <dali/public-api/math/vector2.h>
40 #include <dali/public-api/math/vector4.h>
41 #include <dali/public-api/object/property-notification.h>
42 #include <dali/public-api/signals/connection-tracker.h>
45 #include <dali-toolkit/public-api/controls/control.h>
46 #include <dali-toolkit/public-api/controls/control-impl.h>
47 #include <dali-toolkit/public-api/controls/buttons/push-button.h>
48 #include <dali-toolkit/public-api/controls/default-controls/solid-color-actor.h>
49 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
50 #include <dali-toolkit/public-api/controls/text-controls/text-selection-popup.h>
53 #define DECORATOR_DEBUG
64 #ifdef DECORATOR_DEBUG
65 Integration::Log::Filter* gLogFilter( Integration::Log::Filter::New(Debug::NoLogging, false, "LOG_TEXT_DECORATOR") );
76 const char* DEFAULT_GRAB_HANDLE_IMAGE( DALI_IMAGE_DIR "insertpoint-icon.png" );
77 const char* DEFAULT_SELECTION_HANDLE_ONE( DALI_IMAGE_DIR "text-input-selection-handle-left.png" );
78 const char* DEFAULT_SELECTION_HANDLE_TWO( DALI_IMAGE_DIR "text-input-selection-handle-right.png" );
79 //const char* DEFAULT_SELECTION_HANDLE_ONE_PRESSED( DALI_IMAGE_DIR "text-input-selection-handle-left-press.png" );
80 //const char* DEFAULT_SELECTION_HANDLE_TWO_PRESSED( DALI_IMAGE_DIR "text-input-selection-handle-right-press.png" );
82 const Dali::Vector3 DEFAULT_GRAB_HANDLE_RELATIVE_SIZE( 1.5f, 2.0f, 1.0f );
83 const Dali::Vector3 DEFAULT_SELECTION_HANDLE_RELATIVE_SIZE( 1.5f, 1.5f, 1.0f );
85 const std::size_t CURSOR_BLINK_INTERVAL = 500; // Cursor blink interval
86 const std::size_t MILLISECONDS = 1000;
88 const float DISPLAYED_HIGHLIGHT_Z_OFFSET( -0.05f );
91 * structure to hold coordinates of each quad, which will make up the mesh.
93 struct QuadCoordinates
104 * @param[in] x1 left co-ordinate
105 * @param[in] y1 top co-ordinate
106 * @param[in] x2 right co-ordinate
107 * @param[in] y2 bottom co-ordinate
109 QuadCoordinates(float x1, float y1, float x2, float y2)
115 Dali::Vector2 min; ///< top-left (minimum) position of quad
116 Dali::Vector2 max; ///< bottom-right (maximum) position of quad
119 typedef std::vector<QuadCoordinates> QuadContainer;
122 * @brief Takes a bounding rectangle in the local coordinates of an actor and returns the world coordinates Bounding Box.
123 * @param[in] boundingRectangle local bounding
124 * @param[out] Vector4 World coordinate bounding Box.
126 void LocalToWorldCoordinatesBoundingBox( const Dali::Rect<int>& boundingRectangle, Dali::Vector4& boundingBox )
128 // Convert to world coordinates and store as a Vector4 to be compatible with Property Notifications.
129 Dali::Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
131 const float originX = boundingRectangle.x - 0.5f * stageSize.width;
132 const float originY = boundingRectangle.y - 0.5f * stageSize.height;
134 boundingBox = Dali::Vector4( originX,
136 originX + boundingRectangle.width,
137 originY + boundingRectangle.height );
141 } // end of namespace
152 struct Decorator::Impl : public ConnectionTracker
161 color(Dali::Color::WHITE)
173 struct SelectionHandleImpl
175 SelectionHandleImpl()
185 float lineHeight; ///< Not the handle height
195 Impl( Dali::Toolkit::Internal::Control& parent, Observer& observer )
196 : mTextControlParent(parent),
198 mActiveCursor(ACTIVE_CURSOR_NONE),
199 mActiveGrabHandle(false),
200 mActiveSelection( false ),
201 mActiveCopyPastePopup( false ),
202 mCursorBlinkInterval( CURSOR_BLINK_INTERVAL ),
203 mCursorBlinkDuration( 0.0f ),
204 mCursorBlinkStatus( true ),
205 mGrabDisplacementX( 0.0f ),
206 mGrabDisplacementY( 0.0f ),
207 mHighlightColor( 0.07f, 0.41f, 0.59f, 1.0f ), // light blue
208 mBoundingBox( Rect<int>() )
213 * Relayout of the decorations owned by the decorator.
214 * @param[in] size The Size of the UI control the decorater is adding it's decorations to.
216 void Relayout( const Vector2& size, const Vector2& scrollPosition )
218 // TODO - Remove this if nothing is active
221 // Show or hide the cursors
225 mPrimaryCursor.SetPosition( mCursor[PRIMARY_CURSOR].x + scrollPosition.x,
226 mCursor[PRIMARY_CURSOR].y + scrollPosition.y );
227 mPrimaryCursor.SetSize( Size( 1.0f, mCursor[PRIMARY_CURSOR].cursorHeight ) );
229 if( mSecondaryCursor )
231 mSecondaryCursor.SetPosition( mCursor[SECONDARY_CURSOR].x + scrollPosition.x,
232 mCursor[SECONDARY_CURSOR].y + scrollPosition.y );
233 mSecondaryCursor.SetSize( Size( 1.0f, mCursor[SECONDARY_CURSOR].cursorHeight ) );
236 // Show or hide the grab handle
237 if( mActiveGrabHandle )
243 mGrabHandle.SetPosition( mCursor[PRIMARY_CURSOR].x + scrollPosition.x,
244 mCursor[PRIMARY_CURSOR].lineHeight + scrollPosition.y );
246 else if( mGrabHandle )
248 UnparentAndReset( mGrabHandle );
251 // Show or hide the selection handles/highlight
252 if( mActiveSelection )
256 CreateSelectionHandles();
258 SelectionHandleImpl& primary = mSelectionHandle[ PRIMARY_SELECTION_HANDLE ];
259 primary.actor.SetPosition( primary.x + scrollPosition.x,
260 primary.lineHeight + scrollPosition.y );
262 SelectionHandleImpl& secondary = mSelectionHandle[ SECONDARY_SELECTION_HANDLE ];
263 secondary.actor.SetPosition( secondary.x + scrollPosition.x,
264 secondary.lineHeight + scrollPosition.y );
271 UnparentAndReset( mSelectionHandle[ PRIMARY_SELECTION_HANDLE ].actor );
272 UnparentAndReset( mSelectionHandle[ SECONDARY_SELECTION_HANDLE ].actor );
273 UnparentAndReset( mHighlightMeshActor );
276 if ( mActiveCopyPastePopup )
278 if ( !mCopyPastePopup )
280 mCopyPastePopup = TextSelectionPopup::New();
281 #ifdef DECORATOR_DEBUG
282 mCopyPastePopup.SetName("mCopyPastePopup");
284 mCopyPastePopup.SetAnchorPoint( AnchorPoint::CENTER );
285 mCopyPastePopup.OnRelayoutSignal().Connect( this, &Decorator::Impl::PopUpRelayoutComplete ); // Position popup after size negotiation
286 mActiveLayer.Add ( mCopyPastePopup );
291 if ( mCopyPastePopup )
293 UnparentAndReset( mCopyPastePopup );
298 void PopUpRelayoutComplete( Actor actor )
300 // Size negotiation for CopyPastePopup complete so can get the size and constrain position within bounding box.
302 mCopyPastePopup.OnRelayoutSignal().Disconnect( this, &Decorator::Impl::PopUpRelayoutComplete );
304 Vector3 popupPosition( mCursor[PRIMARY_CURSOR].x, mCursor[PRIMARY_CURSOR].y -100.0f , 0.0f); //todo 100 to be an offset Property
306 Vector3 popupSize = Vector3( mCopyPastePopup.GetRelayoutSize( Dimension::WIDTH ), mCopyPastePopup.GetRelayoutSize( Dimension::HEIGHT ), 0.0f );
308 GetConstrainedPopupPosition( popupPosition, popupSize, AnchorPoint::CENTER, mActiveLayer, mBoundingBox );
310 SetUpPopUpPositionNotifications();
312 mCopyPastePopup.SetPosition( popupPosition ); //todo grabhandle(cursor) or selection handle positions to be used
315 void CreateCursor( ImageActor& cursor )
317 cursor = CreateSolidColorActor( Color::WHITE );
318 cursor.SetParentOrigin( ParentOrigin::TOP_LEFT ); // Need to set the default parent origin as CreateSolidColorActor() sets a different one.
319 cursor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
322 // Add or Remove cursor(s) from parent
325 if( mActiveCursor == ACTIVE_CURSOR_NONE )
327 UnparentAndReset( mPrimaryCursor );
328 UnparentAndReset( mSecondaryCursor );
332 /* Create Primary and or Secondary Cursor(s) if active and add to parent */
333 if ( mActiveCursor == ACTIVE_CURSOR_PRIMARY ||
334 mActiveCursor == ACTIVE_CURSOR_BOTH )
336 if ( !mPrimaryCursor )
338 CreateCursor( mPrimaryCursor );
339 #ifdef DECORATOR_DEBUG
340 mPrimaryCursor.SetName( "PrimaryCursorActor" );
342 mActiveLayer.Add( mPrimaryCursor);
346 if ( mActiveCursor == ACTIVE_CURSOR_BOTH )
348 if ( !mSecondaryCursor )
350 CreateCursor( mSecondaryCursor );
351 #ifdef DECORATOR_DEBUG
352 mSecondaryCursor.SetName( "SecondaryCursorActor" );
354 mActiveLayer.Add( mSecondaryCursor);
359 UnparentAndReset( mSecondaryCursor );
364 bool OnCursorBlinkTimerTick()
367 if ( mPrimaryCursor )
369 mPrimaryCursor.SetVisible( mCursorBlinkStatus );
371 if ( mSecondaryCursor )
373 mSecondaryCursor.SetVisible( mCursorBlinkStatus );
376 mCursorBlinkStatus = !mCursorBlinkStatus;
381 void SetupTouchEvents()
385 mTapDetector = TapGestureDetector::New();
386 mTapDetector.DetectedSignal().Connect( this, &Decorator::Impl::OnTap );
389 if ( !mPanGestureDetector )
391 mPanGestureDetector = PanGestureDetector::New();
392 mPanGestureDetector.DetectedSignal().Connect( this, &Decorator::Impl::OnPan );
396 void CreateActiveLayer()
400 Actor parent = mTextControlParent.Self();
402 mActiveLayer = Layer::New();
403 #ifdef DECORATOR_DEBUG
404 mActiveLayer.SetName ( "ActiveLayerActor" );
407 mActiveLayer.SetParentOrigin( ParentOrigin::CENTER );
408 mActiveLayer.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
409 mActiveLayer.SetPositionInheritanceMode( USE_PARENT_POSITION );
411 parent.Add( mActiveLayer );
414 mActiveLayer.RaiseToTop();
417 void CreateGrabHandle()
421 if ( !mGrabHandleImage )
423 mGrabHandleImage = ResourceImage::New( DEFAULT_GRAB_HANDLE_IMAGE );
426 mGrabHandle = ImageActor::New( mGrabHandleImage );
427 mGrabHandle.SetAnchorPoint( AnchorPoint::TOP_CENTER );
428 mGrabHandle.SetDrawMode( DrawMode::OVERLAY );
429 // Area that Grab handle responds to, larger than actual handle so easier to move
430 #ifdef DECORATOR_DEBUG
431 mGrabHandle.SetName( "GrabHandleActor" );
432 if ( Dali::Internal::gLogFilter->IsEnabledFor( Debug::Verbose ) )
434 mGrabArea = Toolkit::CreateSolidColorActor( Vector4(0.0f, 0.0f, 0.0f, 0.0f), true, Color::RED, 1 );
435 mGrabArea.SetName( "GrabArea" );
439 mGrabArea = Actor::New();
440 mGrabArea.SetName( "GrabArea" );
443 mGrabArea = Actor::New();
446 mGrabArea.SetParentOrigin( ParentOrigin::TOP_CENTER );
447 mGrabArea.SetAnchorPoint( AnchorPoint::TOP_CENTER );
448 mGrabArea.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
449 mGrabArea.SetSizeModeFactor( DEFAULT_GRAB_HANDLE_RELATIVE_SIZE );
450 mGrabHandle.Add( mGrabArea );
452 mTapDetector.Attach( mGrabArea );
453 mPanGestureDetector.Attach( mGrabArea );
455 mActiveLayer.Add( mGrabHandle );
459 void CreateSelectionHandles()
461 SelectionHandleImpl& primary = mSelectionHandle[ PRIMARY_SELECTION_HANDLE ];
462 if ( !primary.actor )
464 if ( !primary.releasedImage )
466 primary.releasedImage = ResourceImage::New( DEFAULT_SELECTION_HANDLE_ONE );
469 primary.actor = ImageActor::New( primary.releasedImage );
470 #ifdef DECORATOR_DEBUG
471 primary.actor.SetName("SelectionHandleOne");
473 primary.actor.SetAnchorPoint( AnchorPoint::TOP_RIGHT ); // Change to BOTTOM_RIGHT if Look'n'Feel requires handle above text.
474 primary.actor.SetDrawMode( DrawMode::OVERLAY ); // ensure grab handle above text
475 primary.flipped = false;
477 primary.grabArea = Actor::New(); // Area that Grab handle responds to, larger than actual handle so easier to move
478 #ifdef DECORATOR_DEBUG
479 primary.grabArea.SetName("SelectionHandleOneGrabArea");
481 primary.grabArea.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
482 primary.grabArea.SetSizeModeFactor( DEFAULT_SELECTION_HANDLE_RELATIVE_SIZE );
483 primary.grabArea.SetPositionInheritanceMode( Dali::USE_PARENT_POSITION );
485 mTapDetector.Attach( primary.grabArea );
486 mPanGestureDetector.Attach( primary.grabArea );
487 primary.grabArea.TouchedSignal().Connect( this, &Decorator::Impl::OnHandleOneTouched );
489 primary.actor.Add( primary.grabArea );
490 mActiveLayer.Add( primary.actor );
493 SelectionHandleImpl& secondary = mSelectionHandle[ SECONDARY_SELECTION_HANDLE ];
494 if ( !secondary.actor )
496 if ( !secondary.releasedImage )
498 secondary.releasedImage = ResourceImage::New( DEFAULT_SELECTION_HANDLE_TWO );
501 secondary.actor = ImageActor::New( secondary.releasedImage );
502 #ifdef DECORATOR_DEBUG
503 secondary.actor.SetName("SelectionHandleTwo");
505 secondary.actor.SetAnchorPoint( AnchorPoint::TOP_LEFT ); // Change to BOTTOM_LEFT if Look'n'Feel requires handle above text.
506 secondary.actor.SetDrawMode( DrawMode::OVERLAY ); // ensure grab handle above text
507 secondary.flipped = false;
509 secondary.grabArea = Actor::New(); // Area that Grab handle responds to, larger than actual handle so easier to move
510 #ifdef DECORATOR_DEBUG
511 secondary.grabArea.SetName("SelectionHandleTwoGrabArea");
513 secondary.grabArea.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
514 secondary.grabArea.SetSizeModeFactor( DEFAULT_SELECTION_HANDLE_RELATIVE_SIZE );
515 secondary.grabArea.SetPositionInheritanceMode( Dali::USE_PARENT_POSITION );
517 mTapDetector.Attach( secondary.grabArea );
518 mPanGestureDetector.Attach( secondary.grabArea );
519 secondary.grabArea.TouchedSignal().Connect( this, &Decorator::Impl::OnHandleTwoTouched );
521 secondary.actor.Add( secondary.grabArea );
522 mActiveLayer.Add( secondary.actor );
525 //SetUpHandlePropertyNotifications(); TODO
528 void CreateHighlight()
530 if ( !mHighlightMeshActor )
532 mHighlightMaterial = Material::New( "HighlightMaterial" );
533 mHighlightMaterial.SetDiffuseColor( mHighlightColor );
535 mHighlightMeshData.SetMaterial( mHighlightMaterial );
536 mHighlightMeshData.SetHasNormals( true );
538 mHighlightMesh = Mesh::New( mHighlightMeshData );
540 mHighlightMeshActor = MeshActor::New( mHighlightMesh );
541 #ifdef DECORATOR_DEBUG
542 mHighlightMeshActor.SetName( "HighlightMeshActor" );
544 mHighlightMeshActor.SetAnchorPoint( AnchorPoint::TOP_LEFT );
545 mHighlightMeshActor.SetPosition( 0.0f, 0.0f, DISPLAYED_HIGHLIGHT_Z_OFFSET );
547 Actor parent = mTextControlParent.Self();
548 parent.Add( mHighlightMeshActor );
552 void UpdateHighlight()
554 // Construct a Mesh with a texture to be used as the highlight 'box' for selected text
556 // Example scenarios where mesh is made from 3, 1, 2, 2 ,3 or 3 quads.
558 // [ TOP ] [ TOP ] [TOP ] [ TOP ] [ TOP ] [ TOP ]
559 // [ MIDDLE ] [BOTTOM] [BOTTOM] [ MIDDLE ] [ MIDDLE ]
560 // [ BOTTOM] [ MIDDLE ] [ MIDDLE ]
561 // [BOTTOM] [ MIDDLE ]
564 // Each quad is created as 2 triangles.
565 // Middle is just 1 quad regardless of its size.
579 if ( mHighlightMesh && mHighlightMaterial && !mHighlightQuadList.empty() )
581 MeshData::VertexContainer vertices;
582 Dali::MeshData::FaceIndices faceIndices;
584 std::vector<QuadCoordinates>::iterator iter = mHighlightQuadList.begin();
585 std::vector<QuadCoordinates>::iterator endIter = mHighlightQuadList.end();
587 // vertex position defaults to (0 0 0)
588 MeshData::Vertex vertex;
589 // set normal for all vertices as (0 0 1) pointing outward from TextInput Actor.
592 for(std::size_t v = 0; iter != endIter; ++iter,v+=4 )
594 // Add each quad geometry (a sub-selection) to the mesh data.
604 QuadCoordinates& quad = *iter;
606 vertex.x = quad.min.x;
607 vertex.y = quad.min.y;
608 vertices.push_back( vertex );
611 vertex.x = quad.max.x;
612 vertex.y = quad.min.y;
613 vertices.push_back( vertex );
616 vertex.x = quad.min.x;
617 vertex.y = quad.max.y;
618 vertices.push_back( vertex );
620 // bottom-right (v+3)
621 vertex.x = quad.max.x;
622 vertex.y = quad.max.y;
623 vertices.push_back( vertex );
625 // triangle A (3, 1, 0)
626 faceIndices.push_back( v + 3 );
627 faceIndices.push_back( v + 1 );
628 faceIndices.push_back( v );
630 // triangle B (0, 2, 3)
631 faceIndices.push_back( v );
632 faceIndices.push_back( v + 2 );
633 faceIndices.push_back( v + 3 );
635 mHighlightMeshData.SetFaceIndices( faceIndices );
638 BoneContainer bones(0); // passed empty as bones not required
639 mHighlightMeshData.SetData( vertices, faceIndices, bones, mHighlightMaterial );
640 mHighlightMesh.UpdateMeshData( mHighlightMeshData );
644 void OnTap( Actor actor, const TapGesture& tap )
646 if( actor == mGrabHandle )
652 void OnPan( Actor actor, const PanGesture& gesture )
654 if( actor == mGrabArea )
656 if( Gesture::Started == gesture.state )
658 mGrabDisplacementX = mGrabDisplacementY = 0;
661 mGrabDisplacementX += gesture.displacement.x;
662 mGrabDisplacementY += gesture.displacement.y;
664 float x = mCursor[PRIMARY_CURSOR].x + mGrabDisplacementX;
665 float y = mCursor[PRIMARY_CURSOR].y + mCursor[PRIMARY_CURSOR].lineHeight*0.5f + mGrabDisplacementY;
667 if( Gesture::Started == gesture.state ||
668 Gesture::Continuing == gesture.state )
670 mObserver.GrabHandleEvent( GRAB_HANDLE_PRESSED, x, y );
672 else if( Gesture::Finished == gesture.state ||
673 Gesture::Cancelled == gesture.state )
675 mObserver.GrabHandleEvent( GRAB_HANDLE_RELEASED, x, y );
680 bool OnHandleOneTouched( Actor actor, const TouchEvent& touch )
686 bool OnHandleTwoTouched( Actor actor, const TouchEvent& touch )
694 float AlternatePopUpPositionRelativeToCursor()
696 float alternativePosition=0.0f;;
698 if ( mPrimaryCursor ) // Secondary cursor not used for paste
700 Cursor cursor = PRIMARY_CURSOR;
701 alternativePosition = mCursor[cursor].y;
704 const float popupHeight = 120.0f; // todo Set as a MaxSize Property in Control or retrieve from CopyPastePopup class.
706 if ( mActiveGrabHandle )
708 // If grab handle enabled then position pop-up below the grab handle.
709 const Vector2 grabHandleSize( 59.0f, 56.0f ); // todo
710 const float BOTTOM_HANDLE_BOTTOM_OFFSET = 1.5; //todo Should be a property
711 alternativePosition += grabHandleSize.height + popupHeight + BOTTOM_HANDLE_BOTTOM_OFFSET ;
715 alternativePosition += popupHeight;
718 return alternativePosition;
721 void PopUpLeavesVerticalBoundary( PropertyNotification& source )
723 float alternativeYPosition=0.0f;
725 // if( mHighlightMeshActor ) // Text Selection mode
727 // alternativePosition = AlternatePopUpPositionRelativeToSelectionHandles();
729 // else // Not in Text Selection mode
731 // if can't be positioned above, then position below row.
732 alternativeYPosition = AlternatePopUpPositionRelativeToCursor();
734 mCopyPastePopup.SetY( alternativeYPosition );
738 void SetUpPopUpPositionNotifications( )
740 // Note Property notifications ignore any set anchor point so conditions must allow for this. Default is Top Left.
742 // Exceeding vertical boundary
744 Vector4 worldCoordinatesBoundingBox;
745 LocalToWorldCoordinatesBoundingBox( mBoundingBox, worldCoordinatesBoundingBox );
747 float popupHeight = mCopyPastePopup.GetRelayoutSize( Dimension::HEIGHT);
749 PropertyNotification verticalExceedNotification = mCopyPastePopup.AddPropertyNotification( Actor::Property::WORLD_POSITION_Y,
750 OutsideCondition( worldCoordinatesBoundingBox.y + popupHeight/2,
751 worldCoordinatesBoundingBox.w - popupHeight/2 ) );
753 verticalExceedNotification.NotifySignal().Connect( this, &Decorator::Impl::PopUpLeavesVerticalBoundary );
756 void GetConstrainedPopupPosition( Vector3& requiredPopupPosition, Vector3& popupSize, Vector3 anchorPoint, Actor& parent, Rect<int>& boundingBox )
758 DALI_ASSERT_DEBUG ( "Popup parent not on stage" && parent.OnStage() )
760 // Parent must already by added to Stage for these Get calls to work
761 Vector3 parentAnchorPoint = parent.GetCurrentAnchorPoint();
762 Vector3 parentWorldPositionLeftAnchor = parent.GetCurrentWorldPosition() - parent.GetCurrentSize()*parentAnchorPoint;
763 Vector3 popupWorldPosition = parentWorldPositionLeftAnchor + requiredPopupPosition; // Parent World position plus popup local position gives World Position
764 Vector3 popupDistanceFromAnchorPoint = popupSize*anchorPoint;
766 // Bounding rectangle is supplied as screen coordinates, bounding will be done in world coordinates.
767 Vector4 boundingRectangleWorld;
768 LocalToWorldCoordinatesBoundingBox( boundingBox, boundingRectangleWorld );
770 // Calculate distance to move popup (in local space) so fits within the boundary
771 float xOffSetToKeepWithinBounds = 0.0f;
772 if( popupWorldPosition.x - popupDistanceFromAnchorPoint.x < boundingRectangleWorld.x )
774 xOffSetToKeepWithinBounds = boundingRectangleWorld.x - ( popupWorldPosition.x - popupDistanceFromAnchorPoint.x );
776 else if ( popupWorldPosition.x + popupDistanceFromAnchorPoint.x > boundingRectangleWorld.z )
778 xOffSetToKeepWithinBounds = boundingRectangleWorld.z - ( popupWorldPosition.x + popupDistanceFromAnchorPoint.x );
781 // Ensure initial display of Popup is in alternative position if can not fit above. As Property notification will be a frame behind.
782 if ( popupWorldPosition.y - popupDistanceFromAnchorPoint.y < boundingRectangleWorld.y )
784 requiredPopupPosition.y = AlternatePopUpPositionRelativeToCursor();
787 requiredPopupPosition.x = requiredPopupPosition.x + xOffSetToKeepWithinBounds;
790 Internal::Control& mTextControlParent;
793 Layer mActiveLayer; // Layer for active handles and alike that ensures they are above all else.
795 unsigned int mActiveCursor;
796 bool mActiveGrabHandle;
797 bool mActiveSelection;
798 bool mActiveCopyPastePopup;
800 CursorImpl mCursor[CURSOR_COUNT];
802 Timer mCursorBlinkTimer; // Timer to signal cursor to blink
803 unsigned int mCursorBlinkInterval;
804 float mCursorBlinkDuration;
805 bool mCursorBlinkStatus; // Flag to switch between blink on and blink off
807 ImageActor mPrimaryCursor;
808 ImageActor mSecondaryCursor;
810 ImageActor mGrabHandle;
812 float mGrabDisplacementX;
813 float mGrabDisplacementY;
815 SelectionHandleImpl mSelectionHandle[SELECTION_HANDLE_COUNT];
817 MeshActor mHighlightMeshActor; ///< Mesh Actor to display highlight
818 Mesh mHighlightMesh; ///< Mesh for highlight
819 MeshData mHighlightMeshData; ///< Mesh Data for highlight
820 Material mHighlightMaterial; ///< Material used for highlight
821 Vector4 mHighlightColor; ///< Color of the highlight
822 QuadContainer mHighlightQuadList; ///< Sub-selections that combine to create the complete selection highlight
824 TextSelectionPopup mCopyPastePopup;
827 Image mGrabHandleImage;
829 TapGestureDetector mTapDetector;
830 PanGestureDetector mPanGestureDetector;
832 Rect<int> mBoundingBox;
835 DecoratorPtr Decorator::New( Internal::Control& parent, Observer& observer )
837 return DecoratorPtr( new Decorator(parent, observer) );
840 void Decorator::SetBoundingBox( const Rect<int>& boundingBox )
842 mImpl->mBoundingBox = boundingBox;
845 const Rect<int>& Decorator::GetBoundingBox() const
847 return mImpl->mBoundingBox;
850 void Decorator::Relayout( const Vector2& size, const Vector2& scrollPosition )
852 mImpl->Relayout( size, scrollPosition );
857 void Decorator::SetActiveCursor( ActiveCursor activeCursor )
859 mImpl->mActiveCursor = activeCursor;
862 unsigned int Decorator::GetActiveCursor() const
864 return mImpl->mActiveCursor;
867 void Decorator::SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight )
869 // Adjust grab handle displacement
870 mImpl->mGrabDisplacementX -= x - mImpl->mCursor[cursor].x;
871 mImpl->mGrabDisplacementY -= y - mImpl->mCursor[cursor].y;
873 mImpl->mCursor[cursor].x = x;
874 mImpl->mCursor[cursor].y = y;
875 mImpl->mCursor[cursor].cursorHeight = cursorHeight;
876 mImpl->mCursor[cursor].lineHeight = lineHeight;
879 void Decorator::GetPosition( Cursor cursor, float& x, float& y, float& cursorHeight, float& lineHeight ) const
881 x = mImpl->mCursor[cursor].x;
882 y = mImpl->mCursor[cursor].y;
883 cursorHeight = mImpl->mCursor[cursor].cursorHeight;
884 lineHeight = mImpl->mCursor[cursor].lineHeight;
887 void Decorator::SetColor( Cursor cursor, const Dali::Vector4& color )
889 mImpl->mCursor[cursor].color = color;
892 const Dali::Vector4& Decorator::GetColor( Cursor cursor ) const
894 return mImpl->mCursor[cursor].color;
897 void Decorator::StartCursorBlink()
899 if ( !mImpl->mCursorBlinkTimer )
901 mImpl->mCursorBlinkTimer = Timer::New( mImpl->mCursorBlinkInterval );
902 mImpl->mCursorBlinkTimer.TickSignal().Connect( mImpl, &Decorator::Impl::OnCursorBlinkTimerTick );
905 if ( !mImpl->mCursorBlinkTimer.IsRunning() )
907 mImpl->mCursorBlinkTimer.Start();
911 void Decorator::StopCursorBlink()
913 if ( mImpl->mCursorBlinkTimer )
915 mImpl->mCursorBlinkTimer.Stop();
919 void Decorator::SetCursorBlinkInterval( float seconds )
921 mImpl->mCursorBlinkInterval = seconds*MILLISECONDS; // Convert to milliseconds
924 float Decorator::GetCursorBlinkInterval() const
926 return mImpl->mCursorBlinkInterval;
929 void Decorator::SetCursorBlinkDuration( float seconds )
931 mImpl->mCursorBlinkDuration = seconds;
934 float Decorator::GetCursorBlinkDuration() const
936 return mImpl->mCursorBlinkDuration;
941 void Decorator::SetGrabHandleActive( bool active )
943 mImpl->mActiveGrabHandle = active;
946 bool Decorator::IsGrabHandleActive() const
948 return mImpl->mActiveGrabHandle;
951 void Decorator::SetGrabHandleImage( Dali::Image image )
953 mImpl->mGrabHandleImage = image;
956 Dali::Image Decorator::GetGrabHandleImage() const
958 return mImpl->mGrabHandleImage;
963 void Decorator::SetSelectionActive( bool active )
965 mImpl->mActiveSelection = active;
968 bool Decorator::IsSelectionActive() const
970 return mImpl->mActiveSelection;
973 void Decorator::SetPosition( SelectionHandle handle, float x, float y, float height )
975 mImpl->mSelectionHandle[handle].x = x;
976 mImpl->mSelectionHandle[handle].y = y;
977 mImpl->mSelectionHandle[handle].lineHeight = height;
980 void Decorator::GetPosition( SelectionHandle handle, float& x, float& y, float& height ) const
982 x = mImpl->mSelectionHandle[handle].x;
983 y = mImpl->mSelectionHandle[handle].y;
984 height = mImpl->mSelectionHandle[handle].lineHeight;
987 void Decorator::SetImage( SelectionHandle handle, SelectionHandleState state, Dali::Image image )
989 if( SELECTION_HANDLE_PRESSED == state )
991 mImpl->mSelectionHandle[handle].pressedImage = image;
995 mImpl->mSelectionHandle[handle].releasedImage = image;
999 Dali::Image Decorator::GetImage( SelectionHandle handle, SelectionHandleState state ) const
1001 if( SELECTION_HANDLE_PRESSED == state )
1003 return mImpl->mSelectionHandle[handle].pressedImage;
1006 return mImpl->mSelectionHandle[handle].releasedImage;
1009 void Decorator::AddHighlight( float x1, float y1, float x2, float y2 )
1011 mImpl->mHighlightQuadList.push_back( QuadCoordinates(x1, y1, x2, y2) );
1014 void Decorator::ClearHighlights()
1016 mImpl->mHighlightQuadList.clear();
1019 void Decorator::SetPopupActive( bool active )
1021 mImpl->mActiveCopyPastePopup = active;
1024 bool Decorator::IsPopupActive() const
1026 return mImpl->mActiveCopyPastePopup ;
1029 Decorator::~Decorator()
1034 Decorator::Decorator( Dali::Toolkit::Internal::Control& parent, Observer& observer )
1037 mImpl = new Decorator::Impl( parent, observer );
1042 } // namespace Toolkit