java.lang.Object
- com.inductiveautomation.rm.base.RMListenerList
- - com.inductiveautomation.rm.base.RMObject
  - - com.inductiveautomation.rm.shape.RMShape
    - - com.inductiveautomation.rm.shape.RMParentShape
      - com.inductiveautomation.rm.swing.shape.JComponentShape
        
        com.inductiveautomation.rm.swing.shape.LabeledShape

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

AbstractButtonShape, JLabelShape
```
public class LabeledShape
extends JComponentShape
```
A JComponentShape subclass for Labeled JComponents (JLabel, AbstractButton).

Nested Class Summary
- Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes
  RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Field Summary
- Fields inherited from class com.inductiveautomation.rm.shape.RMShape
  BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

Constructor Summary

Constructors
Constructor Description

LabeledShape()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`childrenSuperSelectImmediately()`	Declare this for editing.
`protected void`	`configureComponent(JBuilder aBldr, javax.swing.JComponent aComp)`	Override to apply subclass attributes.
`protected void`	`fromXMLShape(RXArchiver anArchiver, RXElement anElement)`	XML unarchival.
`RMTypes.AlignX`	`getAlignmentX()`	Returns the horizontal alignment.
`RMTypes.AlignY`	`getAlignmentY()`	Returns the vertical alignment.
`int`	`getHorizontalAlignment()`	Returns the HorizontalAlignment.
`int`	`getHorizontalAlignmentDefault()`	Returns the default HorizontalAlignment.
`static java.lang.Integer`	`getHorizontalAlignmentInt(java.lang.String aString)`	Sets the horizontal alignment of the given component as a string ("left", "center" or "right").
`static java.lang.String`	`getHorizontalAlignmentString(int anInt)`	Returns the horizontal alignment of the given component as a string ("left", "center" or "right").
`int`	`getHorizontalTextPosition()`	Returns the HorizontalTextPosition.
`static java.lang.Integer`	`getHorizontalTextPositionInt(java.lang.String aString)`	Sets the label's horizontal text position as a string.
`static java.lang.String`	`getHorizontalTextPositionString(int anInt)`	Returns the labels horizontal text position as a string.
`javax.swing.Icon`	`getIcon()`	Returns the icon.
`protected javax.swing.Icon`	`getIcon(java.lang.String aName)`	Returns an icon for given name.
`int`	`getIconTextGap()`	Returns the IconTextGap.
`WebFile`	`getImageFile()`	Returns the image WebFile.
`WebFile`	`getImageFile(java.lang.String aName)`	Returns the image WebFile.
`java.lang.String`	`getImageName()`	Returns the image name.
`java.lang.String`	`getText()`	Returns the text.
`int`	`getVerticalAlignment()`	Returns the VerticalAlignment.
`int`	`getVerticalAlignmentDefault()`	Returns the default VerticalAlignment.
`static java.lang.Integer`	`getVerticalAlignmentInt(java.lang.String aString)`	Sets the vertical alignment of the given component as a string ("top", "center" or "bottom").
`static java.lang.String`	`getVerticalAlignmentString(int anInt)`	Returns the vertical alignment of the given component as a string ("top", "center" or "bottom").
`int`	`getVerticalTextPosition()`	Returns the VerticalTextPosition.
`static java.lang.Integer`	`getVerticalTextPositionInt(java.lang.String aString)`	Sets the label's vertical text position as a string.
`static java.lang.String`	`getVerticalTextPositionString(int anInt)`	Returns the labels vertical text position as a string.
`void`	`setAlignmentX(RMTypes.AlignX anAlignX)`	Sets the alignment x.
`void`	`setAlignmentY(RMTypes.AlignY anAlignY)`	Sets the alignment x.
`void`	`setHorizontalAlignment(int aValue)`	Sets the HorizontalAlignment.
`void`	`setHorizontalTextPosition(int aValue)`	Sets the HorizontalTextPosition.
`void`	`setIcon(javax.swing.Icon anIcon)`	Sets the icon.
`void`	`setIconTextGap(int aValue)`	Sets the IconTextGap.
`void`	`setImageName(java.lang.String aName)`	Sets the image name.
`void`	`setText(java.lang.String aString)`	Sets the text.
`void`	`setVerticalAlignment(int aValue)`	Sets the VerticalAlignment.
`void`	`setVerticalTextPosition(int aValue)`	Sets the VerticalTextPosition.
`protected RXElement`	`toXMLShape(RXArchiver anArchiver)`	XML archival.

Methods inherited from class com.inductiveautomation.rm.swing.shape.JComponentShape
acceptsMouse, clone, createComponent, createComponentDeep, dispatchEventToComponent, firePropertyChange, getAction, getAutoscrolls, getBackground, getBorder, getClientProperty, getComponent, getComponentClass, getFont, getForeground, getItemDisplayKey, getRealClassName, getSendActionOnFocusLost, getToolTipText, isEnabled, isFontSet, isOpaque, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paintShape, putClientProperty, setAction, setAutoscrolls, setBackground, setBorder, setEnabled, setFont, setForeground, setItemDisplayKey, setOpaque, setRealClassName, setSendActionOnFocusLost, setToolTipText, toXMLChildren

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape
addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, cloneDeep, computePrefHeight, computePrefWidth, divideShapeFromTop, fromXML, fromXMLChildren, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isHittable, isShowing, isSourceURLSet, layout, layoutChildren, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgAll, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXML

Methods inherited from class com.inductiveautomation.rm.shape.RMShape
acceptsChildren, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, get, get, getAlignment, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getChildClipShape, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, getDisplayedFill, getDisplayedStroke, getDocument, getEffect, getEventAdapter, getFill, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPath, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getPropertyNames, getRoll, getRootShape, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDeletable, isDescendant, isEditing, isEnabled, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseFill, isUseStroke, isViewing, isVisible, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, rpgBindings, rpgShape, setAlignment, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseFill, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class com.inductiveautomation.rm.base.RMObject
addPropertyChangeListener, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList
addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LabeledShape
```
public LabeledShape()
```
- Method Detail
  - getText
```
public java.lang.String getText()
```
    Returns the text.
  - setText
```
public void setText(java.lang.String aString)
```
    Sets the text.
  - getImageName
```
public java.lang.String getImageName()
```
    Returns the image name.
  - setImageName
```
public void setImageName(java.lang.String aName)
```
    Sets the image name.
  - getImageFile
```
public WebFile getImageFile()
```
    Returns the image WebFile.
  - getImageFile
```
public WebFile getImageFile(java.lang.String aName)
```
    Returns the image WebFile.
  - getHorizontalAlignment
```
public int getHorizontalAlignment()
```
    Returns the HorizontalAlignment.
  - setHorizontalAlignment
```
public void setHorizontalAlignment(int aValue)
```
    Sets the HorizontalAlignment.
  - getHorizontalAlignmentDefault
```
public int getHorizontalAlignmentDefault()
```
    Returns the default HorizontalAlignment.
  - getAlignmentX
```
public RMTypes.AlignX getAlignmentX()
```
    Returns the horizontal alignment.
    
    Overrides:
    
    getAlignmentX in class RMShape
  - setAlignmentX
```
public void setAlignmentX(RMTypes.AlignX anAlignX)
```
    Sets the alignment x.
    
    Overrides:
    
    setAlignmentX in class RMShape
  - getVerticalAlignment
```
public int getVerticalAlignment()
```
    Returns the VerticalAlignment.
  - setVerticalAlignment
```
public void setVerticalAlignment(int aValue)
```
    Sets the VerticalAlignment.
  - getVerticalAlignmentDefault
```
public int getVerticalAlignmentDefault()
```
    Returns the default VerticalAlignment.
  - getAlignmentY
```
public RMTypes.AlignY getAlignmentY()
```
    Returns the vertical alignment.
    
    Overrides:
    
    getAlignmentY in class RMShape
  - setAlignmentY
```
public void setAlignmentY(RMTypes.AlignY anAlignY)
```
    Sets the alignment x.
    
    Overrides:
    
    setAlignmentY in class RMShape
  - getHorizontalTextPosition
```
public int getHorizontalTextPosition()
```
    Returns the HorizontalTextPosition.
  - setHorizontalTextPosition
```
public void setHorizontalTextPosition(int aValue)
```
    Sets the HorizontalTextPosition.
  - getVerticalTextPosition
```
public int getVerticalTextPosition()
```
    Returns the VerticalTextPosition.
  - setVerticalTextPosition
```
public void setVerticalTextPosition(int aValue)
```
    Sets the VerticalTextPosition.
  - getIconTextGap
```
public int getIconTextGap()
```
    Returns the IconTextGap.
  - setIconTextGap
```
public void setIconTextGap(int aValue)
```
    Sets the IconTextGap.
  - getHorizontalAlignmentString
```
public static java.lang.String getHorizontalAlignmentString(int anInt)
```
    Returns the horizontal alignment of the given component as a string ("left", "center" or "right").
  - getHorizontalAlignmentInt
```
public static java.lang.Integer getHorizontalAlignmentInt(java.lang.String aString)
```
    Sets the horizontal alignment of the given component as a string ("left", "center" or "right").
  - getVerticalAlignmentString
```
public static java.lang.String getVerticalAlignmentString(int anInt)
```
    Returns the vertical alignment of the given component as a string ("top", "center" or "bottom").
  - getVerticalAlignmentInt
```
public static java.lang.Integer getVerticalAlignmentInt(java.lang.String aString)
```
    Sets the vertical alignment of the given component as a string ("top", "center" or "bottom").
  - getHorizontalTextPositionString
```
public static java.lang.String getHorizontalTextPositionString(int anInt)
```
    Returns the labels horizontal text position as a string.
  - getHorizontalTextPositionInt
```
public static java.lang.Integer getHorizontalTextPositionInt(java.lang.String aString)
```
    Sets the label's horizontal text position as a string.
  - getVerticalTextPositionString
```
public static java.lang.String getVerticalTextPositionString(int anInt)
```
    Returns the labels vertical text position as a string.
  - getVerticalTextPositionInt
```
public static java.lang.Integer getVerticalTextPositionInt(java.lang.String aString)
```
    Sets the label's vertical text position as a string.
  - getIcon
```
public javax.swing.Icon getIcon()
```
    Returns the icon.
  - setIcon
```
public void setIcon(javax.swing.Icon anIcon)
```
    Sets the icon.
  - configureComponent
```
protected void configureComponent(JBuilder aBldr,
                                  javax.swing.JComponent aComp)
```
    Override to apply subclass attributes.
    
    Overrides:
    
    configureComponent in class JComponentShape
  - getIcon
```
@Nullable
protected javax.swing.Icon getIcon(java.lang.String aName)
```
    Returns an icon for given name.
  - childrenSuperSelectImmediately
```
public boolean childrenSuperSelectImmediately()
```
    Declare this for editing.
    
    Overrides:
    
    childrenSuperSelectImmediately in class RMShape
  - toXMLShape
```
protected RXElement toXMLShape(RXArchiver anArchiver)
```
    XML archival.
    
    Overrides:
    
    toXMLShape in class JComponentShape
  - fromXMLShape
```
protected void fromXMLShape(RXArchiver anArchiver,
                            RXElement anElement)
```
    XML unarchival.
    
    Overrides:
    
    fromXMLShape in class JComponentShape

Class LabeledShape

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

Field Summary

Fields inherited from class com.inductiveautomation.rm.shape.RMShape

Constructor Summary

Method Summary

Methods inherited from class com.inductiveautomation.rm.swing.shape.JComponentShape

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape

Methods inherited from class com.inductiveautomation.rm.shape.RMShape

Methods inherited from class com.inductiveautomation.rm.base.RMObject

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

Methods inherited from class java.lang.Object

Constructor Detail

LabeledShape

Method Detail

getText

setText

getImageName

setImageName

getImageFile

getImageFile

getHorizontalAlignment

setHorizontalAlignment

getHorizontalAlignmentDefault

getAlignmentX

setAlignmentX

getVerticalAlignment

setVerticalAlignment

getVerticalAlignmentDefault

getAlignmentY

setAlignmentY

getHorizontalTextPosition

setHorizontalTextPosition

getVerticalTextPosition

setVerticalTextPosition

getIconTextGap

setIconTextGap

getHorizontalAlignmentString

getHorizontalAlignmentInt

getVerticalAlignmentString

getVerticalAlignmentInt

getHorizontalTextPositionString

getHorizontalTextPositionInt

getVerticalTextPositionString

getVerticalTextPositionInt

getIcon

setIcon

configureComponent

getIcon

childrenSuperSelectImmediately

toXMLShape

fromXMLShape