public class IlvSymbolDescriptor extends Object implements Serializable
get(IlvGraphic)
:
IlvSymbolDescriptor descriptor = IlvSymbolDescriptor.get(graphic); if (descriptor != null) { ... do something ... }
Constructor and Description |
---|
IlvSymbolDescriptor()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static IlvSymbolDescriptor |
get(IlvGraphic g)
Returns the symbol descriptor of a graphic object.
|
static IlvSymbolDescriptor |
get(IlvGraphic g,
boolean allocate)
Returns the symbol descriptor of a graphic object.
|
String |
getClassName()
Returns the symbol class name of the descriptor.
|
String |
getCSSResourceName()
Returns the resource access string of the symbol's CSS.
|
String |
getFullID()
Returns the full symbol id of the descriptor.
|
IlvPalette |
getPalette()
Returns the palette this object belongs to.
|
ClassLoader |
getPaletteLoader()
Returns the palette class loader of the descriptor.
|
String |
getPaletteResourceName()
Returns the palette path of the descriptor.
|
IlvPaletteSymbol |
getPaletteSymbol()
Returns the palette symbol this object was originated from.
|
String |
getParameterCSSValue(String parameterName)
Returns the value of a formal symbol parameter as CSS expression.
|
String[] |
getParameters()
Returns all formal parameter names stored in this descriptor.
|
Object |
getParameterValue(String parameterName)
Returns the current value of a formal symbol parameter.
|
void |
init(ilog.views.util.cssbeans.IlvCSSBeans css,
Object externalBeanModel,
String symbolFullID,
String symbolCSSResourceName,
String symbolClassName,
String paletteResourceName,
ClassLoader paletteLoader,
Map params)
Initializes the descriptor.
|
void |
init(String symbolFullID,
String symbolCSSResourceName,
String symbolClassName,
String paletteResourceName,
ClassLoader paletteLoader,
Map params)
Initializes the descriptor.
|
boolean |
isParameterDefined(String parameterName)
Tests whether the parameter name is stored in this descriptor.
|
void |
setParameterValue(String parameterName,
Object parameterValue)
Stores the value of a formal symbol parameter in the descriptor.
|
public static IlvSymbolDescriptor get(IlvGraphic g)
public static IlvSymbolDescriptor get(IlvGraphic g, boolean allocate)
g
- The graphic objectallocate
- If true
and no symbol descriptor exists yet
for the graphic object, a new one is allocated and
returned.public void init(String symbolFullID, String symbolCSSResourceName, String symbolClassName, String paletteResourceName, ClassLoader paletteLoader, Map params)
public void init(ilog.views.util.cssbeans.IlvCSSBeans css, Object externalBeanModel, String symbolFullID, String symbolCSSResourceName, String symbolClassName, String paletteResourceName, ClassLoader paletteLoader, Map params)
public String getFullID()
IlvPaletteBaseObject.getFullID()
public String getCSSResourceName()
IlvPaletteSymbol.getCSSResourceName()
public String getClassName()
IlvPaletteSymbol.getClassName()
public String getPaletteResourceName()
IlvPalette.getPaletteResourceName()
public ClassLoader getPaletteLoader()
public String[] getParameters()
public boolean isParameterDefined(String parameterName)
parameterName
- The name of the formal symbol parametertrue
if the parameter was set via
setParameterValue(String,Object)
.public IlvPalette getPalette()
null
if the descriptor does not
contain enough information to retrieve the palette.public IlvPaletteSymbol getPaletteSymbol()
null
if the descriptor does not
contain enough information to retrieve the palette symbol.public Object getParameterValue(String parameterName)
getParameterCSSValue(String)
.
Returns null
if the parameter name is not stored in this
descriptor.
Note that it also returns null
if a formal symbol parameter
was explicitly set to null
. Use
isParameterDefined(String)
to distinguish these two cases.parameterName
- The name of the formal symbol parametergetParameterCSSValue(java.lang.String)
public String getParameterCSSValue(String parameterName)
null
if the parameter name is not stored in this
descriptor.
Note that it also returns null
if a formal symbol parameter
was explicitly set to null
. Use
isParameterDefined(String)
to distinguish these two cases.
The difference with getParameterValue(String)
is that
this methods returns the string in the style sheet (e.g. "@name")
instead of its computed value (the value of the model attribute "@name").
parameterName
- The name of the formal symbol parametergetParameterValue(java.lang.String)
public void setParameterValue(String parameterName, Object parameterValue)
parameterName
- The name of the formal symbol parameterparameterValue
- The value of the formal symbol parameter© Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.