Module org.arakhne.afc.gis.giscore

Package org.arakhne.afc.gis.mapelement

Enum MapElement.VisualizationType

java.lang.Object

java.lang.Enum<MapElement.VisualizationType>

org.arakhne.afc.gis.mapelement.MapElement.VisualizationType

All Implemented Interfaces:

Serializable, Comparable<MapElement.VisualizationType>

Enclosing class:

MapElement

public static enum MapElement.VisualizationType
extends Enum<MapElement.VisualizationType>

Describes how the map element was displayed.

Since:

14.0

Version:

17.0 2020-01-04 14:41:53

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.gis

Maven Artifact Id:

giscore

Enum Constant Summary

Enum Constants

Enum Constant	Description
ICON_ONLY	Only the icon of the element must be displayed.
SHAPE_AND_ICON	The shape and the icon of the element must be displayed.
SHAPE_ONLY	Only the shape of the element must be displayed.

Method Summary

Modifier and Type	Method	Description
boolean	isIcon()	Replies if this visualization type includes the icon.
boolean	isShape()	Replies if this visualization type includes the shape.
static MapElement.VisualizationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MapElement.VisualizationType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHAPE_ONLY

public static final MapElement.VisualizationType SHAPE_ONLY

Only the shape of the element must be displayed.

ICON_ONLY

public static final MapElement.VisualizationType ICON_ONLY

Only the icon of the element must be displayed.

SHAPE_AND_ICON

public static final MapElement.VisualizationType SHAPE_AND_ICON

The shape and the icon of the element must be displayed.

Method Detail

values

public static MapElement.VisualizationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MapElement.VisualizationType c : MapElement.VisualizationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MapElement.VisualizationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isShape

@Pure
public boolean isShape()

Replies if this visualization type includes the shape.

Returns:

true if this type allows to display a shape.

isIcon

@Pure
public boolean isIcon()

Replies if this visualization type includes the icon.

Returns:

true if this type allows to display an icon.