LabelView is a styled chunk of text
* that represents a view mapped over an element in the
* text model. It caches the character level attributes
* used for rendering.
* @author Timothy Prinzing
*/
// @ts-ignore
class LabelView extends javax.swing.text.GlyphView implements javax.swing.text.TabableView {
/**
* Constructs a new view wrapped on an element.
* @param elem the element
*/
// @ts-ignore
constructor(elem: javax.swing.text.Element)
/**
* Sets whether or not the view is underlined.
* Note that this setter is protected and is really
* only meant if you need to update some additional
* state when set.
* @param u true if the view is underlined, otherwise
* false
* @see #isUnderline
*/
// @ts-ignore
setUnderline(u: boolean): void
/**
* Sets whether or not the view has a strike/line
* through it.
* Note that this setter is protected and is really
* only meant if you need to update some additional
* state when set.
* @param s true if the view has a strike/line
* through it, otherwise false
* @see #isStrikeThrough
*/
// @ts-ignore
setStrikeThrough(s: boolean): void
/**
* Sets whether or not the view represents a
* superscript.
* Note that this setter is protected and is really
* only meant if you need to update some additional
* state when set.
* @param s true if the view represents a
* superscript, otherwise false
* @see #isSuperscript
*/
// @ts-ignore
setSuperscript(s: boolean): void
/**
* Sets whether or not the view represents a
* subscript.
* Note that this setter is protected and is really
* only meant if you need to update some additional
* state when set.
* @param s true if the view represents a
* subscript, otherwise false
* @see #isSubscript
*/
// @ts-ignore
setSubscript(s: boolean): void
/**
* Sets the background color for the view. This method is typically
* invoked as part of configuring this View. If you need
* to customize the background color you should override
* setPropertiesFromAttributes and invoke this method. A
* value of null indicates no background should be rendered, so that the
* background of the parent View will show through.
* @param bg background color, or null
* @see #setPropertiesFromAttributes
* @since 1.5
*/
// @ts-ignore
setBackground(bg: java.awt.Color): void
/**
* Sets the cached properties from the attributes.
*/
// @ts-ignore
setPropertiesFromAttributes(): void
/**
* Fetches the FontMetrics used for this view.
* @deprecated FontMetrics are not used for glyph rendering
* when running in the JDK.
*/
// @ts-ignore
getFontMetrics(): java.awt.FontMetrics
/**
* Fetches the background color to use to render the glyphs.
* This is implemented to return a cached background color,
* which defaults to null.
* @return the cached background color
* @since 1.3
*/
// @ts-ignore
public getBackground(): java.awt.Color
/**
* Fetches the foreground color to use to render the glyphs.
* This is implemented to return a cached foreground color,
* which defaults to null.
* @return the cached foreground color
* @since 1.3
*/
// @ts-ignore
public getForeground(): java.awt.Color
/**
* Fetches the font that the glyphs should be based upon.
* This is implemented to return a cached font.
* @return the cached font
*/
// @ts-ignore
public getFont(): java.awt.Font
/**
* Determines if the glyphs should be underlined. If true,
* an underline should be drawn through the baseline. This
* is implemented to return the cached underline property.
* When you request this property, LabelView
* re-syncs its state with the properties of the
* Element's AttributeSet.
* If Element's AttributeSet
* does not have this property set, it will revert to false.
* @return the value of the cached
* underline property
* @since 1.3
*/
// @ts-ignore
public isUnderline(): boolean
/**
* Determines if the glyphs should have a strikethrough
* line. If true, a line should be drawn through the center
* of the glyphs. This is implemented to return the
* cached strikeThrough property.
*
When you request this property, LabelView
* re-syncs its state with the properties of the
* Element's AttributeSet.
* If Element's AttributeSet
* does not have this property set, it will revert to false.
* @return the value of the cached
* strikeThrough property
* @since 1.3
*/
// @ts-ignore
public isStrikeThrough(): boolean
/**
* Determines if the glyphs should be rendered as superscript.
* @return the value of the cached subscript property
*
*
When you request this property, LabelView
* re-syncs its state with the properties of the
* Element's AttributeSet.
* If Element's AttributeSet
* does not have this property set, it will revert to false.
* @return the value of the cached
* subscript property
* @since 1.3
*/
// @ts-ignore
public isSubscript(): boolean
/**
* Determines if the glyphs should be rendered as subscript.
*
When you request this property, LabelView
* re-syncs its state with the properties of the
* Element's AttributeSet.
* If Element's AttributeSet
* does not have this property set, it will revert to false.
* @return the value of the cached
* superscript property
* @since 1.3
*/
// @ts-ignore
public isSuperscript(): boolean
/**
* Gives notification from the document that attributes were changed
* in a location that this view is responsible for.
* @param e the change information from the associated document
* @param a the current allocation of the view
* @param f the factory to use to rebuild if the view has children
* @see View#changedUpdate
*/
// @ts-ignore
public changedUpdate(e: javax.swing.event.DocumentEvent, a: java.awt.Shape, f: javax.swing.text.ViewFactory): void
}
}
}
}