2 * Copyright (c) 2019 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/text-controls/text-label-impl.h>
22 #include <dali/public-api/object/type-registry-helper.h>
23 #include <dali/public-api/common/stage.h>
24 #include <dali/devel-api/object/property-helper-devel.h>
25 #include <dali/devel-api/adaptor-framework/image-loading.h>
26 #include <dali/integration-api/debug.h>
29 #include <dali-toolkit/public-api/text/rendering-backend.h>
30 #include <dali-toolkit/public-api/text/text-enumerations.h>
31 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
32 #include <dali-toolkit/internal/text/property-string-parser.h>
33 #include <dali-toolkit/internal/text/rendering/text-backend.h>
34 #include <dali-toolkit/internal/text/text-effects-style.h>
35 #include <dali-toolkit/internal/text/text-font-style.h>
36 #include <dali-toolkit/internal/text/text-view.h>
37 #include <dali-toolkit/internal/text/text-definitions.h>
38 #include <dali-toolkit/internal/styling/style-manager-impl.h>
40 #include <dali-toolkit/public-api/align-enumerations.h>
41 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
42 #include <dali-toolkit/devel-api/controls/control-devel.h>
43 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
44 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
45 #include <dali-toolkit/public-api/visuals/visual-properties.h>
46 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
48 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
50 using namespace Dali::Toolkit::Text;
63 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::Text::DEFAULT_RENDERING_BACKEND;
66 * @brief How the text visual should be aligned vertically inside the control.
68 * 0.0f aligns the text to the top, 0.5f aligns the text to the center, 1.0f aligns the text to the bottom.
69 * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations).
71 const float VERTICAL_ALIGNMENT_TABLE[ Text::VerticalAlignment::BOTTOM + 1 ] =
73 0.0f, // VerticalAlignment::TOP
74 0.5f, // VerticalAlignment::CENTER
75 1.0f // VerticalAlignment::BOTTOM
82 #if defined ( DEBUG_ENABLED )
83 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
86 const Scripting::StringEnum AUTO_SCROLL_STOP_MODE_TABLE[] =
88 { "IMMEDIATE", Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE },
89 { "FINISH_LOOP", Toolkit::TextLabel::AutoScrollStopMode::FINISH_LOOP },
91 const unsigned int AUTO_SCROLL_STOP_MODE_TABLE_COUNT = sizeof( AUTO_SCROLL_STOP_MODE_TABLE ) / sizeof( AUTO_SCROLL_STOP_MODE_TABLE[0] );
96 return Toolkit::TextLabel::New();
99 // Setup properties, signals and actions using the type-registry.
100 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextLabel, Toolkit::Control, Create );
102 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "renderingBackend", INTEGER, RENDERING_BACKEND )
103 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "text", STRING, TEXT )
104 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "fontFamily", STRING, FONT_FAMILY )
105 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "fontStyle", MAP, FONT_STYLE )
106 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "pointSize", FLOAT, POINT_SIZE )
107 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "multiLine", BOOLEAN, MULTI_LINE )
108 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "horizontalAlignment", STRING, HORIZONTAL_ALIGNMENT )
109 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "verticalAlignment", STRING, VERTICAL_ALIGNMENT )
110 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "unusedPropertyTextColor", VECTOR4, UNUSED_PROPERTY_TEXT_COLOR )
111 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "reservedProperty01", STRING, RESERVED_PROPERTY_01 )
112 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "reservedProperty02", STRING, RESERVED_PROPERTY_02 )
113 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "reservedProperty03", STRING, RESERVED_PROPERTY_03 )
114 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "reservedProperty04", STRING, RESERVED_PROPERTY_04 )
115 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "reservedProperty05", STRING, RESERVED_PROPERTY_05 )
116 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "enableMarkup", BOOLEAN, ENABLE_MARKUP )
117 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "enableAutoScroll", BOOLEAN, ENABLE_AUTO_SCROLL )
118 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "autoScrollSpeed", INTEGER, AUTO_SCROLL_SPEED )
119 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "autoScrollLoopCount", INTEGER, AUTO_SCROLL_LOOP_COUNT )
120 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "autoScrollGap", FLOAT, AUTO_SCROLL_GAP )
121 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "lineSpacing", FLOAT, LINE_SPACING )
122 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "underline", MAP, UNDERLINE )
123 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "shadow", MAP, SHADOW )
124 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "emboss", MAP, EMBOSS )
125 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "outline", MAP, OUTLINE )
126 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "pixelSize", FLOAT, PIXEL_SIZE )
127 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "ellipsis", BOOLEAN, ELLIPSIS )
128 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "autoScrollLoopDelay", FLOAT, AUTO_SCROLL_LOOP_DELAY )
129 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "autoScrollStopMode", STRING, AUTO_SCROLL_STOP_MODE )
130 DALI_PROPERTY_REGISTRATION_READ_ONLY( Toolkit, TextLabel, "lineCount", INTEGER, LINE_COUNT )
131 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "lineWrapMode", INTEGER, LINE_WRAP_MODE )
132 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY( Toolkit, TextLabel, "textDirection", INTEGER, TEXT_DIRECTION )
133 DALI_DEVEL_PROPERTY_REGISTRATION( Toolkit, TextLabel, "verticalLineAlignment", INTEGER, VERTICAL_LINE_ALIGNMENT )
134 DALI_DEVEL_PROPERTY_REGISTRATION( Toolkit, TextLabel, "textBackground", MAP, BACKGROUND )
135 DALI_DEVEL_PROPERTY_REGISTRATION( Toolkit, TextLabel, "ignoreSpacesAfterText", BOOLEAN, IGNORE_SPACES_AFTER_TEXT )
136 DALI_DEVEL_PROPERTY_REGISTRATION( Toolkit, TextLabel, "matchSystemLanguageDirection", BOOLEAN, MATCH_SYSTEM_LANGUAGE_DIRECTION )
137 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, TextLabel, "textColor", Color::BLACK, TEXT_COLOR )
138 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorRed", TEXT_COLOR_RED, TEXT_COLOR, 0 )
139 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorGreen", TEXT_COLOR_GREEN, TEXT_COLOR, 1 )
140 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorBlue", TEXT_COLOR_BLUE, TEXT_COLOR, 2 )
141 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorAlpha", TEXT_COLOR_ALPHA, TEXT_COLOR, 3 )
142 DALI_TYPE_REGISTRATION_END()
146 Toolkit::TextLabel TextLabel::New()
148 // Create the implementation, temporarily owned by this handle on stack
149 IntrusivePtr< TextLabel > impl = new TextLabel();
151 // Pass ownership to CustomActor handle
152 Toolkit::TextLabel handle( *impl );
154 // Second-phase init of the implementation
155 // This can only be done after the CustomActor connection has been made...
161 void TextLabel::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
163 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( Dali::BaseHandle( object ) );
167 TextLabel& impl( GetImpl( label ) );
170 case Toolkit::TextLabel::Property::RENDERING_BACKEND:
172 DALI_LOG_WARNING("[%s] Using deprecated Property TextLabel::Property::RENDERING_BACKEND which is no longer supported and will be ignored\n", __FUNCTION__);
174 int backend = value.Get< int >();
176 #ifndef ENABLE_VECTOR_BASED_TEXT_RENDERING
177 if( Text::RENDERING_VECTOR_BASED == backend )
179 backend = TextAbstraction::BITMAP_GLYPH; // Fallback to bitmap-based rendering
182 if( impl.mRenderingBackend != backend )
184 impl.mRenderingBackend = backend;
185 impl.mTextUpdateNeeded = true;
187 if( impl.mController )
189 // When using the vector-based rendering, the size of the GLyphs are different
190 TextAbstraction::GlyphType glyphType = (Text::RENDERING_VECTOR_BASED == impl.mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
191 impl.mController->SetGlyphType( glyphType );
196 case Toolkit::TextLabel::Property::TEXT:
198 if( impl.mController )
200 impl.mController->SetText( value.Get< std::string >() );
204 case Toolkit::TextLabel::Property::FONT_FAMILY:
206 if( impl.mController )
208 const std::string& fontFamily = value.Get< std::string >();
210 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::SetProperty Property::FONT_FAMILY newFont(%s)\n", fontFamily.c_str() );
211 impl.mController->SetDefaultFontFamily( fontFamily );
215 case Toolkit::TextLabel::Property::FONT_STYLE:
217 SetFontStyleProperty( impl.mController, value, Text::FontStyle::DEFAULT );
220 case Toolkit::TextLabel::Property::POINT_SIZE:
222 if( impl.mController )
224 const float pointSize = value.Get< float >();
226 if( !Equals( impl.mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ), pointSize ) )
228 impl.mController->SetDefaultFontSize( pointSize, Text::Controller::POINT_SIZE );
233 case Toolkit::TextLabel::Property::MULTI_LINE:
235 if( impl.mController )
237 impl.mController->SetMultiLineEnabled( value.Get< bool >() );
241 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
243 if( impl.mController )
245 Text::HorizontalAlignment::Type alignment( static_cast< Text::HorizontalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
246 if( Text::GetHorizontalAlignmentEnumeration( value, alignment ) )
248 impl.mController->SetHorizontalAlignment( alignment );
253 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
255 if( impl.mController )
257 Toolkit::Text::VerticalAlignment::Type alignment( static_cast< Text::VerticalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
258 if( Text::GetVerticalAlignmentEnumeration( value, alignment ) )
260 impl.mController->SetVerticalAlignment( alignment );
266 case Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR:
268 label.SetProperty( Toolkit::TextLabel::Property::TEXT_COLOR, value );
269 impl.mTextUpdateNeeded = true;
272 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
274 if( impl.mController )
276 const bool enableMarkup = value.Get<bool>();
277 impl.mController->SetMarkupProcessorEnabled( enableMarkup );
281 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
283 if( impl.mController )
285 const bool enableAutoScroll = value.Get<bool>();
286 // If request to auto scroll is the same as current state then do nothing.
287 if ( enableAutoScroll != impl.mController->IsAutoScrollEnabled() )
289 // If request is disable (false) and auto scrolling is enabled then need to stop it
290 if ( enableAutoScroll == false )
292 if( impl.mTextScroller )
294 impl.mTextScroller->StopScrolling();
297 // If request is enable (true) then start autoscroll as not already running
300 impl.mController->SetAutoScrollEnabled( enableAutoScroll );
306 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
308 if( !impl.mTextScroller )
310 impl.mTextScroller = Text::TextScroller::New( impl );
312 Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = impl.mTextScroller->GetStopMode();
313 if( Scripting::GetEnumerationProperty< Toolkit::TextLabel::AutoScrollStopMode::Type >( value,
314 AUTO_SCROLL_STOP_MODE_TABLE,
315 AUTO_SCROLL_STOP_MODE_TABLE_COUNT,
318 impl.mTextScroller->SetStopMode( stopMode );
322 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
324 if( !impl.mTextScroller )
326 impl.mTextScroller = Text::TextScroller::New( impl );
328 impl.mTextScroller->SetSpeed( value.Get<int>() );
331 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
333 if( !impl.mTextScroller )
335 impl.mTextScroller = Text::TextScroller::New( impl );
337 impl.mTextScroller->SetLoopCount( value.Get<int>() );
340 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
342 if( !impl.mTextScroller )
344 impl.mTextScroller = Text::TextScroller::New( impl );
346 impl.mTextScroller->SetLoopDelay( value.Get<float>() );
349 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
351 if( !impl.mTextScroller )
353 impl.mTextScroller = Text::TextScroller::New( impl );
355 impl.mTextScroller->SetGap( value.Get<float>() );
358 case Toolkit::TextLabel::Property::LINE_SPACING:
360 if( impl.mController )
362 const float lineSpacing = value.Get<float>();
364 // Don't trigger anything if the line spacing didn't change
365 if( impl.mController->SetDefaultLineSpacing( lineSpacing ) )
367 impl.mTextUpdateNeeded = true;
372 case Toolkit::TextLabel::Property::UNDERLINE:
374 const bool update = SetUnderlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
377 impl.mTextUpdateNeeded = true;
381 case Toolkit::TextLabel::Property::SHADOW:
383 const bool update = SetShadowProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
386 impl.mTextUpdateNeeded = true;
390 case Toolkit::TextLabel::Property::EMBOSS:
392 const bool update = SetEmbossProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
395 impl.mTextUpdateNeeded = true;
399 case Toolkit::TextLabel::Property::OUTLINE:
401 const bool update = SetOutlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
404 impl.mTextUpdateNeeded = true;
408 case Toolkit::TextLabel::Property::PIXEL_SIZE:
410 if( impl.mController )
412 const float pixelSize = value.Get< float >();
413 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p PIXEL_SIZE %f\n", impl.mController.Get(), pixelSize );
415 if( !Equals( impl.mController->GetDefaultFontSize( Text::Controller::PIXEL_SIZE ), pixelSize ) )
417 impl.mController->SetDefaultFontSize( pixelSize, Text::Controller::PIXEL_SIZE );
422 case Toolkit::TextLabel::Property::ELLIPSIS:
424 if( impl.mController )
426 const bool ellipsis = value.Get<bool>();
427 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p ELLIPSIS %d\n", impl.mController.Get(), ellipsis );
429 impl.mController->SetTextElideEnabled( ellipsis );
433 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
435 if( impl.mController )
437 Text::LineWrap::Mode lineWrapMode( static_cast< Text::LineWrap::Mode >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
438 if( GetLineWrapModeEnumeration( value, lineWrapMode ) )
440 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p LineWrap::MODE %d\n", impl.mController.Get(), lineWrapMode );
441 impl.mController->SetLineWrapMode( lineWrapMode );
446 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
448 if( impl.mController && impl.mController->GetTextModel() )
450 DevelText::VerticalLineAlignment::Type alignment = static_cast<DevelText::VerticalLineAlignment::Type>( value.Get<int>() );
452 impl.mController->SetVerticalLineAlignment( alignment );
454 // Property doesn't affect the layout, only Visual must be updated
455 TextVisual::EnableRendererUpdate( impl.mVisual );
457 // No need to trigger full re-layout. Instead call UpdateRenderer() directly
458 TextVisual::UpdateRenderer( impl.mVisual );
462 case Toolkit::DevelTextLabel::Property::BACKGROUND:
464 const bool update = SetBackgroundProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
467 impl.mTextUpdateNeeded = true;
471 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
473 impl.mController->SetIgnoreSpacesAfterText(value.Get< bool >());
476 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
478 impl.mController->SetMatchSystemLanguageDirection(value.Get< bool >());
483 // Request relayout when text update is needed. It's necessary to call it
484 // as changing the property not via UI interaction brings no effect if only
485 // the mTextUpdateNeeded is changed.
486 if( impl.mTextUpdateNeeded )
488 // need to request relayout as size of text may have changed
489 impl.RequestTextRelayout();
498 Property::Value TextLabel::GetProperty( BaseObject* object, Property::Index index )
500 Property::Value value;
502 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( Dali::BaseHandle( object ) );
506 TextLabel& impl( GetImpl( label ) );
509 case Toolkit::TextLabel::Property::RENDERING_BACKEND:
511 DALI_LOG_WARNING("[%s] Using deprecated Property TextLabel::Property::RENDERING_BACKEND which is no longer supported and will be ignored\n", __FUNCTION__);
513 value = impl.mRenderingBackend;
516 case Toolkit::TextLabel::Property::TEXT:
518 if( impl.mController )
521 impl.mController->GetText( text );
526 case Toolkit::TextLabel::Property::FONT_FAMILY:
528 if( impl.mController )
530 value = impl.mController->GetDefaultFontFamily();
534 case Toolkit::TextLabel::Property::FONT_STYLE:
536 GetFontStyleProperty( impl.mController, value, Text::FontStyle::DEFAULT );
539 case Toolkit::TextLabel::Property::POINT_SIZE:
541 if( impl.mController )
543 value = impl.mController->GetDefaultFontSize( Text::Controller::POINT_SIZE );
547 case Toolkit::TextLabel::Property::MULTI_LINE:
549 if( impl.mController )
551 value = impl.mController->IsMultiLineEnabled();
555 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
557 if( impl.mController )
559 const char* name = Text::GetHorizontalAlignmentString( impl.mController->GetHorizontalAlignment() );
563 value = std::string( name );
568 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
570 if( impl.mController )
572 const char* name = Text::GetVerticalAlignmentString( impl.mController->GetVerticalAlignment() );
575 value = std::string( name );
580 case Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR:
582 value = label.GetProperty( Toolkit::TextLabel::Property::TEXT_COLOR );
585 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
587 if( impl.mController )
589 value = impl.mController->IsMarkupProcessorEnabled();
593 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
595 if( impl.mController )
597 value = impl.mController->IsAutoScrollEnabled();
601 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
603 if( impl.mTextScroller )
605 const char* mode = Scripting::GetEnumerationName< Toolkit::TextLabel::AutoScrollStopMode::Type >( impl.mTextScroller->GetStopMode(),
606 AUTO_SCROLL_STOP_MODE_TABLE,
607 AUTO_SCROLL_STOP_MODE_TABLE_COUNT );
610 value = std::string( mode );
615 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
617 TextLabel& impl( GetImpl( label ) );
618 if ( impl.mTextScroller )
620 value = impl.mTextScroller->GetSpeed();
624 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
626 if( impl.mController )
628 TextLabel& impl( GetImpl( label ) );
629 if ( impl.mTextScroller )
631 value = impl.mTextScroller->GetLoopCount();
636 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
638 if( impl.mController )
640 TextLabel& impl( GetImpl( label ) );
641 if ( impl.mTextScroller )
643 value = impl.mTextScroller->GetLoopDelay();
648 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
650 TextLabel& impl( GetImpl( label ) );
651 if ( impl.mTextScroller )
653 value = impl.mTextScroller->GetGap();
657 case Toolkit::TextLabel::Property::LINE_SPACING:
659 if( impl.mController )
661 value = impl.mController->GetDefaultLineSpacing();
665 case Toolkit::TextLabel::Property::UNDERLINE:
667 GetUnderlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
670 case Toolkit::TextLabel::Property::SHADOW:
672 GetShadowProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
675 case Toolkit::TextLabel::Property::EMBOSS:
677 GetEmbossProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
680 case Toolkit::TextLabel::Property::OUTLINE:
682 GetOutlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
685 case Toolkit::TextLabel::Property::PIXEL_SIZE:
687 if( impl.mController )
689 value = impl.mController->GetDefaultFontSize( Text::Controller::PIXEL_SIZE );
693 case Toolkit::TextLabel::Property::ELLIPSIS:
695 if( impl.mController )
697 value = impl.mController->IsTextElideEnabled();
701 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
703 if( impl.mController )
705 value = impl.mController->GetLineWrapMode();
709 case Toolkit::TextLabel::Property::LINE_COUNT:
711 if( impl.mController )
713 float width = label.GetProperty( Actor::Property::SIZE_WIDTH ).Get<float>();
714 value = impl.mController->GetLineCount( width );
718 case Toolkit::DevelTextLabel::Property::TEXT_DIRECTION:
720 if( impl.mController )
722 value = impl.mController->GetTextDirection();
726 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
728 if( impl.mController )
730 value = impl.mController->GetVerticalLineAlignment();
734 case Toolkit::DevelTextLabel::Property::BACKGROUND:
736 GetBackgroundProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
739 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
741 value = impl.mController->IsIgnoreSpacesAfterText();
744 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
746 value = impl.mController->IsMatchSystemLanguageDirection();
755 void TextLabel::OnInitialize()
759 Property::Map propertyMap;
760 propertyMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
762 mVisual = Toolkit::VisualFactory::Get().CreateVisual( propertyMap );
763 DevelControl::RegisterVisual( *this, Toolkit::TextLabel::Property::TEXT, mVisual );
765 TextVisual::SetAnimatableTextColorProperty( mVisual, Toolkit::TextLabel::Property::TEXT_COLOR );
767 mController = TextVisual::GetController(mVisual);
770 mController->SetControlInterface(this);
773 // Use height-for-width negotiation by default
774 self.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH );
775 self.SetResizePolicy( ResizePolicy::DIMENSION_DEPENDENCY, Dimension::HEIGHT );
777 // Enable the text ellipsis.
778 mController->SetTextElideEnabled( true ); // If false then text larger than control will overflow
780 // Sets layoutDirection value
781 Dali::Stage stage = Dali::Stage::GetCurrent();
782 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( stage.GetRootLayer().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
783 mController->SetLayoutDirection( layoutDirection );
785 Layout::Engine& engine = mController->GetLayoutEngine();
786 engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
789 void TextLabel::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
791 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::OnStyleChange\n");
795 case StyleChange::DEFAULT_FONT_CHANGE:
797 // Property system did not set the font so should update it.
798 const std::string& newFont = GetImpl( styleManager ).GetDefaultFontFamily();
799 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnStyleChange StyleChange::DEFAULT_FONT_CHANGE newFont(%s)\n", newFont.c_str() );
800 mController->UpdateAfterFontChange( newFont );
804 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
806 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
810 case StyleChange::THEME_CHANGE:
812 // Nothing to do, let control base class handle this
817 // Up call to Control
818 Control::OnStyleChange( styleManager, change );
821 Vector3 TextLabel::GetNaturalSize()
824 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
826 Vector3 naturalSize = mController->GetNaturalSize();
827 naturalSize.width += ( padding.start + padding.end );
828 naturalSize.height += ( padding.top + padding.bottom );
833 float TextLabel::GetHeightForWidth( float width )
836 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
838 return mController->GetHeightForWidth( width ) + padding.top + padding.bottom;
841 void TextLabel::OnPropertySet( Property::Index index, Property::Value propertyValue )
843 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::OnPropertySet index[%d]\n", index );
847 case Toolkit::TextLabel::Property::TEXT_COLOR:
849 const Vector4& textColor = propertyValue.Get< Vector4 >();
850 if( mController->GetDefaultColor() != textColor )
852 mController->SetDefaultColor( textColor );
853 mTextUpdateNeeded = true;
859 Control::OnPropertySet( index, propertyValue ); // up call to control for non-handled properties
865 void TextLabel::OnRelayout( const Vector2& size, RelayoutContainer& container )
867 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnRelayout\n" );
870 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
872 Vector2 contentSize( size.x - ( padding.start + padding.end ), size.y - ( padding.top + padding.bottom ) );
874 // Support Right-To-Left
875 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
877 const Text::Controller::UpdateTextType updateTextType = mController->Relayout( contentSize, layoutDirection );
879 if( ( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType ) )
880 || mTextUpdateNeeded )
882 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnRelayout IsAutoScrollEnabled[%s] [%p]\n", ( mController->IsAutoScrollEnabled())?"true":"false", this );
885 TextVisual::EnableRendererUpdate( mVisual );
887 // Support Right-To-Left of padding
888 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
890 std::swap( padding.start, padding.end );
893 // Calculate the size of the visual that can fit the text
894 Size layoutSize = mController->GetTextModel()->GetLayoutSize();
895 layoutSize.x = contentSize.x;
897 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
898 if ( shadowOffset.y > Math::MACHINE_EPSILON_1 )
900 layoutSize.y += shadowOffset.y;
903 float outlineWidth = mController->GetTextModel()->GetOutlineWidth();
904 layoutSize.y += outlineWidth * 2.0f;
905 layoutSize.y = std::min( layoutSize.y, contentSize.y );
907 // Calculate the offset for vertical alignment only, as the layout engine will do the horizontal alignment.
908 Vector2 alignmentOffset;
909 alignmentOffset.x = 0.0f;
910 alignmentOffset.y = ( contentSize.y - layoutSize.y ) * VERTICAL_ALIGNMENT_TABLE[mController->GetVerticalAlignment()];
912 Property::Map visualTransform;
913 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, layoutSize )
914 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
915 .Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( padding.start, padding.top ) + alignmentOffset )
916 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
917 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
918 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
919 mVisual.SetTransformAndSize( visualTransform, size );
921 if ( mController->IsAutoScrollEnabled() )
923 SetUpAutoScrolling();
926 mTextUpdateNeeded = false;
930 void TextLabel::RequestTextRelayout()
933 // Signal that a Relayout may be needed
936 void TextLabel::SetUpAutoScrolling()
938 const Size& controlSize = mController->GetView().GetControlSize();
939 const Size textNaturalSize = GetNaturalSize().GetVectorXY(); // As relayout of text may not be done at this point natural size is used to get size. Single line scrolling only.
940 const Text::CharacterDirection direction = mController->GetAutoScrollDirection();
942 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling textNaturalSize[%f,%f] controlSize[%f,%f]\n",
943 textNaturalSize.x,textNaturalSize.y , controlSize.x,controlSize.y );
945 if ( !mTextScroller )
947 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling Creating default TextScoller\n" );
949 // If speed, loopCount or gap not set via property system then will need to create a TextScroller with defaults
950 mTextScroller = Text::TextScroller::New( *this );
953 // Calculate the actual gap before scrolling wraps.
954 int textPadding = std::max( controlSize.x - textNaturalSize.x, 0.0f );
955 float wrapGap = std::max( mTextScroller->GetGap(), textPadding );
956 Vector2 textureSize = textNaturalSize + Vector2(wrapGap, 0.0f); // Add the gap as a part of the texture
958 // Create a texture of the text for scrolling
959 Size verifiedSize = textureSize;
960 const int maxTextureSize = Dali::GetMaxTextureSize();
962 //if the texture size width exceed maxTextureSize, modify the visual model size and enabled the ellipsis
963 if( verifiedSize.width > maxTextureSize )
965 verifiedSize.width = maxTextureSize;
966 if( textNaturalSize.width > maxTextureSize )
968 mController->SetTextElideEnabled( true );
970 GetHeightForWidth( maxTextureSize );
971 wrapGap = std::max( maxTextureSize - textNaturalSize.width, 0.0f );
974 Text::TypesetterPtr typesetter = Text::Typesetter::New( mController->GetTextModel() );
976 PixelData data = typesetter->Render( verifiedSize, mController->GetTextDirection(), Text::Typesetter::RENDER_TEXT_AND_STYLES, true, Pixel::RGBA8888 ); // ignore the horizontal alignment
977 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
978 data.GetPixelFormat(),
981 texture.Upload( data );
983 TextureSet textureSet = TextureSet::New();
984 textureSet.SetTexture( 0u, texture );
986 // Filter mode needs to be set to linear to produce better quality while scaling.
987 Sampler sampler = Sampler::New();
988 sampler.SetFilterMode( FilterMode::LINEAR, FilterMode::LINEAR );
989 sampler.SetWrapMode( Dali::WrapMode::DEFAULT, Dali::WrapMode::REPEAT, Dali::WrapMode::DEFAULT ); // Wrap the texture in the x direction
990 textureSet.SetSampler( 0u, sampler );
992 // Set parameters for scrolling
993 Renderer renderer = static_cast<Internal::Visual::Base&>( GetImplementation( mVisual ) ).GetRenderer();
994 mTextScroller->SetParameters( Self(), renderer, textureSet, controlSize, verifiedSize, wrapGap, direction, mController->GetHorizontalAlignment(), mController->GetVerticalAlignment() );
997 void TextLabel::ScrollingFinished()
999 // Pure Virtual from TextScroller Interface
1000 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::ScrollingFinished\n");
1001 mController->SetAutoScrollEnabled( false );
1002 mController->SetTextElideEnabled( true );
1003 RequestTextRelayout();
1006 TextLabel::TextLabel()
1007 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
1008 mRenderingBackend( DEFAULT_RENDERING_BACKEND ),
1009 mTextUpdateNeeded( false )
1013 TextLabel::~TextLabel()
1017 } // namespace Internal
1019 } // namespace Toolkit