Package docking.widgets.fieldpanel.field

Interface TextField

All Superinterfaces:

Field

All Known Implementing Classes:

ClangTextField, ClippingTextField, CompositeVerticalLayoutTextField, ErrorListingField, FlowLayoutTextField, ListingTextField, ReverseClippingTextField, VerticalLayoutTextField, WrappingVerticalLayoutTextField

public interface TextField
extends Field

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.
FieldElement	getFieldElement(int screenRow, int screenColumn)	Returns the FieldElement at the given screen location.
boolean	isClipped()	Returns true if the field is not displaying all the text information
RowColLocation	screenToDataLocation(int screenRow, int screenColumn)	Translates a screen coordinate to a row and column in the data from the factory
void	setPrimary(boolean b)	Sets this field to be primary such that its row is primary

Methods inherited from interface docking.widgets.fieldpanel.field.Field

contains, getCol, getCursorBounds, getHeight, getHeightAbove, getHeightBelow, getNumCols, getNumDataRows, getNumRows, getPreferredWidth, getRow, getScrollableUnitIncrement, getStartX, getText, getTextWithLineSeparators, getWidth, getX, getY, isPrimary, isValid, paint, rowHeightChanged, screenLocationToTextOffset, textOffsetToScreenLocation

Method Detail

setPrimary

void setPrimary(boolean b)

Sets this field to be primary such that its row is primary

Parameters:

b - this field to be primary such that its row is primary

screenToDataLocation

RowColLocation screenToDataLocation(int screenRow,
                                    int screenColumn)

Translates a screen coordinate to a row and column in the data from the factory

Parameters:

screenRow - the row in the displayed field text.

screenColumn - the column in the displayed field text.

Returns:

a RowColLocation containing the row and column within the data from the factory.

dataToScreenLocation

RowColLocation dataToScreenLocation(int dataRow,
                                    int dataColumn)

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

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

isClipped

boolean isClipped()

Returns true if the field is not displaying all the text information

Returns:

true if the field is not displaying all the text information

getFieldElement

FieldElement getFieldElement(int screenRow,
                             int screenColumn)

Returns the FieldElement at the given screen location.

Parameters:

screenRow - the row on the screen

screenColumn - the column on the screen

Returns:

the FieldElement at the given screen location.