ilog.views.symbology.palettes

Class IlvPaletteSymbol

java.lang.Object

ilog.views.symbology.palettes.IlvPaletteBaseObject

ilog.views.symbology.palettes.IlvPaletteCategoryChild

ilog.views.symbology.palettes.IlvPaletteSymbol

All Implemented Interfaces:

IlvPaletteObject, Serializable

public class IlvPaletteSymbol
extends IlvPaletteCategoryChild
implements IlvPaletteObject

Palette symbols are objects containing description data of symbols that can be added in a dashboard or a map, for example.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SMALLICON_SIZE size of small icon representing the symbol

Constructor Summary

Constructors

Constructor and Description
IlvPaletteSymbol(String id) Creates a symbol and sets its ID.

Method Summary

Modifier and Type	Method and Description
void	addParameter(IlvPaletteSymbolParameter parameter) Adds a new additional parameter to the list.
void	addResource(String resource) Adds, in a list, an external resources used by the symbol and referenced into its CSS file.
void	addResource(URL resource) Adds, in a list, an external resources used by the symbol and referenced into its CSS file.
protected IlvPaletteBaseObject	copy(IlvPaletteBaseObject owner) Makes a copy of this object.
String	createClassDeclarationValue() Returns the string to create this symbol in CSS class declaration.
protected IlvPaletteBaseObject	createNew() Allocates a new object of the same type.
String	getClassName() Gets class name of the symbol as described into its css file
String	getCSSResourceName() Returns the resource access string to the symbol CSS.
URL	getCSSURL() Returns the URL to the CSS description file of this symbol.
static IlvPaletteSymbolParameter[]	getGraphicParameters() Returns an array of predefined graphic parameters available for any symbol
ImageIcon	getIcon() Returns the large size icon representing the symbol.
String	getIconResourceName() Returns the resource access string to the icon of the symbol.
URL	getIconURL() Gets the string representation of the URL to the icon
IlvPaletteSymbolParameter	getParameter(int index) Returns the parameter at the specified position in the parameter list.
IlvPaletteSymbolParameter	getParameter(String id) Returns the first parameter of the list having the specified id.
int	getParameterCount() Returns the number of additional parameters added to this symbol.
Object	getPropertyDescriptors() Returns an object describing the property descriptors of the symbol.
Enumeration	getResources() Gets enumeration of symbol's external resources.
URL	getResourceURL(String resource) Converts the resource to an URL.
ImageIcon	getSmallIcon() Returns the small size icon representing the symbol.
String	getVersion() Returns the version number of this symbol
void	removeAllParameters() Removes all additional parameters
void	removeAllResources() Clears the list of symbol's external resources.
void	removeParameter(IlvPaletteSymbolParameter parameter) Removes specified parameter from the list.
void	setClassName(String className) Set symbol's class name
void	setCSSResourceName(String s) Sets the resource access string of the CSS file of the symbol.
void	setCSSURL(URL css) Sets the URL to access to the CSSs description file, and updates resource access string returned by getCSSResourceName()
void	setIconResourceName(String s) Set the resource access string of the symbol's icon.
void	setIconURL(URL iconurl) Sets the url to the icon file.
void	setPropertyDescriptors(Object descriptors) Sets an object describing the property descriptors of the symbol.
void	setVersion(String version) Sets the version number of this symbol.

Methods inherited from class ilog.views.symbology.palettes.IlvPaletteCategoryChild

copy, getPalette, getParent, toString

Methods inherited from class ilog.views.symbology.palettes.IlvPaletteBaseObject

getBaseObjectOwner, getDefaultLocale, getFullID, getID, getLongDescription, getLongDescription, getName, getName, getOwner, getShortDescription, getShortDescription, setDefaultLocale, setID, setLongDescription, setLongDescription, setName, setName, setOwner, setShortDescription, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.views.symbology.palettes.IlvPaletteObject

copy, getID, getPalette, getParent

Field Detail

SMALLICON_SIZE

public static final int SMALLICON_SIZE

size of small icon representing the symbol

See Also:

Constant Field Values

Constructor Detail

IlvPaletteSymbol

public IlvPaletteSymbol(String id)

Creates a symbol and sets its ID.

Parameters:

id - The identifier of the symbol.

Method Detail

getIcon

public ImageIcon getIcon()

Returns the large size icon representing the symbol.

Returns:

ImageIcon The icon.

See Also:

getSmallIcon()

getSmallIcon

public ImageIcon getSmallIcon()

Returns the small size icon representing the symbol. This icon is automatically generated from the large size icon, and its size is predefined to 16x16 pixels.

Returns:

ImageIcon The icon

See Also:

getIcon()

getCSSURL

public URL getCSSURL()

Returns the URL to the CSS description file of this symbol.

setCSSURL

public void setCSSURL(URL css)

Sets the URL to access to the CSSs description file, and updates resource access string returned by getCSSResourceName()

Parameters:

css - The new URL to the CSS file.

setCSSResourceName

public void setCSSResourceName(String s)

Sets the resource access string of the CSS file of the symbol. It also updates the URL to access this resource (see getCSSURL() )

Parameters:

s - The new resource access string

getCSSResourceName

public String getCSSResourceName()

Returns the resource access string to the symbol CSS.

copy

protected IlvPaletteBaseObject copy(IlvPaletteBaseObject owner)

Makes a copy of this object. The copy is not owned by any owner, but it can later only be added to the input owner. You should not call this method.

Overrides:

copy in class IlvPaletteCategoryChild

Parameters:

owner - The desired owner of the copy.

Returns:

the copy

createNew

protected IlvPaletteBaseObject createNew()

Allocates a new object of the same type.

Specified by:

createNew in class IlvPaletteBaseObject

getClassName

public String getClassName()

Gets class name of the symbol as described into its css file

Returns:

the class name

setClassName

public void setClassName(String className)

Set symbol's class name

Parameters:

className - the new class name

createClassDeclarationValue

public String createClassDeclarationValue()

Returns the string to create this symbol in CSS class declaration. This method is used when creating the CSS of an application that wants to use this symbol. For instance, in

 node {
    class: symbolspec;
    ...
 }
 

the symbolspec is the string generated by this method.

getIconURL

public URL getIconURL()

Gets the string representation of the URL to the icon

Returns:

String string format of the url

setIconURL

public void setIconURL(URL iconurl)

Sets the url to the icon file. It also updates the resource access string returned by getIconResourceName()

Parameters:

iconurl - url of the icon

setIconResourceName

public void setIconResourceName(String s)

Set the resource access string of the symbol's icon. It also update the URL to access this resource (see getIconURL() )

Parameters:

s - the new resource access string

getIconResourceName

public String getIconResourceName()

Returns the resource access string to the icon of the symbol.

addParameter

public void addParameter(IlvPaletteSymbolParameter parameter)

Adds a new additional parameter to the list.

Parameters:

parameter - the new parameter

removeParameter

public void removeParameter(IlvPaletteSymbolParameter parameter)

Removes specified parameter from the list.

Parameters:

parameter - the parameter to be removed

getParameterCount

public int getParameterCount()

Returns the number of additional parameters added to this symbol.

Returns:

int parameter count

getParameter

public IlvPaletteSymbolParameter getParameter(int index)

Returns the parameter at the specified position in the parameter list.

Parameters:

index - index of the parameter to return

Returns:

the parameter at the specified position in the list, or null if not found

getParameter

public IlvPaletteSymbolParameter getParameter(String id)

Returns the first parameter of the list having the specified id.

Parameters:

id - the identifier of the parameter.

Returns:

the parameter with same id, null if not found

See Also:

IlvPaletteBaseObject.getID()

removeAllParameters

public void removeAllParameters()

Removes all additional parameters

getGraphicParameters

public static IlvPaletteSymbolParameter[] getGraphicParameters()

Returns an array of predefined graphic parameters available for any symbol

addResource

public void addResource(URL resource)

Adds, in a list, an external resources used by the symbol and referenced into its CSS file. When saving the palette, all resources of this symbol will be put into the jar file of the palette, and the CSS file of the symbol will be update to be link to new resource's locations.

Parameters:

resource - the path of the resource

addResource

public void addResource(String resource)

Adds, in a list, an external resources used by the symbol and referenced into its CSS file. When saving the palette, all resources of this symbol will be put into the jar file of the palette, and the CSS file of the symbol will be update to be link to new resource's locations. Resources can be specified relative to the URL of the CSS.

Parameters:

resource - the path of the resource

getResources

public Enumeration getResources()

Gets enumeration of symbol's external resources. The enumeration contains strings. In order to access the corresponding URLs, use getResourceURL(java.lang.String).

Returns:

the resources (strings)

getResourceURL

public URL getResourceURL(String resource)

Converts the resource to an URL.

See Also:

getResources()

removeAllResources

public void removeAllResources()

Clears the list of symbol's external resources.

getPropertyDescriptors

public Object getPropertyDescriptors()

Returns an object describing the property descriptors of the symbol. This is used for internal purpose; do not call this method.

setPropertyDescriptors

public void setPropertyDescriptors(Object descriptors)

Sets an object describing the property descriptors of the symbol. This is used for internal purpose; do not call this method.

getVersion

public String getVersion()

Returns the version number of this symbol

setVersion

public void setVersion(String version)

Sets the version number of this symbol. The version is a free formatted string given by the user.

Parameters:

version - The new version number