Inheritance diagram

Collaboration diagram

Description

How to use

SFYMultipleTextWidget is a responder with the function of displaying a multiple uneditable text.

In general, this class is used as a child responder contained internally by the parent responder such as SFZMultipleTextLabelControl, SFZMultipleTextBoxControl, or SFYMultipleEditWidget, which will display a multiple text.

In these responders, all processings such as setting a multiple text, its color, its font, its alignment, or its scroll are delegated to this class.

	The state of this responder when used
	When this class is used, its state is set to "visible"+"active"+"disable"+"unfocus". In general, this class is used as a responder which will not handle the key event.

	Default value of the transparency attribute
	Since the default value of the transparency attribute of this class is set to "true", the background will be never drawn in the color set with the SFYWidget::SetBackgroundColor function unless the transparency attribute is set to "false" using the SFYResponder::SetPropertyTransparent function.

About the virtual region

In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, when [Width of virtual region] ＞ [Width of real region] stands up, the left edge, the right edge, or both the edges of the row which is longer than [width of virtual region] cannot be displayed on the device screen since the text is turned down by this width. And tt cannot be displayed by scrolling left or right. Suppose the following relation stands up. [Height of virtual region] ≧ [Height of multiple text] ＞ [Height of real region] In this case, though all the text is not displayed, the multiple text will not scroll even if the UP key or the DOWN key is pressed.

Calling GetSuitableBound() without specifying its argument

When calling the SFYResponder::GetSuitableBound function of this responder without specifying its argument, it is necessary to set the real region (local region*) using the SFYResponder::SetRealBound function in advance. The width of this real region will be used as a hint value for calculating the suitable region size of this responder. In almost all cases, the value more than the width of currently used font is set. * Unless the virtual region is set, the real region is the same with the local region. Reference: Getting the Suitable Size of Responder for Displaying a Multiple Text

Reference

SFZMultipleTextLabelControl | SFZMultipleTextBoxControl | SFYMultipleEditWidget | Virtual Region | Real Region | Local Region | Getting the Suitable Size of Responder for Displaying a Multiple Text

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFYResponder::SetPropertyTransparent | SFYMultipleTextWidget::CodeEnum | SFYMultipleTextWidget::SetFont | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetTextColor | SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::SetScrollStep | SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::HorizontalEnum | SFYMultipleTextWidget::VerticalEnum | SFYMultipleTextWidget::DefaultEnum | SFXRGBColor | Type | Attribute

Description

This destructor does nothing.

Description

This function draws the multiple text.

In case you want to perform your own processing, override this function.

	Note
	This function is called in the SFYMultipleTextWidget::HandleRenderRequest function

Internal Implementation

Internal implementation of the SFYMultipleTextWidget::DrawText function is as follows:

/*protected */Void SFYMultipleTextWidget::DrawText(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    SFXRectangle                                lx;
    SFXGrid                                     origin;
    SFXRGBColor                                 rgb;

    lx.Set(GetLocalBound());
    origin.Set(grid);
    origin.AddY(_offset);
    rgb.Set(_color.text);
    if (!GetStateActive(true)) {
        if (rgb.GetBrightness() > 0x7F) {
            rgb.SubRGB(0x44);
        }
        else {
            rgb.AddRGB(0x44);
        }
    }
    graphics->SetFont(_font);
    switch (_align.horizontal) {
        case HORIZONTAL_LEFT:
            graphics->DrawMultipleTextLeft(_text, lx, origin, rgb, lx.GetWidth());
            break;
        case HORIZONTAL_RIGHT:
            graphics->DrawMultipleTextRight(_text, lx, origin, rgb, lx.GetWidth());
            break;
        case HORIZONTAL_CENTER:
        default:
            graphics->DrawMultipleTextCenter(_text, lx, origin, rgb, lx.GetWidth());
            break;
    }
    return;
}// SFYMultipleTextWidget::DrawText //

Reference

SFYMultipleTextWidget::HandleRenderRequest

Description

This function gets the font.

Reference

SFYMultipleTextWidget::SetFont

Description

This function gets the size of one character of the current font(the ' ' character is used).

Reference

SFYMultipleTextWidget::SetFont

Return value

Value of the horizontal alignment.

Reference

SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::HorizontalEnum

Return value

Value of the scroll-offset.

Description

This function gets the offset from the origin as a result of scroll.

Return value

Scroll-step. [pixels]

Reference

SFYMultipleTextWidget::SetScrollStep

Reference

SFYMultipleTextWidget::SetText

Reference

SFYMultipleTextWidget::SetTextColor | SFXRGBColor

Description

This function gets the size of the text when it will be drawn with the current font.

Reference

SFYMultipleTextWidget::SetFont

Return value

Value of the vertical alignment.

Reference

SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::VerticalEnum

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] is received.

This function calculates the suitable rectangle size of this responder within the specified hint rectangle[i.e., rectangle element (P32 parameter) of the region event].

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin of the rectangle argument in this function.

	Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event]
	If the rectangle argument of the hint region is specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] to this responder. Then, the SFYWidget::HandleBoundOptimize virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the hint region as an initial value.

Internal Implementation

Internal implementation of the SFYMultipleTextWidget::HandleBoundOptimize function is as follows:

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXRectangle                                bound;
    SFXSize                                     size;

    bound.SetSize(SFXSize::ZeroInstance());
    size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, rectangle->GetWidth()));
    }
    if (rectangle->GetWidth() > bound.GetWidth()) {
        rectangle->SetWidth(bound.GetWidth());
    }
    else if (rectangle->GetWidth() > size.GetWidth()) {
        rectangle->DivWidth(size.GetWidth());
        rectangle->MulWidth(size.GetWidth());
    }
    if (rectangle->GetHeight() > bound.GetHeight()) {
        rectangle->SetHeight(bound.GetHeight());
    }
    else if (rectangle->GetHeight() > size.GetHeight()) {
        rectangle->DivHeight(size.GetHeight());
        rectangle->MulHeight(size.GetHeight());
    }
    return;
}// SFYMultipleTextWidget::HandleBoundOptimize //

Reference

SFYResponder::GetSuitableBound | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetFont | SFXGraphics::MeasureMultipleText | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event is received.

In case you want to perform your own processing when the real region is updated, override this function.

The default implementation is to equalize the virtual region with the real region.

About the virtual region

In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, when [Width of virtual region] ＞ [Width of real region] stands up, the left edge, the right edge, or both the edges of the row which is longer than [width of virtual region] cannot be displayed on the device screen since the text is turned down by this width. And tt cannot be displayed by scrolling left or right. Suppose the following relation stands up. [Height of virtual region] ≧ [Height of multiple text] ＞ [Height of real region] In this case, though all the text is not displayed, the multiple text will not scroll even if the UP key or the DOWN key is pressed.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event will occur when the real region is changed by calling the SFYResponder::SetRealBound function.

Processing when the real region is changed

Other than overriding this virtual function, there is another method to define and implement the handler for the region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the real region is updated, this virtual function is executed first, and next the handlers for the region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for the region event can be omitted.

Internal Implementation

Internal implementation of the SFYMultipleTextWidget::HandleBoundReal function is as follows:

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYMultipleTextWidget::HandleBoundReal //

Reference

SFYResponder::SetRealBound | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Real Region | Virtual Region | Local Region

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] is received.

This function calculates the suitable rectangle size of this responder.

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin element of the rectangle argument within this function.

Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event]

If the rectangle argument of the hint region is not specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] to this responder. Then, the SFYWidget::HandleBoundRequest virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the real region as an initial value. Tip Default value of the real region: SFXRectangle(0, 0, 0, 0)

Internal Implementation

Internal implementation of the SFYMultipleTextWidget::HandleBoundRequest function is as follows:

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->SetSize(_bound.GetSize());
    return;
}// SFYMultipleTextWidget::HandleBoundRequest //

/*private */SInt16 SFYMultipleTextWidget::Measure(Void)
{
    _bound.SetSize(SFXSize::ZeroInstance());
    _size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        _bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, GetLocalBound().GetWidth()));
    }
    return _size.GetHeight();
}// SFYMultipleTextWidget::Measure //

Reference

SFYResponder::GetSuitableBound | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetFont | SFXGraphics::MeasureMultipleText | Real Region | Local Region | Virtual Region | Getting the Suitable Size of Responder for Displaying a Multiple Text | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

In case you want to perform your own processing when the virtual region is changed, override this virtual function.

The default implementation is to equalize the real region with the new local region and relocate this responder to fit into the new virtual region.

About the virtual region

In this class, it is recommended to equalize the virtual region with the real region for the intuitive text alignment or scroll. For instance, when [Width of virtual region] ＞ [Width of real region] stands up, the left edge, the right edge, or both the edges of the row which is longer than [width of virtual region] cannot be displayed on the device screen since the text is turned down by this width. And tt cannot be displayed by scrolling left or right. Suppose the following relation stands up. [Height of virtual region] ≧ [Height of multiple text] ＞ [Height of real region] In this case, though all the text is not displayed, the multiple text will not scroll even if the UP key or the DOWN key is pressed.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event will occur when the virtual region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function.

Another method when the virtual region is changed

Other than overriding this virtual function, it is possible to define and implement the handler for region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the virtual region is updated, this virtual function is executed first, and next the handlers for region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for region event can be omitted.

Internal Implementation

Internal implementation of the SFYMultipleTextWidget::HandleBoundVirtual function is as follows:

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundVirtual(Void)
{
    Measure();
    Relocate();
    return;
}// SFYMultipleTextWidget::HandleBoundVirtual //

/*private */SInt16 SFYMultipleTextWidget::Measure(Void)
{
    _bound.SetSize(SFXSize::ZeroInstance());
    _size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        _bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, GetLocalBound().GetWidth()));
    }
    return _size.GetHeight();
}// SFYMultipleTextWidget::Measure //

/*private */Void SFYMultipleTextWidget::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    _offset = 0;
    if (lx.GetHeight() > _bound.GetHeight()) {
        switch (_align.vertical) {
            case VERTICAL_TOP:
                _bound.AddY(0);
                break;
            case VERTICAL_BOTTOM:
                _bound.AddY(lx.GetHeight() - _bound.GetHeight());
                break;
            case VERTICAL_MIDDLE:
            default:
                _bound.AddY((lx.GetHeight() - _bound.GetHeight()) / 2);
                break;
        }
    }
    else {
        switch (_align.vertical) {
            case VERTICAL_TOP:
                _offset += 0;
                break;
            case VERTICAL_BOTTOM:
                _offset += lx.GetHeight() - _bound.GetHeight();
                break;
            case VERTICAL_MIDDLE:
            default:
                _offset += (lx.GetHeight() - _bound.GetHeight()) / 2;
                break;
        }
    }
    _bound.AddY(SFXGraphics::GetFontDescent(_font) / 2);
    return;
}// SFYMultipleTextWidget::Relocate //

Reference

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Virtual Region | Real Region | Local Region

Description

This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received.

In case you want to perform your own drawing of this responder, override this function.

The default implementation is to draw this responder.

The method to darw a responder

In addition to overriding this virtual function, it is possible to define and implement the handler for drawing event(drawing handler)[XANDLER_DECLARE_VOIDRENDER], and register it into the responder. Then, the overridden virtual function will be called first, and next the drawing handlers registered into the responder will be booted up in the registered order. In almost all cases, the method to override this function is used to draw the responder since there is no need to declare and register the drawing handler.

Procedure of drawing a responder

The drawing handler will be booted up when the drawing event(SFEVT_RESPONDER_RENDER) occurs. And then the drawing handler draw the responder actually. The drawing event will be sent to only the responders including the region to be redrawn out of the redraw regions registered into the renderer using the SFYResponder::InvokeBackward function after the SFYResponder::Render function boots up the renderer. Here, the SFYResponder::Render function will be called at the following situations: At the end of the event loop At the applet start / resume or the end of a highest priority event handler In the callback, which is outside the event loop. If calling the SFYResponder::Render function with specifying "true" as an argument, the drawing event will be sent to all the responders to be actually displayed on the screen which are located below the responder in the responder tree, regardless of the registration of redraw region.

Internal Implementation

Internal implementation of the SFYMultipleTextWidget::HandleRenderRequest function is as follows:

/*protected virtual */Void SFYMultipleTextWidget::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawText(graphics, _bound.GetOrigin());
    return;
}// SFYMultipleTextWidget::HandleRenderRequest //

Reference

SFYMultipleTextWidget::DrawText | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::SetTextColor | SFYMultipleTextWidget::SetFont | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree | Virtual Region | Real Region | Local Region

Argument

Return value

Description

This function creates a new instance of this responder class.

If succeeds, a not null pointer will be returned, and the "exception" argument is SFERR_NO_ERROR. If fails such as insufficient memory, a null pointer will be returned, and the "exception" argument holds the error value.

Example

The code to create a new instance of this responder class is as follows:

SFYMultipleTextWidgetSmp _multipletextwidget;
SFCError error;

if ((_multipletextwidget = SFYMultipleTextWidget::NewInstance(&error)) != null) {

    ...
}

Return value

Reference

SFYMultipleTextWidget::PageUp | Local Region

Return value

Reference

SFYMultipleTextWidget::PageDown | Local Region

Return value

Reference

SFYMultipleTextWidget::SetScrollStep | SFYMultipleTextWidget::ScrollUp | Local Region

Return value

Reference

SFYMultipleTextWidget::SetScrollStep | SFYMultipleTextWidget::ScrollDown | Local Region

Description

Default: AEE_FONT_NORMAL

Reference

SFYMultipleTextWidget::GetFont

Description

This function sets the horizontal alignment to the specified value.

Default: SFYMultipleTextWidget::DEFAULT_HORIZONTAL

For the value of SFYMultipleTextWidget::DEFAULT_HORIZONTAL, refer to SFYMultipleTextWidget::HorizontalEnum.

Reference

SFYMultipleTextWidget::GetHorizontalAlign | SFYMultipleTextWidget::HorizontalEnum

Description

This function sets the number of pixels of each scroll. If "-1"(this is default value) is set, the height of the " " character of the currently used font will be the scroll-step.

Default: SFYMultipleTextWidget::DEFAULT_STEP [pixels]

For the value of SFYMultipleTextWidget::DEFAULT_STEP, refer to SFYMultipleTextWidget::DefaultEnum.

Reference

SFYMultipleTextWidget::GetScrollStep | SFYMultipleTextWidget::DefaultEnum

Return value

Description

This function sets the text to be displayed to the specified value.

The value of string is set directly in the argument, or read from the resource file.

Reference

SFYMultipleTextWidget::GetText | SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::SetTextColor | SFYMultipleTextWidget::SetFont

Description

Default: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[black color]

In the "inactive" state, the text will be drawn in the color of which each RGB value is subtracted 0x44 from the color set with this function if the brightness of this color is greater than 0x7F. Otherwise it will be drawn in the color of which each RGB value is added 0x44 on the color set with this function.

The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

Reference

SFYMultipleTextWidget::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the vertical alignment to the specified value.

Default: SFYMultipleTextWidget::DEFAULT_VERTICAL

For the value of SFYMultipleTextWidget::DEFAULT_VERTICAL, refer to SFYMultipleTextWidget::VerticalEnum.

Reference

SFYMultipleTextWidget::GetVerticalAlign | SFYMultipleTextWidget::VerticalEnum

Description

This function puts back the scroll position of the multiple text to the initial state, which is set with the SetVerticalAlign() function.

The execution result of this function differs as below depending on the settings of the SetVerticalAlign() function.

If both of the top and the bottom of the multiple text are placed in the local region, the scroll position will be the same.

Reference

SFYMultipleTextWidget::SetVerticalAlign

Return value

Reference

SFYMultipleTextWidget::SnapUp | Local Region

Return value

Reference

SFYMultipleTextWidget::SnapDown | Local Region

Reference

SFYResponder::GetType | SFYResponder::SetType

Description

DEFAULT_STEP is the number of pixels of each scroll-step. If "-1"(this is the default value) is set, the height of the " " character of the currently used font will be set to the scroll-step.

Description

For the horizontal alignment:

Each line of the multiple text is turned down by the width of its local region. As a result, the length of the last remainder part of each line will be less than the width of the local region.

This last remainder part can be aligned in the horizontal direction by specifying the horizontal alignment of the multiple text.

	Note
	The horizontal alignment of the multiple text is the same with that of the word processor or spreadsheet.

Reference

SFYMultipleTextWidget::SetHorizontalAlign | Local Region

Description

For the vertical alignment:

Each line of the multiple text is turned down by the width of its local region. As a result, the minimum rectangular region including this text can be supposed.

This rectangular region can be aligned in the vertical direction by specifying the vertical alignment of the multiple text.

Reference

SFYMultipleTextWidget::SetVerticalAlign | Local Region