flutter::ParagraphBuilder Class Reference

#include <paragraph_builder.h>

Inheritance diagram for flutter::ParagraphBuilder:

Public Member Functions
	~ParagraphBuilder () override
void	pushStyle (const tonic::Int32List &encoded, const std::vector< std::string > &fontFamilies, double fontSize, double letterSpacing, double wordSpacing, double height, double decorationThickness, const std::string &locale, Dart_Handle background_objects, Dart_Handle background_data, Dart_Handle foreground_objects, Dart_Handle foreground_data, Dart_Handle shadows_data, Dart_Handle font_features_data, Dart_Handle font_variations_data)
void	pop ()
Dart_Handle	addText (const std::u16string &text)
void	addPlaceholder (double width, double height, unsigned alignment, double baseline_offset, unsigned baseline)
void	build (Dart_Handle paragraph_handle)
Public Member Functions inherited from flutter::RefCountedDartWrappable< ParagraphBuilder >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< ParagraphBuilder >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
virtual void	RetainDartWrappableReference () const =0
virtual void	ReleaseDartWrappableReference () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Static Public Member Functions
static void	Create (Dart_Handle wrapper, Dart_Handle encoded_handle, Dart_Handle strutData, const std::string &fontFamily, const std::vector< std::string > &strutFontFamilies, double fontSize, double height, const std::u16string &ellipsis, const std::string &locale)

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< ParagraphBuilder >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 20 of file paragraph_builder.h.

Constructor & Destructor Documentation

~ParagraphBuilder()

flutter::ParagraphBuilder::~ParagraphBuilder ( )

overridedefault

Member Function Documentation

addPlaceholder()

void flutter::ParagraphBuilder::addPlaceholder	(	double	width,
		double	height,
		unsigned	alignment,
		double	baseline_offset,
		unsigned	baseline
	)

Definition at line 521 of file paragraph_builder.cc.

                                                         {
  txt::PlaceholderRun placeholder_run(
      width, height, static_cast<txt::PlaceholderAlignment>(alignment),
      static_cast<txt::TextBaseline>(baseline), baseline_offset);
 
  m_paragraph_builder_->AddPlaceholder(placeholder_run);
}

addText()

Dart_Handle flutter::ParagraphBuilder::addText

(

const std::u16string &

text

)

Definition at line 501 of file paragraph_builder.cc.

                                                              {
  if (text.empty()) {
    return Dart_Null();
  }
 
  // Use ICU to validate the UTF-16 input.  Calling u_strToUTF8 with a null
  // output buffer will return U_BUFFER_OVERFLOW_ERROR if the input is well
  // formed.
  const UChar* text_ptr = reinterpret_cast<const UChar*>(text.data());
  UErrorCode error_code = U_ZERO_ERROR;
  u_strToUTF8(nullptr, 0, nullptr, text_ptr, text.size(), &error_code);
  if (error_code != U_BUFFER_OVERFLOW_ERROR) {
    return tonic::ToDart("string is not well-formed UTF-16");
  }
 
  m_paragraph_builder_->AddText(text);
 
  return Dart_Null();
}

build()

void flutter::ParagraphBuilder::build

(

Dart_Handle

paragraph_handle

)

Definition at line 533 of file paragraph_builder.cc.

                                                         {
  Paragraph::Create(paragraph_handle, m_paragraph_builder_->Build());
  m_paragraph_builder_.reset();
  ClearDartWrapper();
}

Create()

void flutter::ParagraphBuilder::Create ( Dart_Handle  wrapper, Dart_Handle  encoded_handle, Dart_Handle  strutData, const std::string &  fontFamily, const std::vector< std::string > &  strutFontFamilies, double  fontSize, double  height, const std::u16string &  ellipsis, const std::string &  locale  )

static

Definition at line 148 of file paragraph_builder.cc.

                                                       {
  UIDartState::ThrowIfUIOperationsProhibited();
  auto res = fml::MakeRefCounted<ParagraphBuilder>(
      encoded_handle, strutData, fontFamily, strutFontFamilies, fontSize,
      height, ellipsis, locale);
  res->AssociateWithDartWrapper(wrapper);
}

pop()

void flutter::ParagraphBuilder::pop

(

)

Definition at line 497 of file paragraph_builder.cc.

                           {
  m_paragraph_builder_->Pop();
}

pushStyle()

void flutter::ParagraphBuilder::pushStyle	(	const tonic::Int32List &	encoded,
		const std::vector< std::string > &	fontFamilies,
		double	fontSize,
		double	letterSpacing,
		double	wordSpacing,
		double	height,
		double	decorationThickness,
		const std::string &	locale,
		Dart_Handle	background_objects,
		Dart_Handle	background_data,
		Dart_Handle	foreground_objects,
		Dart_Handle	foreground_data,
		Dart_Handle	shadows_data,
		Dart_Handle	font_features_data,
		Dart_Handle	font_variations_data
	)

Definition at line 370 of file paragraph_builder.cc.

                                                                   {
  FML_DCHECK(encoded.num_elements() == 9);
 
  int32_t mask = encoded[0];
 
  // Set to use the properties of the previous style if the property is not
  // explicitly given.
  txt::TextStyle style = m_paragraph_builder_->PeekStyle();
 
  style.half_leading = mask & kTSLeadingDistributionMask;
  // Only change the style property from the previous value if a new explicitly
  // set value is available
  if (mask & kTSColorMask) {
    style.color = encoded[kTSColorIndex];
  }
 
  if (mask & kTSTextDecorationMask) {
    style.decoration =
        static_cast<txt::TextDecoration>(encoded[kTSTextDecorationIndex]);
  }
 
  if (mask & kTSTextDecorationColorMask) {
    style.decoration_color = encoded[kTSTextDecorationColorIndex];
  }
 
  if (mask & kTSTextDecorationStyleMask) {
    style.decoration_style = static_cast<txt::TextDecorationStyle>(
        encoded[kTSTextDecorationStyleIndex]);
  }
 
  if (mask & kTSTextDecorationThicknessMask) {
    style.decoration_thickness_multiplier = decorationThickness;
  }
 
  if (mask & kTSTextBaselineMask) {
    // TODO(abarth): Implement TextBaseline. The CSS version of this
    // property wasn't wired up either.
  }
 
  if (mask & (kTSFontWeightMask | kTSFontStyleMask | kTSFontSizeMask |
              kTSLetterSpacingMask | kTSWordSpacingMask)) {
    if (mask & kTSFontWeightMask) {
      style.font_weight =
          static_cast<txt::FontWeight>(encoded[kTSFontWeightIndex]);
    }
 
    if (mask & kTSFontStyleMask) {
      style.font_style =
          static_cast<txt::FontStyle>(encoded[kTSFontStyleIndex]);
    }
 
    if (mask & kTSFontSizeMask) {
      style.font_size = fontSize;
    }
 
    if (mask & kTSLetterSpacingMask) {
      style.letter_spacing = letterSpacing;
    }
 
    if (mask & kTSWordSpacingMask) {
      style.word_spacing = wordSpacing;
    }
  }
 
  if (mask & kTSHeightMask) {
    style.height = height;
    style.has_height_override = style.height != kTextHeightNone;
  }
 
  if (mask & kTSLocaleMask) {
    style.locale = locale;
  }
 
  if (mask & kTSBackgroundMask) {
    Paint background(background_objects, background_data);
    if (background.isNotNull()) {
      DlPaint dl_paint;
      background.toDlPaint(dl_paint);
      style.background = dl_paint;
    }
  }
 
  if (mask & kTSForegroundMask) {
    Paint foreground(foreground_objects, foreground_data);
    if (foreground.isNotNull()) {
      DlPaint dl_paint;
      foreground.toDlPaint(dl_paint);
      style.foreground = dl_paint;
    }
  }
 
  if (mask & kTSTextShadowsMask) {
    decodeTextShadows(shadows_data, style.text_shadows);
  }
 
  if (mask & kTSFontFamilyMask) {
    // The child style's font families override the parent's font families.
    // If the child's fonts are not available, then the font collection will
    // use the system fallback fonts (not the parent's fonts).
    style.font_families = fontFamilies;
  }
 
  if (mask & kTSFontFeaturesMask) {
    decodeFontFeatures(font_features_data, style.font_features);
  }
 
  if (mask & kTSFontVariationsMask) {
    decodeFontVariations(font_variations_data, style.font_variations);
  }
 
  m_paragraph_builder_->PushStyle(style);
}

---

The documentation for this class was generated from the following files:

• lib/ui/text/paragraph_builder.h
• lib/ui/text/paragraph_builder.cc