Module java.desktop

Class PasswordView

  • All Implemented Interfaces:
    SwingConstants, TabExpander


    public class PasswordView
    extends FieldView
    Implements a View suitable for use in JPasswordField UI implementations. This is basically a field ui that renders its contents as the echo character specified in the associated component (if it can narrow the component to a JPasswordField).
    See Also:
    View
    • Constructor Detail

      • PasswordView

        public PasswordView​(Element elem)
        Constructs a new view wrapped on an element.
        Parameters:
        elem - the element
    • Method Detail

      • drawUnselectedText

        @Deprecated(since="9")
        protected int drawUnselectedText​(Graphics g,
                                         int x,
                                         int y,
                                         int p0,
                                         int p1)
                                  throws BadLocationException
        Renders the given range in the model as normal unselected text. This sets the foreground color and echos the characters using the value returned by getEchoChar().
        Overrides:
        drawUnselectedText in class PlainView
        Parameters:
        g - the graphics context
        x - the starting X coordinate >= 0
        y - the starting Y coordinate >= 0
        p0 - the starting offset in the model >= 0
        p1 - the ending offset in the model >= p0
        Returns:
        the X location of the end of the range >= 0
        Throws:
        BadLocationException - if p0 or p1 are out of range
      • drawUnselectedText

        protected float drawUnselectedText​(Graphics2D g,
                                           float x,
                                           float y,
                                           int p0,
                                           int p1)
                                    throws BadLocationException
        Description copied from class: PlainView
        Renders the given range in the model as normal unselected text. Uses the foreground or disabled color to render the text.
        Overrides:
        drawUnselectedText in class PlainView
        Parameters:
        g - the graphics context
        x - the starting X coordinate >= 0
        y - the starting Y coordinate >= 0
        p0 - the beginning position in the model >= 0
        p1 - the ending position in the model >= 0
        Returns:
        the X location of the end of the range >= 0
        Throws:
        BadLocationException - if the range is invalid
      • drawSelectedText

        @Deprecated(since="9")
        protected int drawSelectedText​(Graphics g,
                                       int x,
                                       int y,
                                       int p0,
                                       int p1)
                                throws BadLocationException
        Renders the given range in the model as selected text. This is implemented to render the text in the color specified in the hosting component. It assumes the highlighter will render the selected background. Uses the result of getEchoChar() to display the characters.
        Overrides:
        drawSelectedText in class PlainView
        Parameters:
        g - the graphics context
        x - the starting X coordinate >= 0
        y - the starting Y coordinate >= 0
        p0 - the starting offset in the model >= 0
        p1 - the ending offset in the model >= p0
        Returns:
        the X location of the end of the range >= 0
        Throws:
        BadLocationException - if p0 or p1 are out of range
      • drawSelectedText

        protected float drawSelectedText​(Graphics2D g,
                                         float x,
                                         float y,
                                         int p0,
                                         int p1)
                                  throws BadLocationException
        Description copied from class: PlainView
        Renders the given range in the model as selected text. This is implemented to render the text in the color specified in the hosting component. It assumes the highlighter will render the selected background.
        Overrides:
        drawSelectedText in class PlainView
        Parameters:
        g - the graphics context
        x - the starting X coordinate >= 0
        y - the starting Y coordinate >= 0
        p0 - the beginning position in the model >= 0
        p1 - the ending position in the model >= 0
        Returns:
        the location of the end of the range
        Throws:
        BadLocationException - if the range is invalid
      • drawEchoCharacter

        @Deprecated(since="9")
        protected int drawEchoCharacter​(Graphics g,
                                        int x,
                                        int y,
                                        char c)
        Renders the echo character, or whatever graphic should be used to display the password characters. The color in the Graphics object is set to the appropriate foreground color for selected or unselected text.
        Parameters:
        g - the graphics context
        x - the starting X coordinate >= 0
        y - the starting Y coordinate >= 0
        c - the echo character
        Returns:
        the updated X position >= 0
      • drawEchoCharacter

        protected float drawEchoCharacter​(Graphics2D g,
                                          float x,
                                          float y,
                                          char c)
        Renders the echo character, or whatever graphic should be used to display the password characters. The color in the Graphics object is set to the appropriate foreground color for selected or unselected text.
        Parameters:
        g - the graphics context
        x - the starting X coordinate >= 0
        y - the starting Y coordinate >= 0
        c - the echo character
        Returns:
        the updated X position >= 0
        Since:
        9
      • 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.
        Overrides:
        modelToView in class FieldView
        Parameters:
        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
        Returns:
        the bounding box of the given position
        Throws:
        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)
      • getPreferredSpan

        public float getPreferredSpan​(int axis)
        Determines the preferred span for this view along an axis.
        Overrides:
        getPreferredSpan in class FieldView
        Parameters:
        axis - may be either View.X_AXIS or View.Y_AXIS
        Returns:
        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:
        View.getPreferredSpan(int)