Module java.desktop

Class FieldView

  • All Implemented Interfaces:
    SwingConstants, TabExpander
    Direct Known Subclasses:

    public class FieldView
    extends PlainView
    Extends the multi-line plain text view to be suitable for a single-line editor view. If the view is allocated extra space, the field must adjust for it. If the hosting component is a JTextField, this view will manage the ranges of the associated BoundedRangeModel and will adjust the horizontal allocation to match the current visibility settings of the JTextField.
    See Also:
    • Constructor Detail

      • FieldView

        public FieldView​(Element elem)
        Constructs a new FieldView wrapped on an element.
        elem - the element
    • Method Detail

      • getFontMetrics

        protected FontMetrics getFontMetrics()
        Fetches the font metrics associated with the component hosting this view.
        the metrics
      • adjustAllocation

        protected Shape adjustAllocation​(Shape a)
        Adjusts the allocation given to the view to be a suitable allocation for a text field. If the view has been allocated more than the preferred span vertically, the allocation is changed to be centered vertically. Horizontally the view is adjusted according to the horizontal alignment property set on the associated JTextField (if that is the type of the hosting component).
        a - the allocation given to the view, which may need to be adjusted.
        the allocation that the superclass should use.
      • paint

        public void paint​(Graphics g,
                          Shape a)
        Renders using the given rendering surface and area on that surface. The view may need to do layout and create child views to enable itself to render into the given allocation.
        paint in class PlainView
        g - the rendering surface to use
        a - the allocated region to render into
        See Also:
        View.paint(java.awt.Graphics, java.awt.Shape)
      • getPreferredSpan

        public float getPreferredSpan​(int axis)
        Determines the preferred span for this view along an axis.
        getPreferredSpan in class PlainView
        axis - may be either View.X_AXIS or View.Y_AXIS
        the span the view would like to be rendered into >= 0. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.
        See Also:
      • getResizeWeight

        public int getResizeWeight​(int axis)
        Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.
        getResizeWeight in class View
        axis - View.X_AXIS or View.Y_AXIS
        the weight -> 1 for View.X_AXIS, else 0
      • modelToView

        public Shape modelToView​(int pos,
                                 Shape a,
                                 Position.Bias b)
                          throws BadLocationException
        Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
        modelToView in class PlainView
        pos - the position to convert >= 0
        a - the allocated region to render into
        b - the bias toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; b will have one of these values:
        • Position.Bias.Forward
        • Position.Bias.Backward
        the bounding box of the given position
        BadLocationException - if the given position does not represent a valid location in the associated document
        See Also:
        View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)