FreeHEP API
Version current

hep.graphics.heprep
Interface HepRepAttribute

All Superinterfaces:
HepRepConstants
All Known Subinterfaces:
HepRepDefinition, HepRepInstance, HepRepPoint, HepRepType
All Known Implementing Classes:
AbstractHepRepInstanceAdapter, AbstractHepRepTypeAdapter, CORBAHepRepAttribute, CORBAHepRepDefinition, DefaultHepRepAttribute, DefaultHepRepDefinition, DefaultHepRepInstance, DefaultHepRepPoint, DefaultHepRepType, HepRepAttributeAdapter, HepRepDefinitionAdapter, HepRepDefinitionAdapter, HepRepInstanceAdapter, HepRepInstanceAdapter, HepRepPointAdapter, HepRepPointAdapter, HepRepPointAdapter, HepRepTypeAdapter, HepRepTypeAdapter

public interface HepRepAttribute
extends HepRepConstants

HepRepAttribute interface.

Author:
Mark Donszelmann
Source Code:
HepRepAttribute.java

Field Summary
 
Fields inherited from interface hep.graphics.heprep.HepRepConstants
SHOW_DESC, SHOW_EXTRA, SHOW_NAME, SHOW_NONE, SHOW_VALUE, TYPE_BOOLEAN, TYPE_COLOR, TYPE_DOUBLE, TYPE_INT, TYPE_LONG, TYPE_STRING, TYPE_UNKNOWN
 
Method Summary
 void addAttValue(HepRepAttValue attValue)
          Adds an attValue.
 void addAttValue(String key, boolean value)
          Adds an attValue.
 void addAttValue(String key, boolean value, int showLabel)
          Adds an attValue.
 void addAttValue(String key, Color value)
          Adds a Color attValue.
 void addAttValue(String key, Color value, int showLabel)
          Adds a Color attValue.
 void addAttValue(String key, double value)
          Adds an attValue.
 void addAttValue(String key, double value, int showLabel)
          Adds an attValue.
 void addAttValue(String key, int value)
          Adds an attValue.
 void addAttValue(String key, int value, int showLabel)
          Adds an attValue.
 void addAttValue(String key, String value)
          Adds an attValue.
 void addAttValue(String key, String value, int showLabel)
          Adds an attValue.
 HepRepAttValue getAttValue(String name)
          Returns the attValue specified by name.
 HepRepAttValue getAttValueFromNode(String lowerCaseName)
          Returns a named attribute value from this node.
 Set getAttValuesFromNode()
          Returns a collection of all attribute values from this node.
 HepRepAttValue removeAttValue(String key)
          Remove the attvalue named by key.
 

Method Detail

addAttValue

public void addAttValue(HepRepAttValue attValue)
Adds an attValue.

Parameters:
attValue - to be added.

addAttValue

public void addAttValue(String key,
                        String value)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue

addAttValue

public void addAttValue(String key,
                        String value,
                        int showLabel)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue
showLabel - show this as label

addAttValue

public void addAttValue(String key,
                        int value)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue

addAttValue

public void addAttValue(String key,
                        int value,
                        int showLabel)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue
showLabel - show this as label

addAttValue

public void addAttValue(String key,
                        double value)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue

addAttValue

public void addAttValue(String key,
                        double value,
                        int showLabel)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue
showLabel - show this as label

addAttValue

public void addAttValue(String key,
                        boolean value)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue

addAttValue

public void addAttValue(String key,
                        boolean value,
                        int showLabel)
Adds an attValue.

Parameters:
key - name of attValue
value - value of attValue
showLabel - show this as label

addAttValue

public void addAttValue(String key,
                        Color value)
Adds a Color attValue.

Parameters:
key - name of attValue
value - value of attValue

addAttValue

public void addAttValue(String key,
                        Color value,
                        int showLabel)
Adds a Color attValue.

Parameters:
key - name of attValue
value - value of attValue
showLabel - show this as label

removeAttValue

public HepRepAttValue removeAttValue(String key)
Remove the attvalue named by key.

Parameters:
key - name of the attValue to be removed.
Returns:
removed HepRepAttValue, or null if not removed.

getAttValue

public HepRepAttValue getAttValue(String name)
Returns the attValue specified by name. This attValue is normally searched on the node itself and then on its type, moving up the typetree.

Parameters:
name - of attribute value.
Returns:
attribute value.

getAttValuesFromNode

public Set getAttValuesFromNode()
Returns a collection of all attribute values from this node.

Returns:
collection of HepRepAttValues.

getAttValueFromNode

public HepRepAttValue getAttValueFromNode(String lowerCaseName)
Returns a named attribute value from this node.

Parameters:
lowerCaseName - name in all lowercase.
Returns:
corresponding HepRepAttValue.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.