Search this API

y.view
Class YLabel.Factory

java.lang.Object
  extended by y.view.YLabel.Factory
Enclosing class:
YLabel

public static final class YLabel.Factory
extends java.lang.Object

This class is used for managing the different configurations for YLabel instances. An instance of this class can be obtained using the static methods NodeLabel.getFactory() and EdgeLabel.getFactory() respectively.

See Also:
YLabel.setConfiguration(String), YLabel.Layout, YLabel.BoundsProvider, YLabel.UserDataHandler, YLabel.Painter, DefaultLabelConfiguration
 

Method Summary
 void addConfiguration(java.lang.String description, java.util.Map implementationMap)
          Uses the key/value pairs from the given Map to store a configuration under the given descriptive string name.
 void configure(YLabel label, java.lang.String description)
          Configures the given YLabel instance using a configuration that has been previously added to this factory using the descriptive String name.
 java.util.Map createDefaultConfigurationMap()
          Returns a Map holding the default configuration for YLabel.
 java.util.Set getAvailableConfigurations()
          Returns a read-only view of the configuration names added to this factory instance.
 java.lang.Object getImplementation(java.lang.String configuration, java.lang.Class interfaze)
           
 void removeConfiguration(java.lang.String description)
          Removes a configuration from this factory by name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createDefaultConfigurationMap

public java.util.Map createDefaultConfigurationMap()
Returns a Map holding the default configuration for YLabel.

Returns:
a Map holding the default configuration for YLabel

addConfiguration

public void addConfiguration(java.lang.String description,
                             java.util.Map implementationMap)
Uses the key/value pairs from the given Map to store a configuration under the given descriptive string name. The map will be queried using the class objects of the various interfaces that are supported by the YLabel class for appropriate interface implementations. Values will be copied by reference from the map.

Throws:
java.lang.IllegalArgumentException - if any of the required interface implementations is not provided by the map.
java.lang.NullPointerException - if the description is null
See Also:
YLabel.Layout, YLabel.BoundsProvider, YLabel.UserDataHandler, YLabel.Painter

configure

public void configure(YLabel label,
                      java.lang.String description)
Configures the given YLabel instance using a configuration that has been previously added to this factory using the descriptive String name.

Throws:
java.lang.IllegalArgumentException - if no such configuration has been stored in this factory instance.

getAvailableConfigurations

public java.util.Set getAvailableConfigurations()
Returns a read-only view of the configuration names added to this factory instance.


removeConfiguration

public void removeConfiguration(java.lang.String description)
Removes a configuration from this factory by name.


getImplementation

public java.lang.Object getImplementation(java.lang.String configuration,
                                          java.lang.Class interfaze)

© Copyright 2000-2022,
yWorks GmbH.
All rights reserved.