cee::ug::OverlayColorLegendPropertyHandler Class Reference

Property handler for overlay color legend properties. More...

Public Types

enum  PropertyKey {
  CONTEXT_RESULT_ID, TEXT_COLOR, LINE_COLOR, LINE_WIDTH,
  BAR_WIDTH, VISIBILITY_MODE, COLOR_MARKER_POSITIONS, COLOR_MARKER_COLORS,
  COLOR_MARKER_DESCRIPTIONS, CUSTOM_LEGEND_TITLE, NUMERIC_FORMAT, NUMERIC_PRECISION,
  USER_SCALING_FIRST_DEGREE, USER_SCALING_CONSTANT, FORCE_UNIFORM_LEVEL_SPACING, ABOVE_BELOW_RANGE_MARKER_MODE,
  COLOR_MARKER_BOX_HEIGHT, COLOR_MARKER_VERTICAL_MARGIN, FORCE_TICKMARKS_OVER_LEGEND, TICKMARKS_POSITION,
  DIRECTION, TICKMARKS_SKIP_OVERLAPPING_LABELS, TICKMARKS_MINIMUM_LABEL_DISTANCE, DEPRECATED_VISIBLE
}
 List of property keys for OverlayColorLegendPropertyHandler. More...
 

Public Member Functions

 OverlayColorLegendPropertyHandler (PropertySet *propSet)
 Creates an overlay color legend property handler from a given property set propSet. More...
 
Variant propertyValue (PropertyKey key) const
 Returns the property value for the specified property key. More...
 
void setPropertyValue (PropertyKey key, Variant data)
 Sets the property key and value to this handlers property set. More...
 
bool decodeContext (int *resultId) const
 Decodes the context from the properties. More...
 
void encodeContext (int resultId)
 Encodes the context as properties. More...
 
void applyToScalarSettings (ScalarSettings *scalarSettings) const
 Applies the properties in this property set to the specified scalar settings. More...
 
void buildProperties (const ScalarSettings &scalarSettings)
 Sets the property keys and values for this property set from the scalar settings. More...
 

Static Public Member Functions

static Str propertySetClassType ()
 Returns the class type of the property set. More...
 
static bool isValidPropertySet (const PropertySet &propSet)
 Returns true if the specified property set is a valid overlay color legend property set. More...
 

Detailed Description

Property handler for overlay color legend properties.

Member Enumeration Documentation

List of property keys for OverlayColorLegendPropertyHandler.

Enumerator
CONTEXT_RESULT_ID 

Context result id.

TEXT_COLOR 

Legend text color.

LINE_COLOR 

Legend line color.

Constructor & Destructor Documentation

cee::ug::OverlayColorLegendPropertyHandler::OverlayColorLegendPropertyHandler ( PropertySet propSet)

Creates an overlay color legend property handler from a given property set propSet.

Member Function Documentation

void cee::ug::OverlayColorLegendPropertyHandler::applyToScalarSettings ( ScalarSettings scalarSettings) const

Applies the properties in this property set to the specified scalar settings.

void cee::ug::OverlayColorLegendPropertyHandler::buildProperties ( const ScalarSettings scalarSettings)

Sets the property keys and values for this property set from the scalar settings.

bool cee::ug::OverlayColorLegendPropertyHandler::decodeContext ( int *  resultId) const

Decodes the context from the properties.

void cee::ug::OverlayColorLegendPropertyHandler::encodeContext ( int  resultId)

Encodes the context as properties.

bool cee::ug::OverlayColorLegendPropertyHandler::isValidPropertySet ( const PropertySet propSet)
static

Returns true if the specified property set is a valid overlay color legend property set.

Str cee::ug::OverlayColorLegendPropertyHandler::propertySetClassType ( )
static

Returns the class type of the property set.

cee::Variant cee::ug::OverlayColorLegendPropertyHandler::propertyValue ( PropertyKey  key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void cee::ug::OverlayColorLegendPropertyHandler::setPropertyValue ( PropertyKey  key,
Variant  data 
)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.