IlvPaletteBaseObject (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.symbology.palettes.IlvPaletteBaseObject

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvPaletteCategoryChild, IlvPaletteSymbolParameter, IlvPaletteSymbolParameterValueSet
```
public abstract class IlvPaletteBaseObject
extends Object
implements Serializable
```
This class is the base class of palette symbols, palette categories and palette parameters.

Since:

JViews 8.0

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected IlvPaletteBaseObject`	`copy(IlvPaletteBaseObject owner)` Makes a copy of this object.
`protected abstract IlvPaletteBaseObject`	`createNew()` Allocates a new object of the same type.
`IlvPaletteBaseObject`	`getBaseObjectOwner()` Returns the owner of this object as palette base object.
`Locale`	`getDefaultLocale()` Returns the locale used to store name, short description and long description.
`String`	`getFullID()` Returns the full unique ID of this object.
`String`	`getID()` Returns the identifier of this object.
`String`	`getLongDescription()` Returns the long description of the object for the default locale.
`String`	`getLongDescription(Locale locale)` Returns the long description of the object for a given locale.
`String`	`getName()` Returns the name of the object for the default locale.
`String`	`getName(Locale locale)` Returns the name of the object for a given locale.
`Object`	`getOwner()` Returns the owner of this object.
`String`	`getShortDescription()` Returns the short description of the object for the default locale.
`String`	`getShortDescription(Locale locale)` Returns the short description of the object for a given locale.
`void`	`setDefaultLocale(Locale locale)` Sets the locale used to store name, short description and long description.
`void`	`setID(String id)` Sets the identifier of this object.
`void`	`setLongDescription(Locale locale, String description)` Sets the long description of the object for a given locale.
`void`	`setLongDescription(String description)` Sets the long description of the object for the default locale.
`void`	`setName(Locale locale, String name)` Sets the name of the object for a given locale.
`void`	`setName(String name)` Sets the name of the object for the default locale.
`protected void`	`setOwner(Object owner)` Returns the owner of this object.
`void`	`setShortDescription(Locale locale, String description)` Sets the short description of the object for a given locale.
`void`	`setShortDescription(String description)` Sets the short description of the object for the default locale.

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

- Method Detail
  - 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.
    
    Parameters:
    
    owner - The desired owner of the copy.
    
    Returns:
    
    the copy
  - createNew
```
protected abstract IlvPaletteBaseObject createNew()
```
    Allocates a new object of the same type.
  - getOwner
```
public Object getOwner()
```
    Returns the owner of this object.
  - setOwner
```
protected void setOwner(Object owner)
```
    Returns the owner of this object.
  - getBaseObjectOwner
```
public IlvPaletteBaseObject getBaseObjectOwner()
```
    Returns the owner of this object as palette base object.
  - getID
```
public String getID()
```
    Returns the identifier of this object.
  - setID
```
public void setID(String id)
```
    Sets the identifier of this object. You should not call this method.
    
    Parameters:
    
    id - the new identifier.
  - getFullID
```
public String getFullID()
```
    Returns the full unique ID of this object. The full ID is created from the full id of the owner and the id of this object.
  - setName
```
public void setName(Locale locale,
                    String name)
```
    Sets the name of the object for a given locale.
    
    Parameters:
    
    locale - the locale used to store the description
    
    name - the name.
  - getName
```
public String getName(Locale locale)
```
    Returns the name of the object for a given locale.
    
    Parameters:
    
    locale - the locale
  - setName
```
public void setName(String name)
```
    Sets the name of the object for the default locale. You can use setDefaultLocale(java.util.Locale) to change the locale under which the name is stored.
    
    Parameters:
    
    name - the name
    
    See Also:
    
    getDefaultLocale()
  - getName
```
public String getName()
```
    Returns the name of the object for the default locale. You can use setDefaultLocale(java.util.Locale) to change the locale under which the name is looked up.
    
    See Also:
    
    getDefaultLocale()
  - setLongDescription
```
public void setLongDescription(Locale locale,
                               String description)
```
    Sets the long description of the object for a given locale. The long description might be a paragraph of text.
    
    Parameters:
    
    locale - the locale used to store the description
    
    description - the new description
  - getLongDescription
```
public String getLongDescription(Locale locale)
```
    Returns the long description of the object for a given locale. The long description might be a paragraph of text.
    
    Parameters:
    
    locale - the locale
  - setLongDescription
```
public void setLongDescription(String description)
```
    Sets the long description of the object for the default locale. The long description might be a paragraph of text. You can use setDefaultLocale(java.util.Locale) to change the locale under which the description is stored.
    
    Parameters:
    
    description - the new description
    
    See Also:
    
    getDefaultLocale()
  - getLongDescription
```
public String getLongDescription()
```
    Returns the long description of the object for the default locale. The long description might be a paragraph of text. You can use setDefaultLocale(java.util.Locale) to change the locale under which the description is looked up.
    
    See Also:
    
    getDefaultLocale()
  - setShortDescription
```
public void setShortDescription(Locale locale,
                                String description)
```
    Sets the short description of the object for a given locale. The short description is only a short line of text.
    
    Parameters:
    
    locale - the locale used to store the description
    
    description - the new description
  - getShortDescription
```
public String getShortDescription(Locale locale)
```
    Returns the short description of the object for a given locale. The short description is only a short line of text.
    
    Parameters:
    
    locale - the locale
  - setShortDescription
```
public void setShortDescription(String description)
```
    Sets the short description of the object for the default locale. The short description is only a short line of text, used for instance for tooltips. You can use setDefaultLocale(java.util.Locale) to change the locale under which the description is stored.
    
    Parameters:
    
    description - the new description
    
    See Also:
    
    getDefaultLocale()
  - getShortDescription
```
public String getShortDescription()
```
    Returns the short description of the object for the default locale. The short description is only a short line of text, used for instance for tooltips. You can use setDefaultLocale(java.util.Locale) to change the locale under which the description is looked up.
    
    See Also:
    
    getDefaultLocale()
  - setDefaultLocale
```
public void setDefaultLocale(Locale locale)
```
    Sets the locale used to store name, short description and long description. Pass null for the locale of the default resource bundle.
    
    See Also:
    
    setName(String), getName(), setLongDescription(String), getLongDescription(), setShortDescription(String), getShortDescription()
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Returns the locale used to store name, short description and long description. Returns null for the locale of the default resource bundle.
    
    See Also:
    
    setName(String), getName(), setLongDescription(String), getLongDescription(), setShortDescription(String), getShortDescription()

Class IlvPaletteBaseObject

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copy

createNew

getOwner

setOwner

getBaseObjectOwner

getID

setID

getFullID

setName

getName

setName

getName

setLongDescription

getLongDescription

setLongDescription

getLongDescription

setShortDescription

getShortDescription

setShortDescription

getShortDescription

setDefaultLocale

getDefaultLocale