ilog.cpl.graphic
Class IlpSelectionFocusMode

java.lang.Object
  ilog.util.IlEnum
      ilog.cpl.graphic.IlpSelectionFocusMode

public class IlpSelectionFocusMode
extends IlEnum

This class enumerates the possible highlight modes used to render the selection and focus. The selection highlight mode indicates which part of the graphical representation of an object holds the selection and focus.

Since:

JTGO 3.0

Nested Class Summary

static class	IlpSelectionFocusMode.SelectionFocusModeArrayEditor Static property editor for array of IlpSelectionFocusMode class.
static class	IlpSelectionFocusMode.SelectionFocusModeEditor Static property editor for the IlpSelectionFocusMode class.

Field Summary

static IlpSelectionFocusMode	BASE_SELECTION_FOCUS_MODE Using this mode, the selection is rendered by highlighting the base of the graphical representation.
static IlpSelectionFocusMode	CELL_SELECTION_FOCUS_MODE Using this mode, the selection is rendered by highlighting the whole cell.
static IlpSelectionFocusMode	LABEL_SELECTION_FOCUS_MODE Using this mode, the selection is rendered by highlighting only the label.
static IlEnumInfo	metainfo Metainformation about selection focus mode.

Constructor Summary

IlpSelectionFocusMode()
Default constructor.

IlpSelectionFocusMode(String name)
Creates a new enumeration value.

Method Summary

void	setName(String name) Sets the name of this object.

Methods inherited from class ilog.util.IlEnum

getName, intern, toString

Methods inherited from class java.lang.Object

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

Field Detail

metainfo

public static final IlEnumInfo metainfo

Metainformation about selection focus mode.

CELL_SELECTION_FOCUS_MODE

public static final IlpSelectionFocusMode CELL_SELECTION_FOCUS_MODE

Using this mode, the selection is rendered by highlighting the whole cell.

This highlight mode is implemented by:

• IlpTreeCellRenderer for the Tree component
• IlpTableCellRenderer for the Table component

The Network and Equipment components do not provide the notion of cell and do not handle this highlight mode.

When implementing your own IlpGraphicRenderer you should ignore the selected state when the selection highlight mode has this value.

LABEL_SELECTION_FOCUS_MODE

public static final IlpSelectionFocusMode LABEL_SELECTION_FOCUS_MODE

Using this mode, the selection is rendered by highlighting only the label. This mode should be implemented by IlpGraphicRenderer.

When implementing your own IlpGraphicRenderer you should handle this mode by changing the background and foreground color of the label when the object is selected, and draw the focus border around the label when the object has the focus.

BASE_SELECTION_FOCUS_MODE

public static final IlpSelectionFocusMode BASE_SELECTION_FOCUS_MODE

Using this mode, the selection is rendered by highlighting the base of the graphical representation. This mode should be implemented by IlpGraphicRenderer.

When implementing your own IlpGraphicRenderer you should handle this mode by enhancing the base of the graphical representation of the rendered object when the object is selected, and draw the focus border around the base when the object has the focus.

Constructor Detail

IlpSelectionFocusMode

public IlpSelectionFocusMode(String name)

Creates a new enumeration value.

IlpSelectionFocusMode

public IlpSelectionFocusMode()

Default constructor. This constructor is used by CSS styling mechanism and is not meant to be called directly.

Internal method or field: do not use!

Method Detail

setName

public void setName(String name)

Sets the name of this object. This method is used by CSS styling mechanism and is not meant to be called directly.

Overrides:

setName in class IlEnum

Internal method or field: do not use!