Package docking.widgets.fieldpanel.field

Class WrappingVerticalLayoutTextField

java.lang.Object

docking.widgets.fieldpanel.field.VerticalLayoutTextField

docking.widgets.fieldpanel.field.WrappingVerticalLayoutTextField

All Implemented Interfaces:

Field, TextField

Direct Known Subclasses:

ClangTextField

public class WrappingVerticalLayoutTextField
extends VerticalLayoutTextField

A text field meant to take a string of text and wrap as needed.

Field Summary

Fields inherited from class docking.widgets.fieldpanel.field.VerticalLayoutTextField

hlFactory, isClipped, preferredWidth, startX, subFields, width

Constructor Summary

Constructors

Constructor	Description
WrappingVerticalLayoutTextField(FieldElement textElement, int startX, int width, int maxLines, HighlightFactory hlFactory)	This constructor will create a text field from an single AttributedString.
WrappingVerticalLayoutTextField(FieldElement textElement, int startX, int width, int maxLines, HighlightFactory hlFactory, boolean breakOnWhiteSpace)	This constructor will create a text field from an single AttributedString.

Method Summary

Modifier and Type	Method	Description
RowColLocation	dataToScreenLocation(int dataRow, int dataColumn)	Translates a data row and column into a screen row and column.

Methods inherited from class docking.widgets.fieldpanel.field.VerticalLayoutTextField

calculateHeight, contains, createFieldForLine, getCol, getCursorBounds, getFieldElement, getHeight, getHeightAbove, getHeightBelow, getLines, getNumCols, getNumDataRows, getNumRows, getPreferredWidth, getRow, getScrollableUnitIncrement, getStartX, getText, getTextWithLineSeparators, getWidth, getX, getY, isClipped, isPrimary, isValid, layoutElements, paint, rowHeightChanged, screenLocationToTextOffset, screenToDataLocation, setPrimary, textOffsetToScreenLocation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WrappingVerticalLayoutTextField

public WrappingVerticalLayoutTextField(FieldElement textElement,
                                       int startX,
                                       int width,
                                       int maxLines,
                                       HighlightFactory hlFactory)

This constructor will create a text field from an single AttributedString. The string will be word wrapped.

Parameters:

textElement - the element to display

startX - the x position to draw the string

width - the max width allocated to this field

maxLines - the max number of lines to display

hlFactory - the highlight factory

WrappingVerticalLayoutTextField

public WrappingVerticalLayoutTextField(FieldElement textElement,
                                       int startX,
                                       int width,
                                       int maxLines,
                                       HighlightFactory hlFactory,
                                       boolean breakOnWhiteSpace)

This constructor will create a text field from an single AttributedString. The string will be word wrapped.

Parameters:

textElement - is the element to display

startX - is the position to draw the string

width - is the max width allocated to this field

maxLines - is the max number of lines to display

hlFactory - is the highlight factory

breakOnWhiteSpace - is true if wrapping should break on word boundaries

Method Detail

dataToScreenLocation

public RowColLocation dataToScreenLocation(int dataRow,
                                           int dataColumn)

Description copied from interface: TextField

Translates a data row and column into a screen row and column.

Specified by:

dataToScreenLocation in interface TextField

Overrides:

dataToScreenLocation in class VerticalLayoutTextField

Parameters:

dataRow - row as defined by the factory

dataColumn - the character offset into the dataRow

Returns:

row and column in the screen coordinate system; a DefaultRowColLocation if this field does not contain the given column