PoLegend

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.fields.SoFieldContainer
    - - com.openinventor.inventor.nodes.SoNode
      - com.openinventor.inventor.nodekits.SoBaseKit
        
        com.openinventor.meshviz.graph.PoBase
        
        com.openinventor.meshviz.graph.PoGraphMaster
        
        com.openinventor.meshviz.graph.PoLegend

All Implemented Interfaces:

SafeDisposable, SoGetView

Direct Known Subclasses:

PoItemLegend, PoValueLegend
```
public class PoLegend
extends PoGraphMaster
```
Abstract class for legend representations. This class handles the title, the values, the margins and the path of the legend.
All legend texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node PoMiscTextAttr).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoLegend.IncrementTypes` Type of values incrementation.
`static class`	`PoLegend.MarginTypes` Type of margins.
`static class`	`PoLegend.Positions` Type of position.
`static class`	`PoLegend.TextPaths` Text path.
`static class`	`PoLegend.Visibilities` Type of visibility.

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase
PoBase.NodeWriteFormats, PoBase.TextTypes, PoBase.UpdateMethodTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`SoSFFloat`	`boxRatio` Ratio between width and height of the colored boxes in the legend.
`static int`	`FIXED_MARGIN` Deprecated. Use `PoLegend.MarginTypes.FIXED_MARGIN` instead.
`static int`	`HORIZONTAL_INCREMENT` Deprecated. Use `PoLegend.IncrementTypes.HORIZONTAL_INCREMENT` instead.
`SoSFEnum<PoLegend.IncrementTypes>`	`incrementType` Increment type for the values of legend.
`SoSFFloat`	`marginBottom` Bottom margin.
`SoSFFloat`	`marginLeft` Left margin.
`SoSFFloat`	`marginRight` Right margin.
`SoSFFloat`	`marginTop` Top margin.
`SoSFEnum<PoLegend.MarginTypes>`	`marginType` Margin type.
`SoSFUShort`	`numColumns` Number of columns of the legend.
`static int`	`PATH_DOWN` Deprecated. Use `PoLegend.TextPaths.PATH_DOWN` instead.
`static int`	`PATH_LEFT` Deprecated. Use `PoLegend.TextPaths.PATH_LEFT` instead.
`static int`	`PATH_RIGHT` Deprecated. Use `PoLegend.TextPaths.PATH_RIGHT` instead.
`static int`	`PATH_UP` Deprecated. Use `PoLegend.TextPaths.PATH_UP` instead.
`static int`	`POS_BOTTOM` Deprecated. Use `PoLegend.Positions.POS_BOTTOM` instead.
`static int`	`POS_LEFT` Deprecated. Use `PoLegend.Positions.POS_LEFT` instead.
`static int`	`POS_RIGHT` Deprecated. Use `PoLegend.Positions.POS_RIGHT` instead.
`static int`	`POS_TOP` Deprecated. Use `PoLegend.Positions.POS_TOP` instead.
`static int`	`REL_MARGIN` Deprecated. Use `PoLegend.MarginTypes.REL_MARGIN` instead.
`SoSFString`	`titleFontName` Font name of the title.
`SoSFFloat`	`titleFontSize` Font size of the title.
`SoSFEnum<PoLegend.TextPaths>`	`titlePath` Title path.
`SoSFEnum<PoLegend.Positions>`	`titlePosition` Title position.
`SoSFString`	`titleString` Title string.
`SoSFEnum<PoLegend.Visibilities>`	`titleVisibility` Title visibility.
`SoSFString`	`valueAddString` String to be concatenated.
`SoSFBool`	`valueAddStringVisibility` Visibility of a string concatenated to the values.
`SoSFString`	`valueFontName` Font name of values.
`SoSFEnum<PoLegend.Positions>`	`valuePosition` Values positions.
`SoSFEnum<PoLegend.Visibilities>`	`valueVisibility` Values visibility.
`static int`	`VERTICAL_INCREMENT` Deprecated. Use `PoLegend.IncrementTypes.VERTICAL_INCREMENT` instead.
`static int`	`VISIBILITY_OFF` Deprecated. Use `PoLegend.Visibilities.VISIBILITY_OFF` instead.
`static int`	`VISIBILITY_ON` Deprecated. Use `PoLegend.Visibilities.VISIBILITY_ON` instead.

Fields inherited from class com.openinventor.meshviz.graph.PoBase
FOLD_NODE_WRITE_FORMAT, SO_ANNO_TEXT3, SO_TEXT3, UNFOLD_NODE_WRITE_FORMAT, UPDATE_METHOD_IMMEDIATE, UPDATE_METHOD_ON_ACTION

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.
`PbMiscTextAttr`	`getMiscTextAttr()` Gets a reference to a `PbMiscTextAttr` for miscellaneous text attributes.
`void`	`setMiscTextAttr(PbMiscTextAttr textAttr)` Sets a reference to a `PbMiscTextAttr` for miscellaneous text attributes of all legend texts.

Methods inherited from class com.openinventor.meshviz.graph.PoBase
addPostRebuildCallback, addPreRebuildCallback, getDomain, getNodeWriteFormat, getTextType, getUpdateMethod, isBuilt, isModified, isVRML2Mode, rebuild, setDomain, setNodeWriteFormat, setTextType, setUpdateMethod, setVRML2Mode, touchKit

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit
getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren

Methods inherited from class com.openinventor.inventor.nodes.SoNode
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

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

- Field Detail
  - VISIBILITY_OFF
```
@Deprecated
public static final int VISIBILITY_OFF
```
    Deprecated. Use PoLegend.Visibilities.VISIBILITY_OFF instead.
  - VISIBILITY_ON
```
@Deprecated
public static final int VISIBILITY_ON
```
    Deprecated. Use PoLegend.Visibilities.VISIBILITY_ON instead.
  - PATH_RIGHT
```
@Deprecated
public static final int PATH_RIGHT
```
    Deprecated. Use PoLegend.TextPaths.PATH_RIGHT instead.
  - PATH_LEFT
```
@Deprecated
public static final int PATH_LEFT
```
    Deprecated. Use PoLegend.TextPaths.PATH_LEFT instead.
  - PATH_UP
```
@Deprecated
public static final int PATH_UP
```
    Deprecated. Use PoLegend.TextPaths.PATH_UP instead.
  - PATH_DOWN
```
@Deprecated
public static final int PATH_DOWN
```
    Deprecated. Use PoLegend.TextPaths.PATH_DOWN instead.
  - POS_BOTTOM
```
@Deprecated
public static final int POS_BOTTOM
```
    Deprecated. Use PoLegend.Positions.POS_BOTTOM instead.
  - POS_TOP
```
@Deprecated
public static final int POS_TOP
```
    Deprecated. Use PoLegend.Positions.POS_TOP instead.
  - POS_RIGHT
```
@Deprecated
public static final int POS_RIGHT
```
    Deprecated. Use PoLegend.Positions.POS_RIGHT instead.
  - POS_LEFT
```
@Deprecated
public static final int POS_LEFT
```
    Deprecated. Use PoLegend.Positions.POS_LEFT instead.
  - REL_MARGIN
```
@Deprecated
public static final int REL_MARGIN
```
    Deprecated. Use PoLegend.MarginTypes.REL_MARGIN instead.
  - FIXED_MARGIN
```
@Deprecated
public static final int FIXED_MARGIN
```
    Deprecated. Use PoLegend.MarginTypes.FIXED_MARGIN instead.
  - VERTICAL_INCREMENT
```
@Deprecated
public static final int VERTICAL_INCREMENT
```
    Deprecated. Use PoLegend.IncrementTypes.VERTICAL_INCREMENT instead.
  - HORIZONTAL_INCREMENT
```
@Deprecated
public static final int HORIZONTAL_INCREMENT
```
    Deprecated. Use PoLegend.IncrementTypes.HORIZONTAL_INCREMENT instead.
  - titleVisibility
```
public final SoSFEnum<PoLegend.Visibilities> titleVisibility
```
    Title visibility.
  - titlePosition
```
public final SoSFEnum<PoLegend.Positions> titlePosition
```
    Title position.
  - titlePath
```
public final SoSFEnum<PoLegend.TextPaths> titlePath
```
    Title path. .
  - titleFontSize
```
public final SoSFFloat titleFontSize
```
    Font size of the title.
  - titleFontName
```
public final SoSFString titleFontName
```
    Font name of the title. If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.
  - titleString
```
public final SoSFString titleString
```
    Title string.
  - valueVisibility
```
public final SoSFEnum<PoLegend.Visibilities> valueVisibility
```
    Values visibility.
  - valuePosition
```
public final SoSFEnum<PoLegend.Positions> valuePosition
```
    Values positions.
  - valueFontName
```
public final SoSFString valueFontName
```
    Font name of values. If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes.
  - valueAddStringVisibility
```
public final SoSFBool valueAddStringVisibility
```
    Visibility of a string concatenated to the values.
  - valueAddString
```
public final SoSFString valueAddString
```
    String to be concatenated.
  - marginType
```
public final SoSFEnum<PoLegend.MarginTypes> marginType
```
    Margin type.
  - marginLeft
```
public final SoSFFloat marginLeft
```
    Left margin.
  - marginRight
```
public final SoSFFloat marginRight
```
    Right margin.
  - marginBottom
```
public final SoSFFloat marginBottom
```
    Bottom margin.
  - marginTop
```
public final SoSFFloat marginTop
```
    Top margin.
  - incrementType
```
public final SoSFEnum<PoLegend.IncrementTypes> incrementType
```
    Increment type for the values of legend. (the values can be incremented vertically or horizontally).
  - numColumns
```
public final SoSFUShort numColumns
```
    Number of columns of the legend.
  - boxRatio
```
public final SoSFFloat boxRatio
```
    Ratio between width and height of the colored boxes in the legend.
- Method Detail
  - setMiscTextAttr
```
public void setMiscTextAttr(PbMiscTextAttr textAttr)
```
    Sets a reference to a PbMiscTextAttr for miscellaneous text attributes of all legend texts. If this method is not called (or called passing NULL as argument), this is the miscellaneous text attributes defined in the current inherited state (defined with the property node PoMiscTextAttr) which are used.
  - getMiscTextAttr
```
public PbMiscTextAttr getMiscTextAttr()
```
    Gets a reference to a PbMiscTextAttr for miscellaneous text attributes.
  - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
    Returns the SoNodekitCatalog for this class.

Class PoLegend

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.meshviz.graph.PoBase

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Fields inherited from class com.openinventor.inventor.Inventor

Method Summary

Methods inherited from class com.openinventor.meshviz.graph.PoBase

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Methods inherited from class com.openinventor.inventor.nodes.SoNode

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

VISIBILITY_OFF

VISIBILITY_ON

PATH_RIGHT

PATH_LEFT

PATH_UP

PATH_DOWN

POS_BOTTOM

POS_TOP

POS_RIGHT

POS_LEFT

REL_MARGIN

FIXED_MARGIN

VERTICAL_INCREMENT

HORIZONTAL_INCREMENT

titleVisibility

titlePosition

titlePath

titleFontSize

titleFontName

titleString

valueVisibility

valuePosition

valueFontName

valueAddStringVisibility

valueAddString

marginType

marginLeft

marginRight

marginBottom

marginTop

incrementType

numColumns

boxRatio

Method Detail

setMiscTextAttr

getMiscTextAttr

getClassNodekitCatalog