public interface GroupLabel extends NXObject
nxopen.visualreporting.VisualReport
.
Modifier and Type | Interface and Description |
---|---|
static class |
GroupLabel.DisplayStyleOption
Represents the possible display style options
for a
GroupLabel . |
static class |
GroupLabel.TagPriorityOption
Represents the possible priority options
for a
GroupLabel . |
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat
Modifier and Type | Method and Description |
---|---|
String |
bitmapName()
Returns the bitmap name of this
GroupLabel . |
NXColor.Rgb |
color()
Returns the color of the
GroupLabel
License requirements: None. |
String |
customMessage()
Returns the custom message of this
GroupLabel . |
GroupLabel.DisplayStyleOption |
displayStyle()
|
boolean |
isManual()
Returns whether the
GroupLabel is manual. |
boolean |
isNameUserSpecified()
Returns whether the
GroupLabel has a user-specified INXObject.name() . |
String |
lowerBound()
Returns the lower bound value of the
GroupLabel (if it is being grouped by range)
License requirements: None. |
void |
setBitmapName(String bitmapName)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setColor(NXColor.Rgb color)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setCustomMessage(String customMessage)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setDisplayStyle(GroupLabel.DisplayStyleOption displayStyle)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setLowerBound(String fromValue)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setManual(boolean isManual)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setNameUserSpecified(boolean isNameUserSpecified)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setTagPriority(GroupLabel.TagPriorityOption tagPriority)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setUpperBound(String upperBound)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setValue(String groupLabelValue)
License requirements: nx_visual_reporting ("Visual Reporting") . |
GroupLabel.TagPriorityOption |
tagPriority()
Returns the Tag Priority of this
GroupLabel . |
String |
upperBound()
Returns the upper bound value of the
GroupLabel (if it is being grouped by range)
License requirements: None. |
String |
value()
Returns the value of the
GroupLabel (if it is being grouped by value)
License requirements: None. |
deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
boolean isManual() throws NXException, RemoteException
GroupLabel
is manual. It is manual if it either has a user-specified
INXObject.name()
or if its displayStyle()
is
not GroupLabel.DisplayStyleOption.AUTOMATIC_COLOR
.
You can change a GroupLabel
from automatic to manual, but you cannot
change GroupLabel
from manual to automatic.
NXException
RemoteException
void setManual(boolean isManual) throws NXException, RemoteException
isManual
- NXException
RemoteException
boolean isNameUserSpecified() throws NXException, RemoteException
GroupLabel
has a user-specified INXObject.name()
. If it isn't
user-specified, then the system will generate its name automatically.
NXException
RemoteException
void setNameUserSpecified(boolean isNameUserSpecified) throws NXException, RemoteException
isNameUserSpecified
- NXException
RemoteException
String lowerBound() throws NXException, RemoteException
GroupLabel
(if it is being grouped by range)
NXException
RemoteException
void setLowerBound(String fromValue) throws NXException, RemoteException
fromValue
- NXException
RemoteException
String upperBound() throws NXException, RemoteException
GroupLabel
(if it is being grouped by range)
NXException
RemoteException
void setUpperBound(String upperBound) throws NXException, RemoteException
upperBound
- NXException
RemoteException
String value() throws NXException, RemoteException
GroupLabel
(if it is being grouped by value)
NXException
RemoteException
void setValue(String groupLabelValue) throws NXException, RemoteException
groupLabelValue
- NXException
RemoteException
GroupLabel.DisplayStyleOption displayStyle() throws NXException, RemoteException
GroupLabel.DisplayStyleOption
of the GroupLabel
NXException
RemoteException
void setDisplayStyle(GroupLabel.DisplayStyleOption displayStyle) throws NXException, RemoteException
displayStyle
- NXException
RemoteException
NXColor.Rgb color() throws NXException, RemoteException
NXException
RemoteException
void setColor(NXColor.Rgb color) throws NXException, RemoteException
color
- NXException
RemoteException
String bitmapName() throws NXException, RemoteException
NXException
RemoteException
void setBitmapName(String bitmapName) throws NXException, RemoteException
bitmapName
- NXException
RemoteException
String customMessage() throws NXException, RemoteException
NXException
RemoteException
void setCustomMessage(String customMessage) throws NXException, RemoteException
customMessage
- NXException
RemoteException
GroupLabel.TagPriorityOption tagPriority() throws NXException, RemoteException
NXException
RemoteException
void setTagPriority(GroupLabel.TagPriorityOption tagPriority) throws NXException, RemoteException
tagPriority
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.