Contents
- Description
- Constructor Summary
- Method Summary
- Constructor Details
- Method Details
- drawLine(SynthContext, Object, Graphics, int, int, int, int)
- drawLine(SynthContext, Object, Graphics, int, int, int, int, Object)
- layoutText(SynthContext, FontMetrics, String, Icon, int, int, int, int, Rectangle, Rectangle, Rectangle, int)
- computeStringWidth(SynthContext, Font, FontMetrics, String)
- getMinimumSize(SynthContext, Font, String, Icon, int, int, int, int, int, int)
- getMaximumSize(SynthContext, Font, String, Icon, int, int, int, int, int, int)
- getMaximumCharHeight(SynthContext)
- getPreferredSize(SynthContext, Font, String, Icon, int, int, int, int, int, int)
- paintText(SynthContext, Graphics, String, Rectangle, int)
- paintText(SynthContext, Graphics, String, int, int, int)
- paintText(SynthContext, Graphics, String, Icon, int, int, int, int, int, int, int)
- getIconWidth(Icon, SynthContext)
- getIconHeight(Icon, SynthContext)
- paintIcon(Icon, SynthContext, Graphics, int, int, int, int)
Class SynthGraphicsUtils
java.lang.Object
javax.swing.plaf.synth.SynthGraphicsUtils
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
computeStringWidth
(SynthContext ss, Font font, FontMetrics metrics, String text) Returns the size of the passed in string.void
drawLine
(SynthContext context, Object paintKey, Graphics g, int x1, int y1, int x2, int y2) Draws a line between the two end points.void
drawLine
(SynthContext context, Object paintKey, Graphics g, int x1, int y1, int x2, int y2, Object styleKey) Draws a line between the two end points.static int
getIconHeight
(Icon icon, SynthContext context) Returns the icon's height.static int
getIconWidth
(Icon icon, SynthContext context) Returns the icon's width.int
getMaximumCharHeight
(SynthContext context) Returns the maximum height of the Font from the passed in SynthContext.getMaximumSize
(SynthContext ss, Font font, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex) Returns the maximum size needed to properly render an icon and text.getMinimumSize
(SynthContext ss, Font font, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex) Returns the minimum size needed to properly render an icon and text.getPreferredSize
(SynthContext ss, Font font, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex) Returns the preferred size needed to properly render an icon and text.layoutText
(SynthContext ss, FontMetrics fm, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, Rectangle viewR, Rectangle iconR, Rectangle textR, int iconTextGap) Lays out text and an icon returning, by reference, the location to place the icon and text.static void
paintIcon
(Icon icon, SynthContext context, Graphics g, int x, int y, int width, int height) Paints the icon.void
paintText
(SynthContext ss, Graphics g, String text, int x, int y, int mnemonicIndex) Paints text at the specified location.void
paintText
(SynthContext ss, Graphics g, String text, Rectangle bounds, int mnemonicIndex) Paints text at the specified location.void
paintText
(SynthContext ss, Graphics g, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex, int textOffset) Paints an icon and text.
-
Constructor Details
-
Method Details
-
drawLine
public void drawLine(SynthContext context, Object paintKey, Graphics g, int x1, int y1, int x2, int y2) Draws a line between the two end points.- Parameters:
context
- Identifies hosting region.paintKey
- Identifies the portion of the component being asked to paint, may be null.g
- Graphics object to paint tox1
- x originy1
- y originx2
- x destinationy2
- y destination
-
drawLine
public void drawLine(SynthContext context, Object paintKey, Graphics g, int x1, int y1, int x2, int y2, Object styleKey) Draws a line between the two end points.This implementation supports only one line style key,
"dashed"
. The"dashed"
line style is applied only to vertical and horizontal lines.Specifying
null
or any key different from"dashed"
will draw solid lines.- Parameters:
context
- identifies hosting regionpaintKey
- identifies the portion of the component being asked to paint, may be nullg
- Graphics object to paint tox1
- x originy1
- y originx2
- x destinationy2
- y destinationstyleKey
- identifies the requested style of the line (e.g. "dashed")- Since:
- 1.6
-
layoutText
public String layoutText(SynthContext ss, FontMetrics fm, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, Rectangle viewR, Rectangle iconR, Rectangle textR, int iconTextGap) Lays out text and an icon returning, by reference, the location to place the icon and text.- Parameters:
ss
- SynthContextfm
- FontMetrics for the Font to use, this may be ignoredtext
- Text to layouticon
- Icon to layouthAlign
- horizontal alignmentvAlign
- vertical alignmenthTextPosition
- horizontal text positionvTextPosition
- vertical text positionviewR
- Rectangle to layout text and icon in.iconR
- Rectangle to place icon bounds intextR
- Rectangle to place text iniconTextGap
- gap between icon and text- Returns:
- by reference, the location to place the icon and text.
-
computeStringWidth
Returns the size of the passed in string.- Parameters:
ss
- SynthContextfont
- Font to usemetrics
- FontMetrics, may be ignoredtext
- Text to get size of.- Returns:
- the size of the passed in string.
-
getMinimumSize
public Dimension getMinimumSize(SynthContext ss, Font font, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex) Returns the minimum size needed to properly render an icon and text.- Parameters:
ss
- SynthContextfont
- Font to usetext
- Text to layouticon
- Icon to layouthAlign
- horizontal alignmentvAlign
- vertical alignmenthTextPosition
- horizontal text positionvTextPosition
- vertical text positioniconTextGap
- gap between icon and textmnemonicIndex
- Index into text to render the mnemonic at, -1 indicates no mnemonic.- Returns:
- the minimum size needed to properly render an icon and text.
-
getMaximumSize
public Dimension getMaximumSize(SynthContext ss, Font font, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex) Returns the maximum size needed to properly render an icon and text.- Parameters:
ss
- SynthContextfont
- Font to usetext
- Text to layouticon
- Icon to layouthAlign
- horizontal alignmentvAlign
- vertical alignmenthTextPosition
- horizontal text positionvTextPosition
- vertical text positioniconTextGap
- gap between icon and textmnemonicIndex
- Index into text to render the mnemonic at, -1 indicates no mnemonic.- Returns:
- the maximum size needed to properly render an icon and text.
-
getMaximumCharHeight
Returns the maximum height of the Font from the passed in SynthContext.- Parameters:
context
- SynthContext used to determine font.- Returns:
- maximum height of the characters for the font from the passed in context.
-
getPreferredSize
public Dimension getPreferredSize(SynthContext ss, Font font, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex) Returns the preferred size needed to properly render an icon and text.- Parameters:
ss
- SynthContextfont
- Font to usetext
- Text to layouticon
- Icon to layouthAlign
- horizontal alignmentvAlign
- vertical alignmenthTextPosition
- horizontal text positionvTextPosition
- vertical text positioniconTextGap
- gap between icon and textmnemonicIndex
- Index into text to render the mnemonic at, -1 indicates no mnemonic.- Returns:
- the preferred size needed to properly render an icon and text.
-
paintText
public void paintText(SynthContext ss, Graphics g, String text, Rectangle bounds, int mnemonicIndex) Paints text at the specified location. This will not attempt to render the text as html nor will it offset by the insets of the component.- Parameters:
ss
- SynthContextg
- Graphics used to render string in.text
- Text to renderbounds
- Bounds of the text to be drawn.mnemonicIndex
- Index to draw string at.
-
paintText
Paints text at the specified location. This will not attempt to render the text as html nor will it offset by the insets of the component.- Parameters:
ss
- SynthContextg
- Graphics used to render string in.text
- Text to renderx
- X location to draw text at.y
- Upper left corner to draw text at.mnemonicIndex
- Index to draw string at.
-
paintText
public void paintText(SynthContext ss, Graphics g, String text, Icon icon, int hAlign, int vAlign, int hTextPosition, int vTextPosition, int iconTextGap, int mnemonicIndex, int textOffset) Paints an icon and text. This will render the text as html, if necessary, and offset the location by the insets of the component.- Parameters:
ss
- SynthContextg
- Graphics to render string and icon intotext
- Text to layouticon
- Icon to layouthAlign
- horizontal alignmentvAlign
- vertical alignmenthTextPosition
- horizontal text positionvTextPosition
- vertical text positioniconTextGap
- gap between icon and textmnemonicIndex
- Index into text to render the mnemonic at, -1 indicates no mnemonic.textOffset
- Amount to offset the text when painting
-
getIconWidth
Returns the icon's width. ThegetIconWidth(context)
method is called forSynthIcon
.- Parameters:
icon
- the iconcontext
-SynthContext
requesting the icon, may be null.- Returns:
- an int specifying the width of the icon.
-
getIconHeight
Returns the icon's height. ThegetIconHeight(context)
method is called forSynthIcon
.- Parameters:
icon
- the iconcontext
-SynthContext
requesting the icon, may be null.- Returns:
- an int specifying the height of the icon.
-
paintIcon
public static void paintIcon(Icon icon, SynthContext context, Graphics g, int x, int y, int width, int height) Paints the icon. ThepaintIcon(context, g, x, y, width, height)
method is called forSynthIcon
.- Parameters:
icon
- the iconcontext
- identifies hosting region, may be null.g
- the graphics contextx
- the x location to paint toy
- the y location to paint towidth
- the width of the region to paint to, may be 0height
- the height of the region to paint to, may be 0
-