com.inductiveautomation.factorypmi.application.components

Class PMIDateRange

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel

com.inductiveautomation.factorypmi.application.components.PMIDateRange

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, DesignerInitializable, EnabledEx, QualityMonitor, VisionComponent, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class PMIDateRange
extends AbstractVisionPanel
implements java.awt.event.ActionListener, java.beans.PropertyChangeListener, LocaleListener, DesignerInitializable, EnabledEx

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PMIDateRange.DateRange Represents a range of dates, from a start to an end
static class	PMIDateRange.DateRangeSlider
static class	PMIDateRange.TouchscreenField

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fillBackground
static int	STARTUP_AUTO
static int	STARTUP_NONE

Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel

antialias, context, cursorCode, dynamicProps

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx

DISABLED_BY_PERMISSIONS

Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider

RESERVED_SET_KEY

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle

COMPONENT_RUNNING

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
PMIDateRange()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) This handles the scroll and zoom buttons
protected javax.swing.Icon	createIcon(java.lang.String name)
protected void	doZoomIn()
protected void	doZoomOut()
void	evaluateEnabled()
java.awt.Color	getBoxFill()
int	getDateStyle()
Dataset	getDensityData()
java.awt.Color	getEditorBackground()
java.awt.Color	getEditorForegroundColor()
java.util.Date	getEndDate()
protected PMIDateRange.DateRange	getGrossRange()
java.awt.Color	getHighDensityColor()
java.lang.String	getMaxSelectionSize()
java.util.Date	getOuterRangeEndDate()
java.util.Date	getOuterRangeStartDate()
java.awt.Color	getSelectionHighlight()
java.util.Date	getStartDate()
int	getStartupMode()
java.lang.String	getStartupRange()
java.lang.String	getStartupSelection()
float	getTickDensity()
int	getTimeStyle()
java.awt.Color	getTodayIndicatorColor()
int	getTrackMargin()
int	getUnit()
protected void	initComponents()
void	initialize()
void	initializeStartupRange()
boolean	isComponentEnabled()
boolean	isFillBackground()
boolean	isOpaque()
void	localeChanged(java.util.Locale newLocale)
static void	main(java.lang.String[] args)
protected void	onStartup() Subclasses should override this to provide startup logic.
protected void	paintComponent(java.awt.Graphics g)
void	propertyChange(java.beans.PropertyChangeEvent evt) This handles the gross unit editor (the text field) changing its date range, as well as the slider changing its selected range
void	setBounds(int x, int y, int width, int height)
void	setBoxFill(java.awt.Color boxFill)
void	setComponentEnabled(boolean componentEnabled)
void	setDateStyle(int dateStyle)
void	setDensityData(Dataset densityData)
void	setEditorBackground(java.awt.Color bg)
void	setEditorForegroundColor(java.awt.Color color)
void	setEnabled(boolean en)
void	setEndDate(java.util.Date endDate)
void	setFillBackground(boolean fillBackground)
void	setFont(java.awt.Font font)
void	setForeground(java.awt.Color fg)
protected void	setGrossRange(PMIDateRange.DateRange range)
void	setHighDensityColor(java.awt.Color color)
void	setHistogram(IHistogram histogram)
void	setMaxSelectionSize(java.lang.String maxSelectionSize)
void	setOpaque(boolean isOpaque)
void	setOuterRange(java.util.Date rangeStartDate, java.util.Date rangeEndDate) Scripting function to let user change the outer range without running into complications with the order dates are set.
void	setOuterRangeEndDate(java.util.Date rangeEndDate)
void	setOuterRangeStartDate(java.util.Date rangeStartDate)
void	setRange(java.util.Date rangeStartDate, java.util.Date rangeEndDate) Scripting function to let user change the selected range without running into complications with the order dates are set.
void	setSelectionHighlight(java.awt.Color selectionHighlight)
void	setStartDate(java.util.Date startDate)
void	setStartupMode(int startupMode)
void	setStartupRange(java.lang.String startupRange)
void	setStartupSelection(java.lang.String startupSelection)
void	setTickDensity(float tickDensity)
void	setTimeStyle(int timeStyle)
void	setTodayIndicatorColor(java.awt.Color todayIndicatorColor)
void	setTrackMargin(int trackMargin)
void	setUnit(int unit)
protected void	updateTooltipText()

Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel

getAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, isPropertyDefined, onShutdown, paintChildren, paintOverlayOverChildren, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, translate, updateQuality

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

STARTUP_NONE

public static final int STARTUP_NONE

See Also:

Constant Field Values

STARTUP_AUTO

public static final int STARTUP_AUTO

See Also:

Constant Field Values

fillBackground

protected boolean fillBackground

Constructor Detail

PMIDateRange

public PMIDateRange()

Method Detail

main

public static void main(java.lang.String[] args)

updateTooltipText

protected void updateTooltipText()

localeChanged

public void localeChanged(java.util.Locale newLocale)

Specified by:

localeChanged in interface LocaleListener

Overrides:

localeChanged in class AbstractVisionPanel

initComponents

protected void initComponents()

createIcon

protected javax.swing.Icon createIcon(java.lang.String name)

setEnabled

public void setEnabled(boolean en)

Overrides:

setEnabled in class javax.swing.JComponent

isComponentEnabled

public boolean isComponentEnabled()

Specified by:

isComponentEnabled in interface EnabledEx

setComponentEnabled

public void setComponentEnabled(boolean componentEnabled)

Specified by:

setComponentEnabled in interface EnabledEx

evaluateEnabled

public void evaluateEnabled()

Specified by:

evaluateEnabled in interface EnabledEx

getEndDate

public java.util.Date getEndDate()

setEndDate

public void setEndDate(java.util.Date endDate)

getStartDate

public java.util.Date getStartDate()

setStartDate

public void setStartDate(java.util.Date startDate)

getOuterRangeEndDate

public java.util.Date getOuterRangeEndDate()

setOuterRangeEndDate

public void setOuterRangeEndDate(java.util.Date rangeEndDate)

getOuterRangeStartDate

public java.util.Date getOuterRangeStartDate()

setOuterRangeStartDate

public void setOuterRangeStartDate(java.util.Date rangeStartDate)

setGrossRange

protected void setGrossRange(PMIDateRange.DateRange range)

getGrossRange

protected PMIDateRange.DateRange getGrossRange()

setRange

public void setRange(java.util.Date rangeStartDate,
                     java.util.Date rangeEndDate)

Scripting function to let user change the selected range without running into complications with the order dates are set. Outer range will move (but not expand) if needed. Assumes start/end not null. If start > end, reverses their order.

Since:

7.8.1

setOuterRange

public void setOuterRange(java.util.Date rangeStartDate,
                          java.util.Date rangeEndDate)

Scripting function to let user change the outer range without running into complications with the order dates are set. Selected range will move (but not expand) if needed. Assumes start/end not null If start > end, reverses their order.

Since:

7.8.1

getTickDensity

public float getTickDensity()

setTickDensity

public void setTickDensity(float tickDensity)

getDensityData

public Dataset getDensityData()

setDensityData

public void setDensityData(Dataset densityData)

setHistogram

public void setHistogram(IHistogram histogram)

getTrackMargin

public int getTrackMargin()

setTrackMargin

public void setTrackMargin(int trackMargin)

getEditorBackground

public java.awt.Color getEditorBackground()

setEditorBackground

public void setEditorBackground(java.awt.Color bg)

getTodayIndicatorColor

public java.awt.Color getTodayIndicatorColor()

setTodayIndicatorColor

public void setTodayIndicatorColor(java.awt.Color todayIndicatorColor)

getBoxFill

public java.awt.Color getBoxFill()

setBoxFill

public void setBoxFill(java.awt.Color boxFill)

getSelectionHighlight

public java.awt.Color getSelectionHighlight()

setSelectionHighlight

public void setSelectionHighlight(java.awt.Color selectionHighlight)

getHighDensityColor

public java.awt.Color getHighDensityColor()

setHighDensityColor

public void setHighDensityColor(java.awt.Color color)

getMaxSelectionSize

public java.lang.String getMaxSelectionSize()

setMaxSelectionSize

public void setMaxSelectionSize(java.lang.String maxSelectionSize)

getStartupMode

public int getStartupMode()

setStartupMode

public void setStartupMode(int startupMode)

getDateStyle

public int getDateStyle()

setDateStyle

public void setDateStyle(int dateStyle)

getTimeStyle

public int getTimeStyle()

setTimeStyle

public void setTimeStyle(int timeStyle)

getStartupRange

public java.lang.String getStartupRange()

setStartupRange

public void setStartupRange(java.lang.String startupRange)

getStartupSelection

public java.lang.String getStartupSelection()

setStartupSelection

public void setStartupSelection(java.lang.String startupSelection)

setOpaque

public void setOpaque(boolean isOpaque)

Overrides:

setOpaque in class javax.swing.JComponent

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class javax.swing.JComponent

isFillBackground

public boolean isFillBackground()

setFillBackground

public void setFillBackground(boolean fillBackground)

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class AbstractVisionPanel

initialize

public void initialize()

Specified by:

initialize in interface DesignerInitializable

onStartup

protected void onStartup()

Description copied from class: AbstractVisionPanel

Subclasses should override this to provide startup logic.

Overrides:

onStartup in class AbstractVisionPanel

initializeStartupRange

public void initializeStartupRange()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

This handles the scroll and zoom buttons

Specified by:

actionPerformed in interface java.awt.event.ActionListener

doZoomIn

protected void doZoomIn()

doZoomOut

protected void doZoomOut()

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

This handles the gross unit editor (the text field) changing its date range, as well as the slider changing its selected range

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Overrides:

setBounds in class java.awt.Component

getUnit

public int getUnit()

setUnit

public void setUnit(int unit)

setFont

public void setFont(java.awt.Font font)

Overrides:

setFont in class javax.swing.JComponent

setForeground

public void setForeground(java.awt.Color fg)

Overrides:

setForeground in class javax.swing.JComponent

setEditorForegroundColor

public void setEditorForegroundColor(java.awt.Color color)

getEditorForegroundColor

public java.awt.Color getEditorForegroundColor()