User Tools

Site Tools


api:dk11:java:tatukgis.jdk.tgis_controllegend

TGIS_ControlLegend class

DK11 for Java | tatukgis.jdk.TGIS_ControlLegend | Classes | Constructors | Methods | Properties | Events

Visual Legend component.

Available also on: Delphi FMX | .NET WinForms | ActiveX | Python.

Syntax

// Java
public class TGIS_ControlLegend extends JPanel implements KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, ComponentListener, IGIS_LegendParent, IGIS_PrintableControl {
};
// Oxygene
type
  TGIS_ControlLegend = public class( JPanel, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, ComponentListener, IGIS_LegendParent, IGIS_PrintableControl )
  end;

Inheritance

→ JPanel

Implements

KeyListener MouseListener MouseMotionListener MouseWheelListener ComponentListener IGIS_LegendParent IGIS_PrintableControl

Constructors

Inherited Overrides Protected
Name Visibility Description
TGIS_ControlLegend() public Constructor, creates an instance.

Methods

Inherited Overrides Protected
Name Visibility Description
Collapse(IGIS_HierarchyGroup) public Collapses a legend item corresponding to a hierarchy group.
Collapse(IGIS_HierarchyGroup, bool, bool) public Collapses a legend item corresponding to a hierarchy group.
Collapse(TGIS_Layer) public Collapses a legend item corresponding to a layer.
ControlClientHeight protected Gets client height.
(Implements IGIS_LegendParent.ControlClientHeight)
ControlClientWidth protected Gets client width.
(Implements IGIS_LegendParent.ControlClientWidth)
ControlDragCreateTemporaryContext protected Creates temporary context to avoid flickering.
(Implements IGIS_LegendParent.ControlDragCreateTemporaryContext)
ControlDragDrawBar protected Draws drag bar.
(Implements IGIS_LegendParent.ControlDragDrawBar)
ControlDragDrawNode protected Draws drag bitmap.
(Implements IGIS_LegendParent.ControlDragDrawNode)
ControlDragFreeNode protected Frees a node for dragging.
(Implements IGIS_LegendParent.ControlDragFreeNode)
ControlDragPrepareNode protected Draws a node for dragging.
(Implements IGIS_LegendParent.ControlDragPrepareNode)
ControlDragRenderTemporaryContext protected Renders temporary context and destroy it.
(Implements IGIS_LegendParent.ControlDragRenderTemporaryContext)
ControlDrawFromCache protected Draws cache.
(Implements IGIS_LegendParent.ControlDrawFromCache)
ControlDrawNode protected Draws a node.
(Implements IGIS_LegendParent.ControlDrawNode)
ControlFullUpdate protected Causes repaint of the entire control.
(Implements IGIS_LegendParent.ControlFullUpdate)
ControlGetHScrollPosition protected Gets horizontal scrollbar position.
(Implements IGIS_LegendParent.ControlGetHScrollPosition)
ControlGetVScrollPosition protected Gets vertical scrollbar position.
(Implements IGIS_LegendParent.ControlGetVScrollPosition)
ControlHeight protected Gets control height.
(Implements IGIS_LegendParent.ControlHeight)
ControlIsDesignMode protected Checks if the control is in design mode.
(Implements IGIS_LegendParent.ControlIsDesignMode)
ControlRenderer protected Gets renderer instance.
(Implements IGIS_LegendParent.ControlRenderer)
ControlRepaint protected Repaints the control.
(Implements IGIS_LegendParent.ControlRepaint)
ControlRightToLeft protected Checks if the control is in 'right to left' mode.
(Implements IGIS_LegendParent.ControlRightToLeft)
ControlSetHScroll protected Sets horizontal scrollbar range & position.
(Implements IGIS_LegendParent.ControlSetHScroll)
ControlSetHScrollPosition protected Sets horizontal scrollbar position.
(Implements IGIS_LegendParent.ControlSetHScrollPosition)
ControlSetVScroll protected Sets vertical scrollbar range & position.
(Implements IGIS_LegendParent.ControlSetVScroll)
ControlSetVScrollPosition protected Sets vertical scrollbar position.
(Implements IGIS_LegendParent.ControlSetVScrollPosition)
ControlStyleCreateTemporaryContext protected Creates temporary context.
(Implements IGIS_LegendParent.ControlStyleCreateTemporaryContext)
ControlStyleDrawCheckBox protected Draws a check box.
(Implements IGIS_LegendParent.ControlStyleDrawCheckBox)
ControlStyleDrawExpandCollapseMarker protected Draws an expand/collapse marker.
(Implements IGIS_LegendParent.ControlStyleDrawExpandCollapseMarker)
ControlStyleDrawImage protected Draws image on temporary context.
(Implements IGIS_LegendParent.ControlStyleDrawImage)
ControlStyleDrawRectangle(int, int, int, int, TGIS_Color, TGIS_Color) protected Draws a rectangle.
(Implements IGIS_LegendParent.ControlStyleDrawRectangle)
ControlStyleDrawRectangle(TRect) protected Draws a rectangle.
(Implements IGIS_LegendParent.ControlStyleDrawRectangle)
ControlStyleDrawText protected Draws text.
(Implements IGIS_LegendParent.ControlStyleDrawText)
ControlStyleGetColor protected Gets background color.
(Implements IGIS_LegendParent.ControlStyleGetColor)
ControlStyleGetTextExtent protected Gets text extent.
(Implements IGIS_LegendParent.ControlStyleGetTextExtent)
ControlStyleRenderTemporaryContext protected Renders temporary context and destroy it.
(Implements IGIS_LegendParent.ControlStyleRenderTemporaryContext)
ControlStyleSetColor protected Sets background color.
(Implements IGIS_LegendParent.ControlStyleSetColor)
ControlSubscribedUpdate protected Does subscribed update.
(Implements IGIS_LegendParent.ControlSubscribedUpdate)
ControlUpdate protected Does update.
(Implements IGIS_LegendParent.ControlUpdate)
ControlWidth protected Gets control width.
(Implements IGIS_LegendParent.ControlWidth)
CreateCopy public Prepare a copy of the control for printing.
(Implements IGIS_PrintableControl.CreateCopy)
DrawBmp public Draws control on a provided bitmap.
Expand(IGIS_HierarchyGroup) public Expands of a legend item associated with the specific hierarchy group.
Expand(IGIS_HierarchyGroup, bool, bool) public Expands a legend item corresponding to a hierarchy group.
Expand(TGIS_Layer) public Expands a legend item associated with the specific layer.
FreeCopy public Release the copy of the control.
(Implements IGIS_PrintableControl.FreeCopy)
getBackground public
getFont public
getForeground public
GetNodeAt public Retrieves the node at a given position.
IsExpanded(IGIS_HierarchyGroup) public Checks if the legend item is associated with the specific hierarchy group is expanded.
IsExpanded(TGIS_Layer) public Checks if the legend item is associated with the specific layer is expanded.
paintComponent protected
PrintBmp public Print the control on the given bitmap.
(Implements IGIS_PrintableControl.PrintBmp)
PrintClipboard public Prints the current state of the legend to the clipboard as a bitmap.
repaint public
setBackground public
setBorder public
setComponentOrientation public
setFont public
setForeground public
TapDouble protected Event handler of the double tap action.
TapLong protected Event handler of the long tap action.
TapSingle protected Event handler of the single tap action.

Properties

Inherited Protected
Name Visibility Description
CompactView public If True then the legend view is compacted - icons are smaller.
DialogOptions public Options defining dialogs behavior.
DrawIconStyle public Draw style of legend icons.
GIS_Group public Selected group.
GIS_Layer public Selected layer.
GIS_Layers public Selected layers.
GIS_Viewer public Attached IGIS_Viewer object.
InternalName public Used for internal use of TatukGIS.
(Implements IGIS_PrintableControl.InternalName)
Mode public Mode of the legend - list of layers or grouped tree view.
Options public Options of the legend.
ReverseOrder public True if the order of legend entries in the Layer mode should be reverse, i.e.
RightToLeftFromTranslation public Defines which RightToLeft will be used: the one from property or the one from translation
SelectedNode public Selected node.

Events

Inherited Protected
Name Visibility Description
GroupActiveChangeEvent public Event fired when a group is activated/deactivated.
GroupSelectEvent public Event fired upon group selection.
LayerActiveChangeEvent public Event fired when a layer is activated/deactivated.
LayerParamsChangeEvent public Event fired when a layer parameters get changed.
LayerSelectEvent public Event fired upon layer selection.
OpenDialogEvent public Event fired upon opening of the layer properties dialog box.
OrderChangeEvent public Event fired upon a change of the order of layers.
TapDoubleEvent public TapDouble event.
TapLongEvent public TapLong event.
TapSimpleEvent public TapSimple event.

Remarks

Place this component on a form and connect GIS_Viewer to IGIS_Viewer object. Selected layer is available via GIS_Layer property.

References

2024/04/28 01:39

Page Tools