ilog.views.graphlayout

Class IlvGraphLayoutGrapherProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.IlvGraphLayoutGrapherProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IltLinkLayoutGrapherProperty, IltShortLinkLayoutGrapherProperty, IlvBasicLinkStyleLayoutGrapherProperty, IlvBusLayoutGrapherProperty, IlvGridLayoutGrapherProperty, IlvHierarchicalLayoutGrapherProperty, IlvLinkLayoutGrapherProperty, IlvLongLinkLayoutGrapherProperty, IlvMultipleLayoutGrapherProperty, IlvRecursiveLayoutGrapherProperty, IlvShortLinkLayoutGrapherProperty, IlvSpringEmbedderLayoutGrapherProperty, IlvTreeLayoutGrapherProperty

public class IlvGraphLayoutGrapherProperty
extends IlvNamedProperty

The class IlvGraphLayoutGrapherProperty allows you to store the global settings of an instance of IlvGraphLayout as a named property in the grapher. This is used by IlvGrapherPropertyAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean) which is an auxiliary to be used before IlvManager.write(IlvOutputStream) if you want to store layout parameter settings in .ivl files.

If you create your own subclass of IlvGraphLayout and want to save the parameters of your subclass in .ivl files, you need to create a subclass of this class. The subclass must provide a constructor with your IlvGraphLayout subclass as input and transfer the layout parameters from the input layout to the property. It must also override the transfer method to transfer the layout parameters from the property back to the layout instance. Further information about subclassing can be found in the documentation of IlvNamedProperty.

As an example, assume that your subclass MyLayout of IlvGraphLayout has a string parameter that can be accessed by getMyParameter and set by setMyParameter. You can create a named property that can store this parameter in the following way:

 public class MyLayoutGrapherProperty extends IlvGraphLayoutGrapherProperty
 { 
  String myParameter;
 
  public MyLayoutGrapherProperty(String name, MyLayout layout, boolean withDefaults)
  {
    super(name, layout, withDefaults);
    this.myParameter = layout.getMyParameter();
  }

  public MyLayoutGrapherProperty(MyLayoutGrapherProperty source)
  {
    super(source);
    this.myParameter = source.myParameter;
  }
 
  public MyLayoutGrapherProperty(IlvInputStream stream)
    throws IOException, IlvReadFileException
  {
    super(stream);
    try {
      this.myParameter = stream.readString("myParameter");
    } catch (IlvFieldNotFoundException e) {
      this.myParameter = myParameterDefaultValue;
    }
  } 

  public IlvNamedProperty copy()
  {
    return new MyLayoutGrapherProperty(this);
  }

  public void write(IlvOutputStream stream) throws IOException
  {
    super.write(stream);
    stream.write("myParameter", this.myParameter);
  }

  public void transfer(IlvGraphLayout layout)
  {
    super.transfer(layout);
    ((MyLayout)layout).setMyParameter(this.myParameter);
  }

  public boolean isPersistent()
  {
    // this will catch the case that omitDefaults is false
    if (super.isPersistent())
      return true;

    // in case omitDefaults is true:
    if (this.myParameter != myParameterDefaultValue)
      return true;
    return false;
  }
 }
 

Note that MyLayout must override IlvGraphLayout.createLayoutGrapherProperty(String, boolean) to return an instance of your new class MyLayoutGrapherProperty.

Since:

JViews 3.5

See Also:

IlvGrapherPropertyAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean), IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherPropertyAdapter.removeParametersFromNamedProperties(), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	IlvGraphLayoutGrapherProperty(IlvGraphLayoutGrapherProperty source) Creates a new IlvGraphLayoutGrapherProperty by copying an existing one.
	IlvGraphLayoutGrapherProperty(IlvInputStream stream) Creates a new IlvGraphLayoutGrapherProperty from an IlvInputStream.
protected	IlvGraphLayoutGrapherProperty(IlvInputStream stream, boolean fromSubclass) Creates a new IlvGraphLayoutGrapherProperty from an IlvInputStream.
	IlvGraphLayoutGrapherProperty(String name, IlvGraphLayout layout, boolean withDefaults) Creates a new IlvGraphLayoutGrapherProperty that stores layout parameter settings of the layout.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the named property.
void	dispose(IlvGrapherAdapter adapter) Deprecated. Since JViews 8.8, use dispose(IlvGrapherPropertyAdapter).
void	dispose(IlvGrapherPropertyAdapter adapter) Disposes of the property and releases any resources that it is using.
protected IlvGraphLayout	getLayout() Returns the layout instance that created this property.
boolean	isPersistent() Returns true if the property must be saved to an .ivl file.
protected boolean	omitDefaults() Returns true if the layout property is not persistent when all stored parameter values are default values.
protected boolean	readProperties(IlvInputStream stream) Reads the properties from an IlvInputStream.
void	transfer(IlvGraphLayout layout) Transfers the layout parameter settings stored in this named property back to the input layout.
void	write(IlvOutputStream stream) Writes the property to the output stream.

Methods inherited from class ilog.views.IlvNamedProperty

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGraphLayoutGrapherProperty

public IlvGraphLayoutGrapherProperty(String name,
                                     IlvGraphLayout layout,
                                     boolean withDefaults)

Creates a new IlvGraphLayoutGrapherProperty that stores layout parameter settings of the layout.

Parameters:

name - The name of the property.

layout - The layout instance to be stored.

withDefaults - If true, the layout property is always persistent. If false, it is persistent only if nondefault parameter settings exist (that is, if the the property is saved to an .ivl file, the default parameter settings are not saved).

IlvGraphLayoutGrapherProperty

public IlvGraphLayoutGrapherProperty(IlvGraphLayoutGrapherProperty source)

Creates a new IlvGraphLayoutGrapherProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvGraphLayoutGrapherProperty

public IlvGraphLayoutGrapherProperty(IlvInputStream stream)
                              throws IOException,
                                     IlvReadFileException

Creates a new IlvGraphLayoutGrapherProperty from an IlvInputStream.

Parameters:

stream - The input stream from which the property must be read.

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

IlvGraphLayoutGrapherProperty

protected IlvGraphLayoutGrapherProperty(IlvInputStream stream,
                                        boolean fromSubclass)
                                 throws IOException,
                                        IlvReadFileException

Creates a new IlvGraphLayoutGrapherProperty from an IlvInputStream. This method is for internal purpose.

Parameters:

stream - The input stream from which the property must be read.

fromSubclass - Whether this constructor is called from a subclass.

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Since:

JViews 8.8

Method Detail

readProperties

protected boolean readProperties(IlvInputStream stream)
                          throws IOException,
                                 IlvReadFileException

Reads the properties from an IlvInputStream. This method is for internal purpose.

Parameters:

stream - The input stream from which the property must be read.

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Since:

JViews 8.8

getLayout

protected IlvGraphLayout getLayout()

Returns the layout instance that created this property. If the property was created by reading from IlvInputStream, it returns null.

omitDefaults

protected boolean omitDefaults()

Returns true if the layout property is not persistent when all stored parameter values are default values. Returns false if the layout property is persistent independent of default values. If the property was created by reading from IlvInputStream, it returns false.

copy

public IlvNamedProperty copy()

Copies the named property.

Specified by:

copy in class IlvNamedProperty

isPersistent

public boolean isPersistent()

Returns true if the property must be saved to an .ivl file.

Specified by:

isPersistent in class IlvNamedProperty

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the property to the output stream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

transfer

public void transfer(IlvGraphLayout layout)

Transfers the layout parameter settings stored in this named property back to the input layout.

Parameters:

layout - The layout instance whose parameters are to be recovered from this instance.

dispose

public void dispose(IlvGrapherPropertyAdapter adapter)

Disposes of the property and releases any resources that it is using. This is called if the property was loaded and removed from the grapher.

Parameters:

adapter - The grapher property adapter.

Since:

JViews 8.8

See Also:

IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherPropertyAdapter.removeParametersFromNamedProperties()

dispose

public void dispose(IlvGrapherAdapter adapter)

Deprecated. Since JViews 8.8, use dispose(IlvGrapherPropertyAdapter).

Disposes of the property and releases any resources that it is using. This is called if the property was loaded and removed from the grapher.

Parameters:

adapter - The grapher adapter.

Since:

JViews 5.0