OpenJDK 27 · sun.swing.MenuItemLayoutHelper · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static class	MenuItemLayoutHelper.ColumnAlignment
public static class	MenuItemLayoutHelper.LayoutResult
public static class	MenuItemLayoutHelper.RectSize

Modifier and Type	Field and Description
private FontMetrics	accFm
private Font	accFont
private MenuItemLayoutHelper.RectSize	accSize
private String	accText
private int	afterCheckIconGap
private Icon	arrowIcon
private MenuItemLayoutHelper.RectSize	arrowSize
private Icon	checkIcon
private MenuItemLayoutHelper.RectSize	checkSize
private FontMetrics	fm
private Font	font
private int	gap
private int	horizontalAlignment
private int	horizontalTextPosition
private View	htmlView
private Icon	icon
private MenuItemLayoutHelper.RectSize	iconSize
private boolean	isColumnLayout
private boolean	isLeftToRight
private boolean	isTopLevelMenu
private MenuItemLayoutHelper.RectSize	labelSize
private int	leadingGap
private int	leftTextExtraWidth
public static final StringUIClientPropertyKey	MAX_ACC_WIDTH
public static final StringUIClientPropertyKey	MAX_ARROW_WIDTH
public static final StringUIClientPropertyKey	MAX_CHECK_WIDTH
public static final StringUIClientPropertyKey	MAX_ICON_WIDTH
public static final StringUIClientPropertyKey	MAX_LABEL_WIDTH
public static final StringUIClientPropertyKey	MAX_TEXT_WIDTH
private JMenuItem	mi
private int	minTextOffset
private JComponent	miParent
private String	text
private MenuItemLayoutHelper.RectSize	textSize
private boolean	useCheckAndArrow
private int	verticalAlignment
private int	verticalTextPosition
private Rectangle	viewRect

Access	Constructor and Description
protected	MenuItemLayoutHelper() The empty protected constructor is necessary for derived classes.
public	MenuItemLayoutHelper(JMenuItem mi, Icon checkIcon, Icon arrowIcon, Rectangle viewRect, int gap, String accDelimiter, boolean isLeftToRight, Font font, Font accFont, boolean useCheckAndArrow, String propertyPrefix)

Method Summary

Modifier and Type	Method and Description
public static void	addMaxWidth(MenuItemLayoutHelper.RectSize size, int gap, Dimension result)
public static void	addWidth(int width, int gap, Dimension result)
private void	alignAccCheckAndArrowVertically(MenuItemLayoutHelper.LayoutResult lr) Aligns the accelertor text and the check and arrow icons vertically with the center of the label rect.
private void	alignRect(Rectangle rect, int alignment, int origWidth)
private void	alignRects(MenuItemLayoutHelper.LayoutResult lr, MenuItemLayoutHelper.ColumnAlignment alignment)
private void	calcExtraWidths()
private void	calcLabelYPosition(MenuItemLayoutHelper.LayoutResult lr) Sets labelRect Y coordinate taking into account the vertical alignment
private void	calcMaxTextOffset(Rectangle the rectangle, the maximal text offset will be calculated for. viewRect) Calculates maximal text offset.
protected int	Returns: maximal value among the parent property and the value. calcMaxValue(Object name of the property, which stores the maximal value. propertyName, int a value which pretends to be maximal value) Calculates and returns maximal value through specified parent component client property.
protected void	calcMaxWidth(MenuItemLayoutHelper.RectSize rs, Object key)
protected void	calcMaxWidths()
private void	calcTextAndIconYPositions(MenuItemLayoutHelper.LayoutResult lr) Sets Y coordinates of text and icon taking into account the vertical alignment
protected void	calcWidthsAndHeights()
private void	calcXPositionsLTR(int startXPos, int leadingGap, int gap, Rectangle... rects)
private void	calcXPositionsRTL(int startXPos, int leadingGap, int gap, Rectangle... rects)
public static void	clearUsedClientProperties(JComponent c)
public static void	clearUsedParentClientProperties(JMenuItem menuItem)
private MenuItemLayoutHelper.LayoutResult	createLayoutResult()
public static Rectangle	createMaxRect()
private void	doLTRColumnLayout(MenuItemLayoutHelper.LayoutResult lr, MenuItemLayoutHelper.ColumnAlignment alignment)
private void	doLTRComplexLayout(MenuItemLayoutHelper.LayoutResult lr, MenuItemLayoutHelper.ColumnAlignment alignment)
private void	doRTLColumnLayout(MenuItemLayoutHelper.LayoutResult lr, MenuItemLayoutHelper.ColumnAlignment alignment)
private void	doRTLComplexLayout(MenuItemLayoutHelper.LayoutResult lr, MenuItemLayoutHelper.ColumnAlignment alignment)
private void	fixVerticalAlignment(MenuItemLayoutHelper.LayoutResult lr, Rectangle r) Fixes vertical alignment of all menu item elements if rect.y or (rect.y + rect.height) is out of viewRect bounds
public Font	getAccFont()
public FontMetrics	getAccFontMetrics()
public MenuItemLayoutHelper.RectSize	getAccSize()
private String	getAccText(String acceleratorDelimiter)
public String	getAccText()
private int	getAfterCheckIconGap(String propertyPrefix)
public int	getAfterCheckIconGap()
public Icon	getArrowIcon()
public MenuItemLayoutHelper.RectSize	getArrowSize()
public Icon	getCheckIcon()
private int	getCheckOffset(String propertyPrefix)
public MenuItemLayoutHelper.RectSize	getCheckSize()
public Font	getFont()
public FontMetrics	getFontMetrics()
public int	getGap()
public int	getHorizontalAlignment()
public int	getHorizontalTextPosition()
public View	getHtmlView()
private Icon	getIcon(String propertyPrefix)
public Icon	getIcon()
public MenuItemLayoutHelper.RectSize	getIconSize()
public MenuItemLayoutHelper.RectSize	getLabelSize()
private int	getLeadingGap(String propertyPrefix)
public int	getLeadingGap()
private int	getLeftExtraWidth(String str)
public int	getLeftTextExtraWidth()
public MenuItemLayoutHelper.ColumnAlignment	getLTRColumnAlignment()
public JMenuItem	getMenuItem()
public static JComponent	Returns: parent of this component if it is not a top-level menu Otherwise returns null. getMenuItemParent(JMenuItem the menu item whose parent will be returned. menuItem) Returns parent of this component if it is not a top-level menu Otherwise returns null.
public JComponent	getMenuItemParent()
private int	getMinTextOffset(String propertyPrefix)
public int	getMinTextOffset()
protected int	Returns: value of the property as int. getParentIntProperty(Object name of the parent property. propertyName) Returns parent client property as int.
public MenuItemLayoutHelper.ColumnAlignment	getRTLColumnAlignment()
public String	getText()
public MenuItemLayoutHelper.RectSize	getTextSize()
public int	getVerticalAlignment()
public int	getVerticalTextPosition()
public Rectangle	getViewRect()
public static boolean	isColumnLayout(boolean isLeftToRight, JMenuItem mi)
public static boolean	isColumnLayout(boolean isLeftToRight, int horizontalAlignment, int horizontalTextPosition, int verticalTextPosition) Answers should we do column layout for a menu item or not.
public boolean	isColumnLayout()
public boolean	isLeftToRight()
public boolean	isTopLevelMenu()
protected void	layoutIconAndTextInLabelRect(MenuItemLayoutHelper.LayoutResult lr)
public MenuItemLayoutHelper.LayoutResult	layoutMenuItem() Layout icon, text, check icon, accelerator text and arrow icon in the viewRect and return their positions.
public static int	Returns: maximal value. max(int... array where the search will be performed. values) Finds and returns maximal integer value in the given array.
protected void	prepareForLayout(MenuItemLayoutHelper.LayoutResult lr)
protected void	reset(JMenuItem mi, Icon checkIcon, Icon arrowIcon, Rectangle viewRect, int gap, String accDelimiter, boolean isLeftToRight, Font font, Font accFont, boolean useCheckAndArrow, String propertyPrefix)
protected void	setAccFont(Font accFont)
protected void	setAccFontMetrics(FontMetrics accFm)
protected void	setAccSize(MenuItemLayoutHelper.RectSize accSize)
protected void	setAccText(String accText)
protected void	setAfterCheckIconGap(int afterCheckIconGap)
protected void	setArrowIcon(Icon arrowIcon)
protected void	setArrowSize(MenuItemLayoutHelper.RectSize arrowSize)
protected void	setCheckIcon(Icon checkIcon)
protected void	setCheckSize(MenuItemLayoutHelper.RectSize checkSize)
protected void	setColumnLayout(boolean columnLayout)
protected void	setFont(Font font)
protected void	setFontMetrics(FontMetrics fm)
protected void	setGap(int gap)
protected void	setHorizontalAlignment(int horizontalAlignment)
protected void	setHorizontalTextPosition(int horizontalTextPosition)
protected void	setHtmlView(View htmlView)
protected void	setIcon(Icon icon)
protected void	setIconSize(MenuItemLayoutHelper.RectSize iconSize)
protected void	setLabelSize(MenuItemLayoutHelper.RectSize labelSize)
protected void	setLeadingGap(int leadingGap)
protected void	setLeftToRight(boolean leftToRight)
protected void	setMenuItem(JMenuItem mi)
protected void	setMenuItemParent(JComponent miParent)
protected void	setMinTextOffset(int minTextOffset)
private void	setOriginalWidths()
protected void	setText(String text)
protected void	setTextSize(MenuItemLayoutHelper.RectSize textSize)
protected void	setTopLevelMenu(boolean topLevelMenu)
protected void	setUseCheckAndArrow(boolean useCheckAndArrow)
protected void	setVerticalAlignment(int verticalAlignment)
protected void	setVerticalTextPosition(int verticalTextPosition)
protected void	setViewRect(Rectangle viewRect)
public boolean	useCheckAndArrow()
public static boolean	useCheckAndArrow(JMenuItem menuItem) Returns false if the component is a JMenu and it is a top level menu (on the menubar).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class MenuItemLayoutHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary