Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfGMLSupport :: Module GmlTextSymbol' :: Class GmlTextSymbol

[frames] | no frames]

Class GmlTextSymbol

                         object --+            
                                  |            
                   Element'.Element --+        
                                      |        
Core.IdentifiedObject'.IdentifiedObject --+    
                                          |    
                       GmlSymbol'.GmlSymbol --+
                                              |
                                             GmlTextSymbol

Used for styling text labels, i.e., for rendering them according to various graphical parameters.Used for styling text labels, i.e., for rendering them according to various graphical parameters.

Instance Methods

[hide private]

__init__(self, label='', labelType='', fieldID='', minFontSize=0, property='', GmlFill=None, GmlLabelPlacement=None, GmlHalo=None, GmlFont=None, GmlDiagramObject=None, *args, **kw_args)
Initialises a new 'GmlTextSymbol' instance.

getGmlDiagramObject(self)

getGmlFill(self)

getGmlFont(self)

getGmlHalo(self)

getGmlLabelPlacement(self)

setGmlDiagramObject(self, value)

setGmlFill(self, value)

setGmlFont(self, value)

setGmlHalo(self, value)

setGmlLabelPlacement(self, value)

Inherited from GmlSymbol'.GmlSymbol: addGmlFeatureStyles, getGmlBaseSymbol, getGmlFeatureStyles, removeGmlFeatureStyles, setGmlBaseSymbol, setGmlFeatureStyles

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

_attr_types = {'fieldID': <type 'str'>, 'label': <type 'str'>,...

_attrs = ['label', 'labelType', 'fieldID', 'minFontSize', 'pro...

_defaults = {'fieldID': '', 'label': '', 'labelType': '', 'min...

_many_refs = []

_refs = ['GmlFill', 'GmlLabelPlacement', 'GmlHalo', 'GmlFont',...

Inherited from Element'.Element (private): _enums

Properties

[hide private]

GmlDiagramObject

GmlFill

GmlFont

GmlHalo

GmlLabelPlacement

Inherited from GmlSymbol'.GmlSymbol: GmlBaseSymbol, GmlFeatureStyles

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details

[hide private]

init(self, label=`''`, labelType=`''`, fieldID=`''`, minFontSize=0, property=`''`, GmlFill=None, GmlLabelPlacement=None, GmlHalo=None, GmlFont=None, GmlDiagramObject=None, *args, **kw_args)
(Constructor)

Initialises a new 'GmlTextSymbol' instance.

Parameters:

label - Text-label content. If the value is not provided, then no text will be rendered.
labelType - The type-classification of a label.
fieldID - The name of the field of the class being annotated. Most objects will include name, description, and aliasName. Many objects may contain other fields such as comment, status, etc.
minFontSize - The minimum font size allowed.
property - Generic method for capturing all unspecified information pertaining to the TextSymbol.
GmlFill
GmlLabelPlacement
GmlHalo
GmlFont
GmlDiagramObject

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'fieldID': <type 'str'>,
 'label': <type 'str'>,
 'labelType': <type 'str'>,
 'minFontSize': <type 'int'>,
 'property': <type 'str'>}

_attrs

Value:

['label', 'labelType', 'fieldID', 'minFontSize', 'property']

_defaults

Value:

{'fieldID': '',
 'label': '',
 'labelType': '',
 'minFontSize': 0,
 'property': ''}

_refs

Value:

['GmlFill',
 'GmlLabelPlacement',
 'GmlHalo',
 'GmlFont',
 'GmlDiagramObject']

Property Details

[hide private]

GmlDiagramObject

Get Method:: getGmlDiagramObject(self)
Set Method:: setGmlDiagramObject(self, value)

GmlFill

Get Method:: getGmlFill(self)
Set Method:: setGmlFill(self, value)

GmlFont

Get Method:: getGmlFont(self)
Set Method:: setGmlFont(self, value)

GmlHalo

Get Method:: getGmlHalo(self)
Set Method:: setGmlHalo(self, value)

GmlLabelPlacement

Get Method:: getGmlLabelPlacement(self)
Set Method:: setGmlLabelPlacement(self, value)

Class GmlTextSymbol

__init__(self, label='', labelType='', fieldID='', minFontSize=0, property='', GmlFill=None, GmlLabelPlacement=None, GmlHalo=None, GmlFont=None, GmlDiagramObject=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_refs

GmlDiagramObject

GmlFill

GmlFont

GmlHalo

GmlLabelPlacement

init(self, label=`''`, labelType=`''`, fieldID=`''`, minFontSize=0, property=`''`, GmlFill=None, GmlLabelPlacement=None, GmlHalo=None, GmlFont=None, GmlDiagramObject=None, *args, **kw_args)
(Constructor)