Package docking.widgets.fieldpanel.field
Class SimpleTextField
- java.lang.Object
-
- docking.widgets.fieldpanel.field.SimpleTextField
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanallowCursorAtEndprotected java.awt.ColorforegroundColorprotected intheightAboveprotected intheightBelowprotected HighlightFactoryhlFactoryprotected booleanisPrimaryprotected java.awt.FontMetricsmetricsprotected intnumColsprotected intpreferredWidthprotected intstartXprotected java.lang.Stringtextprotected intwidth
-
Constructor Summary
Constructors Constructor Description SimpleTextField(java.lang.String text, java.awt.FontMetrics fontMetrics, int startX, int width, boolean allowCursorAtEnd, HighlightFactory hlFactory)Constructs a new SimpleTextField.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancontains(int x, int y)Returns true if the given point is in this field.protected intfindColumn(java.lang.String textString, int x)Finds the column position for the given pixel x coordinate in the indicated text string.intgetCol(int row, int x)Returns the cursor column position for the given x coordinate on the given row.java.awt.RectanglegetCursorBounds(int row, int col)Returns a bounding rectangle for the cursor at the given position.java.awt.FontMetricsgetFontMetrics()Get the font metrics for this field.java.awt.ColorgetForeground()Get the foreground color.intgetHeight()Returns the height of this field when populated with the given data.intgetHeightAbove()Returns the height above the baseLine.intgetHeightBelow()Returns the height below the baseLine.intgetNumCols(int row)Returns the number of columns in the given row.intgetNumRows()Returns the number of rows in this fieldintgetPreferredWidth()The minimum required width to paint the contents of this fieldintgetRow(int y)Returns the row containing the given y coordinate.intgetScrollableUnitIncrement(int topOfScreen, int direction, int max)Returns the amount to scroll to the next or previous lineintgetStartX()Returns the horizontal position of this field.java.lang.StringgetText()Returns a string containing all the text in the field.java.lang.StringgetTextWithLineSeparators()Returns a string containing all the text in the field with extra linefeedsintgetWidth()Returns the current width of this field.intgetX(int row, int col)Returns the x coordinate for the given cursor position.intgetY(int row)Returns the y coordinate for the given row.booleanisAllowCursorAtEnd()Returns true if the cursor is allow to be position past the last character.booleanisPrimary()Returns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layout.booleanisValid(int row, int col)Returns true if the given row and column represent a valid location for this field with the given data;voidpaint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight)Paints this field.protected voidpaintHighlights(java.awt.Graphics g, Highlight[] highlights)protected voidpaintSelection(java.awt.Graphics g, FieldBackgroundColorManager colorManager, int row)voidrowHeightChanged(int newHeightAbove, int newHeightBelow)notifies field that the rowHeight changedintscreenLocationToTextOffset(int row, int col)Returns the text offset in the overall field text string for the given row and column.voidsetFontMetrics(java.awt.FontMetrics metrics)Sets the font metricsvoidsetForeground(java.awt.Color color)Set the foreground color for this field.voidsetPrimary(boolean state)Sets this primary state of this field.RowColLocationtextOffsetToScreenLocation(int textOffset)Returns the row, column position for an offset into the string returned by getText().
-
-
-
Field Detail
-
text
protected java.lang.String text
-
metrics
protected java.awt.FontMetrics metrics
-
startX
protected int startX
-
foregroundColor
protected java.awt.Color foregroundColor
-
width
protected int width
-
preferredWidth
protected int preferredWidth
-
heightAbove
protected int heightAbove
-
heightBelow
protected int heightBelow
-
numCols
protected int numCols
-
allowCursorAtEnd
protected boolean allowCursorAtEnd
-
isPrimary
protected boolean isPrimary
-
hlFactory
protected final HighlightFactory hlFactory
-
-
Constructor Detail
-
SimpleTextField
public SimpleTextField(java.lang.String text, java.awt.FontMetrics fontMetrics, int startX, int width, boolean allowCursorAtEnd, HighlightFactory hlFactory)Constructs a new SimpleTextField.- Parameters:
text- The text for the field.fontMetrics- the fontMetrics used to render the text.startX- the starting x coordinate.width- the width of the field.allowCursorAtEnd- if true, allows the cursor to go one position past the end of the text.
-
-
Method Detail
-
isAllowCursorAtEnd
public boolean isAllowCursorAtEnd()
Returns true if the cursor is allow to be position past the last character.
-
getWidth
public int getWidth()
Description copied from interface:FieldReturns the current width of this field.- Specified by:
getWidthin interfaceField- See Also:
Field.getWidth()
-
getPreferredWidth
public int getPreferredWidth()
Description copied from interface:FieldThe minimum required width to paint the contents of this field- Specified by:
getPreferredWidthin interfaceField- Returns:
- the minimum required width to paint the contents of this field
-
getHeight
public int getHeight()
Description copied from interface:FieldReturns the height of this field when populated with the given data.- Specified by:
getHeightin interfaceField- See Also:
Field.getHeight()
-
getStartX
public int getStartX()
Description copied from interface:FieldReturns the horizontal position of this field.- Specified by:
getStartXin interfaceField- See Also:
Field.getStartX()
-
getNumRows
public int getNumRows()
Description copied from interface:FieldReturns the number of rows in this field- Specified by:
getNumRowsin interfaceField- See Also:
Field.getNumRows()
-
getNumCols
public int getNumCols(int row)
Description copied from interface:FieldReturns the number of columns in the given row.- Specified by:
getNumColsin interfaceField- Parameters:
row- the row from which to get the number of columns.- See Also:
Field.getNumCols(int)
-
getRow
public int getRow(int y)
Description copied from interface:FieldReturns the row containing the given y coordinate.- Specified by:
getRowin interfaceField- Parameters:
y- vertical pixel coordinate relative to the top of the screen.- See Also:
Field.getRow(int)
-
getCol
public int getCol(int row, int x)Description copied from interface:FieldReturns the cursor column position for the given x coordinate on the given row.- Specified by:
getColin interfaceField- Parameters:
row- the text row to find the column on.x- the horizontal pixel coordinate for which to find the character position.- See Also:
Field.getCol(int, int)
-
getY
public int getY(int row)
Description copied from interface:FieldReturns the y coordinate for the given row.- Specified by:
getYin interfaceField- Parameters:
row- the text row of interest.- See Also:
Field.getY(int)
-
getX
public int getX(int row, int col)Description copied from interface:FieldReturns the x coordinate for the given cursor position.- Specified by:
getXin interfaceField- Parameters:
row- the text row of interest.col- the character column.- See Also:
Field.getX(int, int)
-
isValid
public boolean isValid(int row, int col)Description copied from interface:FieldReturns true if the given row and column represent a valid location for this field with the given data;- Specified by:
isValidin interfaceField- Parameters:
row- the text row.col- the character position.- See Also:
Field.isValid(int, int)
-
paint
public void paint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight)Description copied from interface:FieldPaints this field.
-
paintSelection
protected void paintSelection(java.awt.Graphics g, FieldBackgroundColorManager colorManager, int row)
-
paintHighlights
protected void paintHighlights(java.awt.Graphics g, Highlight[] highlights)
-
getCursorBounds
public java.awt.Rectangle getCursorBounds(int row, int col)Description copied from interface:FieldReturns a bounding rectangle for the cursor at the given position.- Specified by:
getCursorBoundsin interfaceField- Parameters:
row- the text row.col- the character postion.
-
findColumn
protected int findColumn(java.lang.String textString, int x)Finds the column position for the given pixel x coordinate in the indicated text string.
-
contains
public boolean contains(int x, int y)Description copied from interface:FieldReturns true if the given point is in this field.- Specified by:
containsin interfaceField- Parameters:
x- the horizontal coordinate of the point.y- the relatve y position in this layout- See Also:
Field.contains(int, int)
-
setForeground
public void setForeground(java.awt.Color color)
Set the foreground color for this field.- Parameters:
color- the new foreground color.
-
getForeground
public java.awt.Color getForeground()
Get the foreground color.- Returns:
- Color could return null if the setForeground() method was not called, and if this method is called before the paint() method was called.
-
getScrollableUnitIncrement
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max)Description copied from interface:FieldReturns the amount to scroll to the next or previous line- Specified by:
getScrollableUnitIncrementin interfaceField- Parameters:
topOfScreen- - the current y pos of the top of the screen.direction- - the direction of the scroll (1 down, -1 up)max- - the maximum amount to scroll for the entire row - will be positive for down, and negative for up)- See Also:
Field.getScrollableUnitIncrement(int, int, int)
-
setFontMetrics
public void setFontMetrics(java.awt.FontMetrics metrics)
Sets the font metrics- Parameters:
metrics- the fontmetrics to use.
-
getFontMetrics
public java.awt.FontMetrics getFontMetrics()
Get the font metrics for this field.
-
isPrimary
public boolean isPrimary()
Description copied from interface:FieldReturns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layout.
-
setPrimary
public void setPrimary(boolean state)
Sets this primary state of this field.- Parameters:
state- if true, then makes this field primary.
-
getHeightAbove
public int getHeightAbove()
Description copied from interface:FieldReturns the height above the baseLine.- Specified by:
getHeightAbovein interfaceField
-
getHeightBelow
public int getHeightBelow()
Description copied from interface:FieldReturns the height below the baseLine.- Specified by:
getHeightBelowin interfaceField
-
rowHeightChanged
public void rowHeightChanged(int newHeightAbove, int newHeightBelow)Description copied from interface:Fieldnotifies field that the rowHeight changed- Specified by:
rowHeightChangedin interfaceField- Parameters:
newHeightAbove- the height above the baselinenewHeightBelow- the height below the baseline.
-
getText
public java.lang.String getText()
Description copied from interface:FieldReturns a string containing all the text in the field.
-
getTextWithLineSeparators
public java.lang.String getTextWithLineSeparators()
Description copied from interface:FieldReturns a string containing all the text in the field with extra linefeeds- Specified by:
getTextWithLineSeparatorsin interfaceField- Returns:
-
textOffsetToScreenLocation
public RowColLocation textOffsetToScreenLocation(int textOffset)
Description copied from interface:FieldReturns the row, column position for an offset into the string returned by getText().- Specified by:
textOffsetToScreenLocationin interfaceField- Parameters:
textOffset- the offset into the entire text string for this field.- Returns:
- a RowColLocation that contains the row,column location in the field for a position in the overall field text.
-
screenLocationToTextOffset
public int screenLocationToTextOffset(int row, int col)Description copied from interface:FieldReturns the text offset in the overall field text string for the given row and column.- Specified by:
screenLocationToTextOffsetin interfaceField- Parameters:
row- the row.col- the column.
-
-