com.miginfocom.beans
Class DateAreaBean

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by com.miginfocom.calendar.datearea.DateAreaContainer
                      extended by com.miginfocom.beans.DateAreaBean
All Implemented Interfaces:
GridLayoutProvider, GridLineSpecProvider, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable, javax.accessibility.Accessible

public class DateAreaBean
extends DateAreaContainer
implements GridLineSpecProvider, GridLayoutProvider

An object that extends DateAreaContainer to provide some easy-to-use bean properties to accomodate for "VB-like" visual programming.

It will cover a big chunk of all use cases but not all. It is possible to use this bean's properties to configure some parts and then use the getDefaultDateArea() to manually configure more advanced properties.

See Also:
Serialized Form

Nested Class Summary
 
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
static int CAT_HDR_ORDER
           
protected static java.awt.Color DEF_GL_COLOR
           
protected static java.awt.Color DEF_LIGHT_GL_COLOR
           
 
Fields inherited from class com.miginfocom.calendar.datearea.DateAreaContainer
BOTTOM_LEFT_CORNER, BOTTOM_RIGHT_CORNER, CORNER_EXPAND_BOTH, CORNER_EXPAND_BOTTOM_OR_RIGHT, CORNER_EXPAND_NONE, CORNER_EXPAND_TOP_OR_LEFT, CORNERS, EAST, EAST_BOTTOM, EAST_FILL, EAST_TOP, NORTH, NORTH_FILL, NORTH_LEFT, NORTH_RIGHT, SIDES, SOUTH, SOUTH_FILL, SOUTH_LEFT, SOUTH_RIGHT, TOP_LEFT_CORNER, TOP_RIGHT_CORNER, WEST, WEST_BOTTOM, WEST_FILL, WEST_TOP
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.print.Printable
NO_SUCH_PAGE, PAGE_EXISTS
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
DateAreaBean()
           
DateAreaBean(DefaultDateArea dateArea)
           
 
Method Summary
 void addActivityDragResizeListener(ActivityDragResizeListener l)
          This call is transmitted to the DefaultDateArea.addActivityDragResizeListener(com.miginfocom.calendar.datearea.ActivityDragResizeListener)
 void addActivityDragResizeListener(ActivityDragResizeListener l, boolean asWeakRef)
          This call is transmitted to the DefaultDateArea.addActivityDragResizeListener(com.miginfocom.calendar.datearea.ActivityDragResizeListener, boolean)
 void addActivityMoveListener(ActivityMoveListener l)
          This call is transmitted to the DefaultDateArea.addActivityMoveListener(com.miginfocom.calendar.datearea.ActivityMoveListener)
 void addActivityMoveListener(ActivityMoveListener l, boolean asWeakRef)
          This call is transmitted to the DefaultDateArea.addActivityMoveListener(com.miginfocom.calendar.datearea.ActivityMoveListener, boolean)
 void addDateChangeListener(DateChangeListener l)
          This call is transmitted to the DefaultDateArea.addDateChangeListener(com.miginfocom.util.dates.DateChangeListener)
 void addDateChangeListener(DateChangeListener l, boolean asWeakRef)
          This call is transmitted to the DefaultDateArea.addDateChangeListener(com.miginfocom.util.dates.DateChangeListener, boolean)
 void addInteractionListener(InteractionListener l)
          This call is transmitted to the DefaultDateArea.addInteractionListener(com.miginfocom.ashape.interaction.InteractionListener)
 void addInteractionListener(InteractionListener l, boolean asWeakRef)
          This call is transmitted to the DefaultDateArea.addInteractionListener(com.miginfocom.ashape.interaction.InteractionListener, boolean)
 void addKeyListener(java.awt.event.KeyListener l)
           
 void addMouseListener(java.awt.event.MouseListener l)
           
 void addMouseMotionListener(java.awt.event.MouseMotionListener l)
           
 void addMouseWheelListener(java.awt.event.MouseWheelListener l)
           
 void addNotify()
           
 GridDimensionLayout createLayout(Grid grid, int dimIx)
          Creates a new GridDimensionLayout.
 GridLineSpecification createSpecification(DateArea dateArea)
          Creates a new GridLineProvider.
 void doLayout()
           
 java.lang.String getActivityDepositoryContext()
          Property: The context used as a key in the ActivityDepository to get the activities that this date area should show.
 ActivityLayout[] getActivityLayouts()
          Returns the currently installed ActivityLayouts.
 java.lang.String getActivityPaintContext()
          Property: The default paint context that will be used to get an AShape to paint with.
 java.awt.Paint getBackgroundPaint()
          Property: The background paint in the date area.
 boolean getBackgroundPaintViewport()
          If the background paint should oly paint the view port.
 boolean getCategoryAutoRevalidate()
          Property: If the categories in the CategoryDepository changes the date area will revalidate itself if there is a category root set.
 CategoryHeaderBean getCategoryHeader()
          Returns the one and only category header bean.
 Category getCategoryRoot()
          Property: The category from the CategoryDepository that will serve as the root for this category header.
 java.lang.Object[] getCategoryRootIDs()
          Property: The category IDs from the CategoryDepository that will serve as the root(s) for this category header.
 boolean getCategoryShowRoot()
          Property: If the root category set with setCategoryRoot(com.miginfocom.calendar.category.Category) should be shown or if its children should be shown in the first level.
 javax.swing.border.Border getDateAreaInnerBorder()
          Property: The inner border around the date area.
 javax.swing.border.Border getDateAreaOuterBorder()
          Property: The outer border around the date area.
 DefaultDateArea getDefaultDateArea()
           
 DemoDataBean getDemoDataBean()
          Property: A reference to a demo data bean that creates demo data for this date area.
 java.awt.Paint getDividerPaint()
          Property: The paint used to draw separator lines between some date ranges, for instance months.
 int getDividerRangeType()
          Property: The type of the divider range (e.g.
 DateHeaderBean getEastDateHeader()
          Returns the date header that is to the right the date area.
 java.awt.Paint getEvenBoundaryPaint()
          Property: The paint used to fill all even (0, 2, 4...) date ranges of the date area.
 int getEvenRangeType()
          Property: The date range type (i.e.
 int getEvenRangeTypeCount()
          Property: How many of getEvenRangeType() that should be bunched up and be called as one.
 GridLineException[] getHorizontalGridLineExceptions()
          Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way.
 java.awt.Paint getHorizontalGridLinePaintEven()
          Property: The paint used to draw the even (0, 2, 4...) horizontal grid lines.
 java.awt.Paint getHorizontalGridLinePaintOdd()
          Property: The paint used to draw the odd (1, 3, 5...) horizontal grid lines.
 boolean getHorizontalGridLineShowFirst()
          Property: If the indicated grid line should be visible or not (default).
 boolean getHorizontalGridLineShowLast()
          Property: If the indicated grid line should be visible or not (default).
 XtdImage getImage()
          Property: The background or foreground image in the date area.
 PlaceRect getImagePlaceRect()
          Property: How the image should be placed relative to the bounds of the date area.
 boolean getImageTiling()
          Property: If the image should be tiled within the bounds.
 AtRefRangeNumber getLabelAlignX()
          Property: The horizontal alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)).
 AtRefRangeNumber getLabelAlignY()
          Property: The vertical alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)).
 int getLabelAntiAlias()
          Property: The anti aliasing hint used when drawing the label.
 java.awt.Paint getLabelBackground()
          Property: The Paint used to draw the background of the label.
 javax.swing.border.Border getLabelBorder()
          Property: The border that is painted around the label.
 int getLabelCellModulo()
          Property: This property make is possible to show every second or third (for instance) cell label instead if the default every one.
 java.lang.String getLabelDateFormat()
          Property: The date format that specifies the text that will be the label.
 java.lang.String getLabelFirstDateFormat()
          Property: Date format for the "first" of something, e.g.
 int getLabelFirstInField()
          Property: If getFirstDateFormat() is != this is the Calendar field that is used to know what's "first".
 java.awt.Font getLabelFont()
          Property: The font used to draw the label.
 java.awt.Color getLabelForeground()
          Property: The paint that is used to draw the label.
 java.awt.Dimension getLabelMinimumCellSize()
          Property: If the cell is smaller than this size, in any dimension, the label will not be drawn.
 java.awt.Paint getLabelNowBackground()
          Property: The Paint used to draw the background of the label for the cell that spans the current time.
 javax.swing.border.Border getLabelNowBorder()
          Property: The border that is painted around the label for the cell that spans the current time.
 java.lang.String getLabelNowDateFormat()
          Property: The date format that specifies the text that will be the label for the cell that spans the current time.
 java.awt.Font getLabelNowFont()
          Property: The font used to draw the label for the cell that spans the current time.
 java.awt.Color getLabelNowForeground()
          Property: The paint that is used to draw the label for the cell that spans the current time.
 PlaceRect getLabelNowPlaceRect()
          Property: Optional correction to the cell rectangle.
 java.lang.Integer getLabelNowRangeType()
          Property: The range type to round the "now" date to.
 java.awt.Color getLabelNowShadowForeground()
          Property: The color that is used to draw the label shadow for the NOW date.
 java.awt.Point getLabelNowShadowOffset()
          Property: The relative Offset that is used to draw the label shadow for the NOW date.
 PlaceRect getLabelPlaceRect()
          Property: Denotes the bounds that the label should get.
 java.awt.Color getLabelShadowForeground()
          Property: The color that is used to draw the label shadow.
 java.awt.Point getLabelShadowOffset()
          Property: The relative offset that is used to draw the label shadow.
 int getLayerForActivities()
          Property: The layer index for the decorator that paints the activities.
 int getLayerForDividers()
          Property: The layer index for the decorator that paints the dividers between some date ranges.
 int getLayerForEvenFieldFill()
          Property: The layer index for the decorator that paints the even date ranges.
 int getLayerForGridLines()
          Property: The layer index for the decorator that paints the grid lines.
 int getLayerForImage()
          Property: The layer index for the decorator that paints a background/foreground image in the date area.
 int getLayerForLabels()
          Property: The layer index for the decorator that paints the labels in the cells.
 int getLayerForMultiSelectRectangle()
          Property: The layer index for the decorator that paints the rubber band selection rectangle.
 int getLayerForOccupied()
          Property: The layer index for the decorator that decorates the parts of the cells that has an activity which date range spans that time.
 int getLayerForOddFill()
          Property: The layer index for the decorator that paints the odd rows and/or columns.
 int getLayerForSelections()
          Property: The layer index for the decorator that paints the mouse over, selected and temporary pressed selections in the grid.
 java.lang.Integer getLayoutOptimizeBoundary()
          Property: When an activity is changed the activites that overlaps it will be layed out again.
 java.lang.String getLicenseKey()
          Returns a text describing is the license key is set or not and if it is correct.
 boolean getMouseOverActivitiesOntop()
          Property: If Activites that have the mouse hovering over them should be painted on top of other activities.
 boolean getNoExpandedFolderGridLine()
          Property: If the grid lines around a folded (collapsed) folder sub row should be merged to one.
 DateHeaderBean getNorthDateHeader()
          Returns the date header that is above the date area.
 java.awt.Paint getOccupiedBackgroundPaint()
          Property: The background paint for the decoration where there's an activity which range overlaps.
 boolean getOccupiedMergeOverlapping()
          Property: If occupied activity ranges that overlap should be combined (merged) before draing the occupied rects.
 java.awt.Paint getOccupiedNotBackgroundPaint()
          Property: The background paint for the decoration where there's an activity which range DOESN'T overlap.
 java.awt.Paint getOccupiedNotOutlinePaint()
          Property: The outline paint for the decoration where there's an activity which range DOESN'T overlap.
 java.awt.Paint getOccupiedOutlinePaint()
          Property: The outline paint for the decoration where there's an activity which range overlap.
 PlaceRect getOccupiedPlaceRect()
          Property: The placing of the rectangle that denoted the occupied/not occupied periods.
 java.lang.Integer getOccupiedRoundToRangeType()
          Property: If occupied ranges should be rounded to a range type (e.g.
 java.awt.Paint getOddColumnPaint()
          Property: The paint to paint for all odd columns.
 java.awt.Paint getOddRowPaint()
          Property: The paint to paint for all odd rows.
 int getPrimaryDimension()
          What dimension time progresses if there was no wrapping.
 int getPrimaryDimensionCellType()
          Returns the type of primDimCellSpanCount.
 int getPrimaryDimensionCellTypeCount()
          Returns how may cells in the primary dimension.
 GridLayoutProvider getPrimaryDimensionLayout()
          Property: The layout provider for the primary dimension for the grid.
 GridLayoutProvider getSecondaryDimensionLayout()
          Property: The layout provider for the secondary dimension for the grid.
 java.awt.Paint getSelectablePaint()
          Property: The paint used to fill the cells that are marked as selectable.
 boolean getSelectedActivitiesOntop()
          Property: If Activites that are selected should be painted on top of other activities.
 int getSelectionBoundaryType()
          Property: The type of date range (e.g.
 java.awt.Paint getSelectionMouseOverPaint()
          Property: The paint used to fill the cells that the mouse is over.
 java.awt.Paint getSelectionMousePressedPaint()
          Property: The paint used to fill the cells that the is pressed over (e.g.
 java.awt.Paint getSelectionPaint()
          Property: The paint used to fill the cells that are selected.
 int getSelectionType()
          Property: The type of selection that can be done on the date area background.
 long getSnapToMillis()
          Return what even millisecond to snap to when resizing and moving activities.
 DateHeaderBean getSouthDateHeader()
          Returns the date header that is below the date area.
 SubRowCreator getSubRowCreator()
          Property: A custom SubRowCreator that can be set to create all sub rows for the date area bean.
 java.awt.Paint getSubRowGridLinePaint()
          Property: The paint used to draw sub row divider grid lines.
 GridLineException[] getVerticalGridLineExceptions()
          Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way.
 java.awt.Paint getVerticalGridLinePaintEven()
          Property: The paint used to draw the even (0, 2, 4...) vertical grid lines.
 java.awt.Paint getVerticalGridLinePaintOdd()
          Property: The paint used to draw the odd (1, 3, 5...) vertical grid lines.
 boolean getVerticalGridLineShowFirst()
          Property: If the indicated grid line should be visible or not (default).
 boolean getVerticalGridLineShowLast()
          Property: If the indicated grid line should be visible or not (default).
 java.lang.String getVisibleDateRangeString()
          Property: A string representing the visual date range of the exact form: "yyyyMMdd'T'HHmmssSSS'-'yyyyMMdd'T'HHmmssSSS" without the ' of course.
 DateHeaderBean getWestDateHeader()
          Returns the date header that is to the left the date area.
 java.lang.Integer getWrapBoundary()
          Returns a which boundary (e.g.
 int getWrapBoundaryCount()
          Returns the number of wrapBoundary before wrapping.
 boolean isActivitiesSupported()
          Property: If activities should be handled by this date area or not.
 boolean isDesignTimeHelp()
          Property: If true draws an information message in "design time".
 boolean isShowNoFitIcon()
          Property: If the little icon that shows that not all activities have fitted within a date range (normally a day).
 void paint(java.awt.Graphics g)
           
 void removeActivityDragResizeListener(ActivityDragResizeListener l)
          This call is transmitted to the DefaultDateArea.removeActivityDragResizeListener(com.miginfocom.calendar.datearea.ActivityDragResizeListener)
 void removeActivityMoveListener(ActivityMoveListener l)
          This call is transmitted to the DefaultDateArea.removeActivityMoveListener(com.miginfocom.calendar.datearea.ActivityMoveListener)
 void removeDateChangeListener(DateChangeListener l)
          This call is transmitted to the DefaultDateArea.removeDateChangeListener(com.miginfocom.util.dates.DateChangeListener)
 void removeInteractionListener(InteractionListener l)
          This call is transmitted to the DefaultDateArea.removeInteractionListener(com.miginfocom.ashape.interaction.InteractionListener).
 void removeKeyListener(java.awt.event.KeyListener l)
           
 void removeMouseListener(java.awt.event.MouseListener l)
           
 void removeMouseMotionListener(java.awt.event.MouseMotionListener l)
           
 void removeMouseWheelListener(java.awt.event.MouseWheelListener l)
           
 void removeNotify()
           
 void revalidateGrid()
          Recreates the grid in the date area
 void setActivitiesSupported(boolean b)
          Property: If activities should be handled by this date area or not.
 void setActivityDepositoryContext(java.lang.String context)
          Property: The context used as a key in the ActivityDepository to get the activities that this date area should show.
 void setActivityLayouts(ActivityLayout[] layouts)
          Sets the ActivityLayouts.
 void setActivityPaintContext(java.lang.String ctx)
          Property: The default paint context that will be used to get an AShape to paint with.
 void setBackgroundPaint(java.awt.Paint p)
          Property: The background paint in the date area.
 void setBackgroundPaintViewport(boolean b)
          If the background paint should oly paint the view port.
 void setCategoryAutoRevalidate(boolean b)
          Property: If the categories in the CategoryDepository changes the date area will revalidate itself if there is a category root set.
 void setCategoryHeader(CategoryHeaderBean header)
          Sets or disables the category header.
 void setCategoryRoot(Category root)
          Property: The category from the CategoryDepository that will serve as the root for this category header.
 void setCategoryRootIDs(java.lang.Object[] rootIDs)
          Property: The category IDs from the CategoryDepository that will serve as the root(s) for this category header.
 void setCategoryShowRoot(boolean b)
          Property: If the root category set with setCategoryRoot(com.miginfocom.calendar.category.Category) should be shown or if its children should be shown in the first level.
 void setDateAreaInnerBorder(javax.swing.border.Border b)
          Property: The inner border around the date area.
 void setDateAreaOuterBorder(javax.swing.border.Border b)
          Property: The outer border around the date area.
 void setDemoDataBean(DemoDataBean b)
          Property: A reference to a demo data bean that creates demo data for this date area.
 void setDesignTimeHelp(boolean b)
          Property: If true draws an information message in "design time".
 void setDividerPaint(java.awt.Paint paint)
          Property: The paint used to draw separator lines between some date ranges, for instance months.
 void setDividerRangeType(int rangeType)
          Property: The type of the divider range (e.g.
 void setEastDateHeader(DateHeaderBean header)
          Sets the date header that will be to the right the date area.
 void setEnabled(boolean b)
           
 void setEvenBoundaryPaint(java.awt.Paint paint)
          Property: The paint used to fill all even (0, 2, 4...) date ranges of the date area.
 void setEvenRangeType(int rangeType)
          Property: The date range type (i.e.
 void setEvenRangeTypeCount(int count)
          Property: How many of getEvenRangeType() that should be bunched up and be called as one.
 void setHorizontalGridLineExceptions(GridLineException[] exceptions)
          Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way.
 void setHorizontalGridLinePaintEven(java.awt.Paint paint)
          Property: The paint used to draw the even (0, 2, 4...) horizontal grid lines.
 void setHorizontalGridLinePaintOdd(java.awt.Paint paint)
          Property: The paint used to draw the odd (1, 3, 5...) horizontal grid lines.
 void setHorizontalGridLineShowFirst(boolean b)
          Property: If the indicated grid line should be visible or not (default).
 void setHorizontalGridLineShowLast(boolean b)
          Property: If the indicated grid line should be visible or not (default).
 void setImage(XtdImage img)
          Property: The background or foreground image in the date area.
 void setImagePlaceRect(PlaceRect r)
          Property: How the image should be placed relative to the bounds of the date area.
 void setImageTiling(boolean b)
          Property: If the image should be tiled within the bounds.
 void setLabelAlignX(AtRefRangeNumber x)
          Property: The horizontal alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)).
 void setLabelAlignY(AtRefRangeNumber y)
          Property: The vertical alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)).
 void setLabelAntiAlias(int hint)
          Property: The anti aliasing hint used when drawing the label.
 void setLabelBackground(java.awt.Paint paint)
          Property: The Paint used to draw the background of the label.
 void setLabelBorder(javax.swing.border.Border b)
          Property: The border that is painted around the label.
 void setLabelCellModulo(int i)
          Property: This property make is possible to show every second or third (for instance) cell label instead if the default every one.
 void setLabelDateFormat(java.lang.String format)
          Property: The date format that specifies the text that will be the label.
 void setLabelFirstDateFormat(java.lang.String format)
          Property: Date format for the "first" of something, e.g.
 void setLabelFirstInField(int calField)
          Property: If getFirstDateFormat() is != this is the Calendar field that is used to know what's "first".
 void setLabelFont(java.awt.Font font)
          Property: The font used to draw the label.
 void setLabelForeground(java.awt.Color c)
          Property: The paint that is used to draw the label.
 void setLabelMinimumCellSize(java.awt.Dimension size)
          Property: If the cell is smaller than this size, in any dimension, the label will not be drawn.
 void setLabelNowBackground(java.awt.Paint paint)
          Property: The Paint used to draw the background of the label for the cell that spans the current time.
 void setLabelNowBorder(javax.swing.border.Border b)
          Property: The border that is painted around the label for the cell that spans the current time.
 void setLabelNowDateFormat(java.lang.String format)
          Property: The date format that specifies the text that will be the label for the cell that spans the current time.
 void setLabelNowFont(java.awt.Font font)
          Property: The font used to draw the label for the cell that spans the current time.
 void setLabelNowForeground(java.awt.Color c)
          Property: The paint that is used to draw the label for the cell that spans the current time.
 void setLabelNowPlaceRect(PlaceRect c)
          Property: Optional correction to the cell rectangle.
 void setLabelNowRangeType(java.lang.Integer rangeType)
          Property: The range type to round the "now" date to.
 void setLabelNowShadowForeground(java.awt.Color c)
          Property: The color that is used to draw the label shadow for the NOW date.
 void setLabelNowShadowOffset(java.awt.Point p)
          Property: The relative Offset that is used to draw the label shadow for the NOW date.
 void setLabelPlaceRect(PlaceRect placeRect)
          Property: Denotes the bounds that the label should get.
 void setLabelShadowForeground(java.awt.Color c)
          Property: The color that is used to draw the label shadow.
 void setLabelShadowOffset(java.awt.Point p)
          Property: The relative offset that is used to draw the label shadow.
 void setLayerForActivities(int i)
          Property: The layer index for the decorator that paints the activities.
 void setLayerForDividers(int i)
          Property: The layer index for the decorator that paints the dividers between some date ranges.
 void setLayerForEvenFieldFill(int i)
          Property: The layer index for the decorator that paints the even date ranges.
 void setLayerForGridLines(int i)
          Property: The layer index for the decorator that paints the grid lines.
 void setLayerForImage(int i)
          Property: The layer index for the decorator that paints a background/foreground image in the date area.
 void setLayerForLabels(int i)
          Property: The layer index for the decorator that paints the labels in the cells.
 void setLayerForMultiSelectRectangle(int i)
          Property: The layer index for the decorator that paints the rubber band selection rectangle.
 void setLayerForOccupied(int i)
          Property: The layer index for the decorator that decorates the parts of the cells that has an activity which date range spans that time.
 void setLayerForOddFill(int i)
          Property: The layer index for the decorator that paints the odd rows and/or columns.
 void setLayerForSelections(int i)
          Property: The layer index for the decorator that paints the mouse over, selected and temporary pressed selections in the grid.
 void setLayoutOptimizeBoundary(java.lang.Integer boundary)
          Property: When an activity is changed the activites that overlaps it will be layed out again.
 void setLicenseKey(java.lang.String key)
          Sets the license key.
 void setMouseOverActivitiesOntop(boolean b)
          Property: If Activites that have the mouse hovering over them should be painted on top of other activities.
 void setNoExpandedFolderGridLine(boolean b)
          Property: If the grid lines around a folded (collapsed) folder sub row should be merged to one.
 void setNorthDateHeader(DateHeaderBean header)
          Sets the date header that will be above the date area.
 void setOccupiedBackgroundPaint(java.awt.Paint p)
          Property: The background paint for the decoration where there's an activity which range overlap.
 void setOccupiedMergeOverlapping(boolean b)
          Property: If occupied activity ranges that overlap should be combined (merged) before draing the occupied rects.
 void setOccupiedNotBackgroundPaint(java.awt.Paint p)
          Property: The background paint for the decoration where there's an activity which range DOESN'T overlap.
 void setOccupiedNotOutlinePaint(java.awt.Paint p)
          Property: The outline paint for the decoration where there's an activity which range DOESN'T overlap.
 void setOccupiedOutlinePaint(java.awt.Paint p)
          Property: The outline paint for the decoration where there's an activity which range overlap.
 void setOccupiedPlaceRect(PlaceRect r)
          Property: The placing of the rectangle that denoted the occupied/not occupied periods.
 void setOccupiedRoundToRangeType(java.lang.Integer rangeType)
          Property: If occupied activity ranges that overlap should be combined (merged) before draing the occupied rects.
 void setOddColumnPaint(java.awt.Paint paint)
          Property: The paint to paint for all odd columns.
 void setOddRowPaint(java.awt.Paint paint)
          Property: The paint to paint for all odd rows.
 void setPrimaryDimension(int dim)
          Sets the dimension time progresses if there was no wrapping.
 void setPrimaryDimensionCellType(int cellType)
          Sets the type of primDimCellSpanCount.
 void setPrimaryDimensionCellTypeCount(int count)
          Sets how many primDimCellSpanType a cell spanns in the primary dimension.
 void setPrimaryDimensionLayout(GridLayoutProvider layout)
          Property: The layout provider for the primary dimension for the grid.
 void setSecondaryDimensionLayout(GridLayoutProvider layout)
          Property: The layout provider for the secondary dimension for the grid.
 void setSelectablePaint(java.awt.Paint paint)
          Property: The paint used to fill the cells that are marked as selectable.
 void setSelectedActivitiesOntop(boolean b)
          Property: If Activites that are selected should be painted on top of other activities.
 void setSelectionBoundaryType(int rangeType)
          Property: The type of date range (e.g.
 void setSelectionMouseOverPaint(java.awt.Paint paint)
          Property: The paint used to fill the cells that the mouse is over.
 void setSelectionMousePressedPaint(java.awt.Paint paint)
          Property: The paint used to fill the cells that the is pressed over (e.g.
 void setSelectionPaint(java.awt.Paint paint)
          Property: The paint used to fill the cells that are selected.
 void setSelectionType(int type)
          Property: The type of selection that can be done on the date area background.
 void setShowNoFitIcon(boolean b)
          Property: If the little icon that shows that not all activities have fitted within a date range (normally a day).
 void setSnapToMillis(long millis)
          Sets what even millisecond to snap to when resizing and moving activities.
 void setSouthDateHeader(DateHeaderBean header)
          Sets the date header that will be below the date area.
 void setSubRowCreator(SubRowCreator creator)
          Property: A custom SubRowCreator that can be set to create all sub rows for the date area bean.
 void setSubRowGridLinePaint(java.awt.Paint paint)
          Property: The paint used to draw sub row divider grid lines.
 void setVerticalGridLineExceptions(GridLineException[] exceptions)
          Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way.
 void setVerticalGridLinePaintEven(java.awt.Paint paint)
          Property: The paint used to draw the even (0, 2, 4...) vertical grid lines.
 void setVerticalGridLinePaintOdd(java.awt.Paint paint)
          Property: The paint used to draw the odd (1, 3, 5...) vertical grid lines.
 void setVerticalGridLineShowFirst(boolean b)
          Property: If the indicated grid line should be visible or not (default).
 void setVerticalGridLineShowLast(boolean b)
          Property: If the indicated grid line should be visible or not (default).
 void setVisibleDateRangeString(java.lang.String dateStrings)
          Property: A string representing the visual date range of the exact form: "yyyyMMdd'T'HHmmssSSS'-'yyyyMMdd'T'HHmmssSSS" without the ' of course.
 void setWestDateHeader(DateHeaderBean header)
          Sets the date header that will be to the left the date area.
 void setWrapBoundary(java.lang.Integer wrap)
          Set which boundary (e.g.
 void setWrapBoundaryCount(int count)
          Sets the number of wrapBoundary before wrapping.
 void validateHeaders()
           
 
Methods inherited from class com.miginfocom.calendar.datearea.DateAreaContainer
addComponent, addComponent, getDateArea, getDateAreaScrollPane, getHeader, getHeader, getHeaders, getHorizontalScrollBarPolicy, getPrintablePageBounds, getPrintablePageBounds, getPrintablePreferredSize, getPrintSpecification, getVerticalScrollBarPolicy, getViewportViewDateRange, isEastOfDateArea, isSouthOfDateArea, moveHeader, print, print, print, scrollToShowRange, setBackground, setHeader, setHeader, setHorizontalScrollBarPolicy, setLayout, setPrintSpecification, setScrollBarsVisibility, setVerticalScrollBarPolicy
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, 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, hide, 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, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEF_GL_COLOR

protected static final java.awt.Color DEF_GL_COLOR

DEF_LIGHT_GL_COLOR

protected static final java.awt.Color DEF_LIGHT_GL_COLOR

CAT_HDR_ORDER

public static final int CAT_HDR_ORDER
See Also:
Constant Field Values
Constructor Detail

DateAreaBean

public DateAreaBean()

DateAreaBean

public DateAreaBean(DefaultDateArea dateArea)
Method Detail

addNotify

public void addNotify()
Overrides:
addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()
Overrides:
removeNotify in class javax.swing.JComponent

createLayout

public GridDimensionLayout createLayout(Grid grid,
                                        int dimIx)
Description copied from interface: GridLayoutProvider
Creates a new GridDimensionLayout.

Specified by:
createLayout in interface GridLayoutProvider
Parameters:
grid - The grid used to get information.
dimIx - The dimension. Either Grid.PRIMARY_DIMENSION or Grid.SECONDARY_DIMENSION
Returns:
The layout that will be used to layout a Grid.

getDefaultDateArea

public DefaultDateArea getDefaultDateArea()
Returns:
The DefaultDateArea.

createSpecification

public GridLineSpecification createSpecification(DateArea dateArea)
Description copied from interface: GridLineSpecProvider
Creates a new GridLineProvider.

Specified by:
createSpecification in interface GridLineSpecProvider
Parameters:
dateArea - The date area to get information from.
Returns:
The spec that hold the grid lines to be used for creating a Grid.

paint

public void paint(java.awt.Graphics g)
Overrides:
paint in class javax.swing.JComponent

doLayout

public void doLayout()
Overrides:
doLayout in class java.awt.Container

revalidateGrid

public void revalidateGrid()
Recreates the grid in the date area


setEnabled

public void setEnabled(boolean b)
Overrides:
setEnabled in class javax.swing.JComponent

isDesignTimeHelp

public boolean isDesignTimeHelp()
Property: If true draws an information message in "design time".

Returns:
The current value. true is default.

setDesignTimeHelp

public void setDesignTimeHelp(boolean b)
Property: If true draws an information message in "design time".

Parameters:
b - The new value. true is default.

setLicenseKey

public void setLicenseKey(java.lang.String key)
Sets the license key. An exception will be thrown if

Parameters:
key - The license key.

getLicenseKey

public java.lang.String getLicenseKey()
Returns a text describing is the license key is set or not and if it is correct.

Returns:
A text describing is the license key is set or not and if it is correct. Never null.

getVisibleDateRangeString

public java.lang.String getVisibleDateRangeString()
Property: A string representing the visual date range of the exact form: "yyyyMMdd'T'HHmmssSSS'-'yyyyMMdd'T'HHmmssSSS" without the ' of course. Example: 20061030T164500000

Note that the dates will be rounded to even up to the cells defined by primaryDimensionCellType and primaryDimensionCellTypeCount as well as wrapType.

Note that this is a convenience that should only be used for tests since there is no time zone or locale information.

If there is a format error the property set will be silently ignored.

Returns:
The current visual date range. Not null.
See Also:
DefaultDateArea.setVisibleDateRange(com.miginfocom.util.dates.DateRangeI)

setVisibleDateRangeString

public void setVisibleDateRangeString(java.lang.String dateStrings)
Property: A string representing the visual date range of the exact form: "yyyyMMdd'T'HHmmssSSS'-'yyyyMMdd'T'HHmmssSSS" without the ' of course. Example: 20061030T164500000

Note that this is a convenience that should only be used for tests since there is no time zone or locale information.

If there is a format error the property set will be silently ignored.

This property should be set after the structure if the date area (grid) is set with the properties that start with primaryXXX

Parameters:
dateStrings - The new visual date range. Not null.
See Also:
DefaultDateArea.getVisibleDateRange(), DefaultDateArea.getVisibleDateRangeCorrected()

getCategoryRoot

public Category getCategoryRoot()
Property: The category from the CategoryDepository that will serve as the root for this category header. Note that this category can either be shown itself or just serve as the invisible root to show its children as a multi root. This can be change with setCategoryShowRoot(boolean).

NOTE! Not used if setSubRowCreator(com.miginfocom.calendar.grid.SubRowCreator) is != null!

Returns:
The current root category. May be null which means that categories is generally disabled for this bean.

setCategoryRoot

public void setCategoryRoot(Category root)
Property: The category from the CategoryDepository that will serve as the root for this category header. Note that this category can either be shown itself or just serve as the invisible root to show its children as a multi root. This can be change with setCategoryShowRoot(boolean).

The bean DemoDataBean is a Category so if one of those is created to construct demo data it can be set here as the root.

NOTE! Not used if setSubRowCreator(com.miginfocom.calendar.grid.SubRowCreator) is != null!

Parameters:
root - The new root category. May be null which means that categories is generally disabled for this bean.

getCategoryRootIDs

public java.lang.Object[] getCategoryRootIDs()
Property: The category IDs from the CategoryDepository that will serve as the root(s) for this category header. Note that this category(s) can either be shown itself or just serve as the invisible root(s) to show its children as a multi root. This can be change with setCategoryShowRoot(boolean).

The bean DemoDataBean is a Category so if one of those is created to construct demo data it can be set here as the root.

NOTE! Not used if setSubRowCreator(com.miginfocom.calendar.grid.SubRowCreator) is != null!

Returns:
The current root category. May be null which means that categories is generally disabled for this bean.

setCategoryRootIDs

public void setCategoryRootIDs(java.lang.Object[] rootIDs)
Property: The category IDs from the CategoryDepository that will serve as the root(s) for this category header. Note that this category(s) can either be shown itself or just serve as the invisible root(s) to show its children as a multi root. This can be change with setCategoryShowRoot(boolean).

The bean DemoDataBean is a Category so if one of those is created to construct demo data it can be set here as the root.

NOTE! Not used if setSubRowCreator(com.miginfocom.calendar.grid.SubRowCreator) is != null!

Parameters:
rootIDs - The new category root ID(s). May be null which means that categories is generally disabled for this bean.

getCategoryAutoRevalidate

public boolean getCategoryAutoRevalidate()
Property: If the categories in the CategoryDepository changes the date area will revalidate itself if there is a category root set.

Returns:
If the auto revalidation is on.

setCategoryAutoRevalidate

public void setCategoryAutoRevalidate(boolean b)
Property: If the categories in the CategoryDepository changes the date area will revalidate itself if there is a category root set.

Parameters:
b - If the auto revalidation is on.

getSubRowCreator

public SubRowCreator getSubRowCreator()
Property: A custom SubRowCreator that can be set to create all sub rows for the date area bean. Note that if this is set then the categoryRoot, categoryRoots and categoryShowRoot properties will not be used since they are only used for the default sub row creator (which is a CategorySubRowCreator). The default value for this property is null and then the two properties mentioned above will be used to create the sub rows.

Returns:
The current creator. Default is null.
See Also:
setCategoryRoot(com.miginfocom.calendar.category.Category), setCategoryShowRoot(boolean)

setSubRowCreator

public void setSubRowCreator(SubRowCreator creator)
Property: A custom SubRowCreator that can be set to create all sub rows for the date area bean. Note that if this is set then the categoryRoot, categoryRoots and categoryShowRoot properties will not be used since they are only used for the default sub row creator (which is a CategorySubRowCreator). The default value for this property is null and then the two properties mentioned above will be used to create the sub rows.

Parameters:
creator - The new creator. Default is null.
See Also:
setCategoryRoot(com.miginfocom.calendar.category.Category), setCategoryShowRoot(boolean)

getCategoryShowRoot

public boolean getCategoryShowRoot()
Property: If the root category set with setCategoryRoot(com.miginfocom.calendar.category.Category) should be shown or if its children should be shown in the first level.

NOTE! Not used if setSubRowCreator(com.miginfocom.calendar.grid.SubRowCreator) is != null!

Returns:
If the root category should be show as the sole root.

setCategoryShowRoot

public void setCategoryShowRoot(boolean b)
Property: If the root category set with setCategoryRoot(com.miginfocom.calendar.category.Category) should be shown or if its children should be shown in the first level.

NOTE! Not used if setSubRowCreator(com.miginfocom.calendar.grid.SubRowCreator) is != null!

Parameters:
b - If the root category should be show as the sole root.

getLayerForActivities

public int getLayerForActivities()
Property: The layer index for the decorator that paints the activities.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
DefaultDateArea.ActivityViewDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForActivities

public void setLayerForActivities(int i)
Property: The layer index for the decorator that paints the activities.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
DefaultDateArea.ActivityViewDecorator

getLayerForMultiSelectRectangle

public int getLayerForMultiSelectRectangle()
Property: The layer index for the decorator that paints the rubber band selection rectangle.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
DefaultDateArea.ActivityViewDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForMultiSelectRectangle

public void setLayerForMultiSelectRectangle(int i)
Property: The layer index for the decorator that paints the rubber band selection rectangle.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
DefaultDateArea.ActivityViewDecorator

getLayerForGridLines

public int getLayerForGridLines()
Property: The layer index for the decorator that paints the grid lines.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
GridLineDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForGridLines

public void setLayerForGridLines(int i)
Property: The layer index for the decorator that paints the grid lines.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
GridLineDecorator

getLayerForDividers

public int getLayerForDividers()
Property: The layer index for the decorator that paints the dividers between some date ranges. For example a darker line between months.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
DateSeparatorDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForDividers

public void setLayerForDividers(int i)
Property: The layer index for the decorator that paints the dividers between some date ranges. For example a darker line between months.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
DateSeparatorDecorator

getLayerForSelections

public int getLayerForSelections()
Property: The layer index for the decorator that paints the mouse over, selected and temporary pressed selections in the grid. It has nothing to do with selection of activities, but all to do with selection of cells in the date grid.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
SelectionGridDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForSelections

public void setLayerForSelections(int i)
Property: The layer index for the decorator that paints the mouse over, selected and temporary pressed selections in the grid. It has nothing to do with selection of activities, but all to do with selection of cells in the date grid.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
SelectionGridDecorator

getLayerForLabels

public int getLayerForLabels()
Property: The layer index for the decorator that paints the labels in the cells. For instance the day number or time.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
CellLabelDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForLabels

public void setLayerForLabels(int i)
Property: The layer index for the decorator that paints the labels in the cells. For instance the day number or time.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
CellLabelDecorator

getLayerForEvenFieldFill

public int getLayerForEvenFieldFill()
Property: The layer index for the decorator that paints the even date ranges. It can for instance be used to draw every other month in a darker color.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
EvenFieldFillDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForEvenFieldFill

public void setLayerForEvenFieldFill(int i)
Property: The layer index for the decorator that paints the even date ranges. It can for instance be used to draw every other month in a darker color.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
EvenFieldFillDecorator

getLayerForOccupied

public int getLayerForOccupied()
Property: The layer index for the decorator that decorates the parts of the cells that has an activity which date range spans that time. For instance Microsoft's Outlook has this in it's day(s) view. It paints blue on the left side of those cells. This decoration is quite flexible and can paint the background for the whole cells or just parts of it.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
OccupiedDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForOccupied

public void setLayerForOccupied(int i)
Property: The layer index for the decorator that decorates the parts of the cells that has an activity which date range spans that time. For instance Microsoft's Outlook has this in it's day(s) view. It paints blue on the left side of those cells. This decoration is quite flexible and can paint the background for the whole cells or just parts of it.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
OccupiedDecorator

getLayerForImage

public int getLayerForImage()
Property: The layer index for the decorator that paints a background/foreground image in the date area.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
ImageDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForImage

public void setLayerForImage(int i)
Property: The layer index for the decorator that paints a background/foreground image in the date area.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
ImageDecorator

getLayerForOddFill

public int getLayerForOddFill()
Property: The layer index for the decorator that paints the odd rows and/or columns. It can for instance be used to draw every other row in a darker color.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Returns:
The current index.
See Also:
OddRowFillDecorator, DefaultDateArea.addDecorator(com.miginfocom.calendar.decorators.Decorator)

setLayerForOddFill

public void setLayerForOddFill(int i)
Property: The layer index for the decorator that paints the odd rows and/or columns. It can for instance be used to draw every other row in a darker color.

This property affect the order in which the different layers are painted, and thus what gets painted on top of what. Lower layer indexes will be painted first and will end up below layers with higher index. Everything that is painted in a date area is painted in layers, and the layers are implemented with Decorators.

Parameters:
i - The new layer for the decorator.
See Also:
OddRowFillDecorator

getDemoDataBean

public DemoDataBean getDemoDataBean()
Property: A reference to a demo data bean that creates demo data for this date area. This is normally only used for testing purposes and should not be used in any production environment.

Returns:
The current value of the property or null.

setDemoDataBean

public void setDemoDataBean(DemoDataBean b)
Property: A reference to a demo data bean that creates demo data for this date area. This is normally only used for testing purposes and should not be used in any production environment.

Parameters:
b - The new value for the property. May be null.

getImage

public XtdImage getImage()
Property: The background or foreground image in the date area. Note that XtdImage is very flexible and can be created in may ways, including from an enbedded BASE64 string.

This is a property that affects an optional background or foreground image in the date area.

Returns:
The current value of the property.
See Also:
ImageDecorator

setImage

public void setImage(XtdImage img)
Property: The background or foreground image in the date area. Note that XtdImage is very flexible and can be created in may ways, including from an enbedded BASE64 string.

This is a property that affects an optional background or foreground image in the date area.

Parameters:
img - The new value for the property. May be null.
See Also:
ImageDecorator

getImagePlaceRect

public PlaceRect getImagePlaceRect()
Property: How the image should be placed relative to the bounds of the date area. Note that the placing is very flexible through the use of the rectangle transformation interface PlaceRect.

This is a property that affects an optional background or foreground image in the date area.

Returns:
The current value of the property.
See Also:
ImageDecorator, AbsRect, AlignRect, AspectRatioRect

setImagePlaceRect

public void setImagePlaceRect(PlaceRect r)
Property: How the image should be placed relative to the bounds of the date area. Note that the placing is very flexible through the use of the rectangle transformation interface PlaceRect.

This is a property that affects an optional background or foreground image in the date area.

Parameters:
r - The new value for the property. May be null.
See Also:
ImageDecorator, AbsRect, AlignRect, AspectRatioRect

getImageTiling

public boolean getImageTiling()
Property: If the image should be tiled within the bounds. It is stretched/shrinked otherwise, depending on the rectangle returned bu the placeRect.

This is a property that affects an optional background or foreground image in the date area.

Returns:
The current value of the property.
See Also:
ImageDecorator

setImageTiling

public void setImageTiling(boolean b)
Property: If the image should be tiled within the bounds. It is stretched/shrinked otherwise, depending on the rectangle returned bu the placeRect.

This is a property that affects an optional background or foreground image in the date area.

Parameters:
b - The new value for the property.
See Also:
ImageDecorator

getOccupiedBackgroundPaint

public java.awt.Paint getOccupiedBackgroundPaint()
Property: The background paint for the decoration where there's an activity which range overlaps.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property.
See Also:
OccupiedDecorator

setOccupiedBackgroundPaint

public void setOccupiedBackgroundPaint(java.awt.Paint p)
Property: The background paint for the decoration where there's an activity which range overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
p - The new value for the property.
See Also:
OccupiedDecorator

getOccupiedOutlinePaint

public java.awt.Paint getOccupiedOutlinePaint()
Property: The outline paint for the decoration where there's an activity which range overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property.
See Also:
OccupiedDecorator

setOccupiedOutlinePaint

public void setOccupiedOutlinePaint(java.awt.Paint p)
Property: The outline paint for the decoration where there's an activity which range overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
p - The new value for the property.
See Also:
OccupiedDecorator

getOccupiedNotBackgroundPaint

public java.awt.Paint getOccupiedNotBackgroundPaint()
Property: The background paint for the decoration where there's an activity which range DOESN'T overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property.
See Also:
OccupiedDecorator

setOccupiedNotBackgroundPaint

public void setOccupiedNotBackgroundPaint(java.awt.Paint p)
Property: The background paint for the decoration where there's an activity which range DOESN'T overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
p - The new value for the property.
See Also:
OccupiedDecorator

getOccupiedNotOutlinePaint

public java.awt.Paint getOccupiedNotOutlinePaint()
Property: The outline paint for the decoration where there's an activity which range DOESN'T overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property.
See Also:
OccupiedDecorator

setOccupiedNotOutlinePaint

public void setOccupiedNotOutlinePaint(java.awt.Paint p)
Property: The outline paint for the decoration where there's an activity which range DOESN'T overlap.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
p - The new value for the property.
See Also:
OccupiedDecorator

getOccupiedPlaceRect

public PlaceRect getOccupiedPlaceRect()
Property: The placing of the rectangle that denoted the occupied/not occupied periods. The reference rectangle is normally the size of the activity range in the primary dimension and the whole cell in the secondary dimension.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property.
See Also:
OccupiedDecorator

setOccupiedPlaceRect

public void setOccupiedPlaceRect(PlaceRect r)
Property: The placing of the rectangle that denoted the occupied/not occupied periods. The reference rectangle is normally the size of the activity range in the primary dimension and the whole cell in the secondary dimension.

E.g:

new AbsRect(SwingConstants.BOTTOM, new Integer(10)) or
new AbsRect(SwingConstants.LEFT, new Integer(10))

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
r - The new value for the property.
See Also:
OccupiedDecorator

getOccupiedMergeOverlapping

public boolean getOccupiedMergeOverlapping()
Property: If occupied activity ranges that overlap should be combined (merged) before draing the occupied rects.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property.
See Also:
OccupiedDecorator

setOccupiedMergeOverlapping

public void setOccupiedMergeOverlapping(boolean b)
Property: If occupied activity ranges that overlap should be combined (merged) before draing the occupied rects.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
b - The new value for the property.
See Also:
OccupiedDecorator

getOccupiedRoundToRangeType

public java.lang.Integer getOccupiedRoundToRangeType()
Property: If occupied ranges should be rounded to a range type (e.g. a day or hour). This is for showing (for instance) that a day is "occupied" even if just a part of it is.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Returns:
The current value of the property. E.g. DateRangeI.RANGE_TYPE_DAY. May be null.
See Also:
OccupiedDecorator

setOccupiedRoundToRangeType

public void setOccupiedRoundToRangeType(java.lang.Integer rangeType)
Property: If occupied activity ranges that overlap should be combined (merged) before draing the occupied rects.

This is a property that affects the visual representation of the occupied decorator. It can be used to paint different backgrounds/outlines for parts is the date area that has a activity overlapping and not. For instance the blue left side in Microoft Outlook's day views can easily be simulated with this.

Parameters:
rangeType - The new value for the property. If null there will be no rounding (default).
See Also:
OccupiedDecorator

getActivityPaintContext

public java.lang.String getActivityPaintContext()
Property: The default paint context that will be used to get an AShape to paint with. This is the default context to use (null is default) if it is not set on the activity directly with AbstractActivity.setPaintContext(String).

It can for instance be used to "connect" this bean's visual appearence to that of a ActivityAShapeBean's paintContext.

Returns:
The current value of the property.
Since:
6.0
See Also:
AShapeRenderer.getDefaultPaintContext(), ActivityAShapeBean.getPaintContext()

setActivityPaintContext

public void setActivityPaintContext(java.lang.String ctx)
Property: The default paint context that will be used to get an AShape to paint with. This is the default context to use (null is default) if it is not set on the activity directly with AbstractActivity.setPaintContext(String).

It can for instance be used to "connect" this bean's visual appearence to that of a ActivityAShapeBean's paintContext.

Parameters:
ctx - The new value for the property. May be null.
Since:
6.0
See Also:
AShapeRenderer.setDefaultPaintContext(String), ActivityAShapeBean.setPaintContext(String)

getPrimaryDimensionLayout

public GridLayoutProvider getPrimaryDimensionLayout()
Property: The layout provider for the primary dimension for the grid. The primary dimension is the one (vertical or horizontal) that would be the only one if there was no wrapping. For instance normal text has horizontal as primary dimension.

Note that normally a GridLayoutProvider can privide for both dimensions, however to be able to set different types of layouts in a visual environment this one will only be used to provide a layout for one dimension. This class (DateAreaBean) is itself a GridLayoutProvider and will relay the request to this provider, if set, but only for one dimension.

Returns:
The layout provider for the primary dimension.

setPrimaryDimensionLayout

public void setPrimaryDimensionLayout(GridLayoutProvider layout)
Property: The layout provider for the primary dimension for the grid. The primary dimension is the one (vertical or horizontal) that would be the only one if there was no wrapping. For instance normal text has horizontal as primary dimension.

Note that normally a GridLayoutProvider can privide for both dimensions, however to be able to set different types of layouts in a visual environment this one will only be used to provide a layout for one dimension. This class (DateAreaBean) is itself a GridLayoutProvider and will relay the request to this provider, if set, but only for one dimension.

Parameters:
layout -

getSecondaryDimensionLayout

public GridLayoutProvider getSecondaryDimensionLayout()
Property: The layout provider for the secondary dimension for the grid. The secondary dimension is the one (vertical or horizontal) that increases when there is a wrap. For instance normal text has vertical as secondary dimension.

Note that normally a GridLayoutProvider can privide for both dimensions, however to be able to set different types of layouts in a visual environment this one will only be used to provide a layout for one dimension. This class (DateAreaBean) is itself a GridLayoutProvider and will relay the request to this provider, if set, but only for one dimension.

Returns:
The layout provider for the primary dimension.

setSecondaryDimensionLayout

public void setSecondaryDimensionLayout(GridLayoutProvider layout)
Property: The layout provider for the secondary dimension for the grid. The secondary dimension is the one (vertical or horizontal) that increases when there is a wrap. For instance normal text has vertical as secondary dimension.

Note that normally a GridLayoutProvider can privide for both dimensions, however to be able to set different types of layouts in a visual environment this one will only be used to provide a layout for one dimension. This class (DateAreaBean) is itself a GridLayoutProvider and will relay the request to this provider, if set, but only for one dimension.

Parameters:
layout - The layout provider for the secondary dimension.

getWrapBoundary

public java.lang.Integer getWrapBoundary()
Returns a which boundary (e.g. week, day) that the grid should wrap. E.g DateRangeI.RANGE_TYPE_WEEK.

Returns:
Which boundary (e.g. week, day) that the grid should wrap. Default is DateRangeI.RANGE_TYPE_WEEK.

setWrapBoundary

public void setWrapBoundary(java.lang.Integer wrap)
Set which boundary (e.g. week, day) that the grid should wrap. E.g DateRangeI.RANGE_TYPE_WEEK.

Parameters:
wrap - Which boundary (e.g. week, day) that the grid should wrap. Default is DateRangeI.RANGE_TYPE_WEEK.

getWrapBoundaryCount

public int getWrapBoundaryCount()
Returns the number of wrapBoundary before wrapping.

Returns:
The count. Default is 1.If < 1 then 1 will be set silently.

setWrapBoundaryCount

public void setWrapBoundaryCount(int count)
Sets the number of wrapBoundary before wrapping.

Parameters:
count - The count. Default is 1.If < 1 then 1 will be set silently.

getPrimaryDimensionCellTypeCount

public int getPrimaryDimensionCellTypeCount()
Returns how may cells in the primary dimension. Unly used if wrapBoundary is set.

Returns:
How may cells in the primary dimension. Unly used if wrapBoundary is set.

setPrimaryDimensionCellTypeCount

public void setPrimaryDimensionCellTypeCount(int count)
Sets how many primDimCellSpanType a cell spanns in the primary dimension. E.g. 30 (if primDimCellSpanType is minutes).

Parameters:
count - how many primDimCellSpanType a cell spanns in the primary dimension.

getPrimaryDimensionCellType

public int getPrimaryDimensionCellType()
Returns the type of primDimCellSpanCount. E.g DateRangeI.RANGE_TYPE_MINUTE

Returns:
The type of primDimCellSpanCount. E.g DateRangeI.RANGE_TYPE_MINUTE

setPrimaryDimensionCellType

public void setPrimaryDimensionCellType(int cellType)
Sets the type of primDimCellSpanCount. E.g DateRangeI.RANGE_TYPE_MINUTE

Parameters:
cellType - The type of primDimCellSpanCount. E.g DateRangeI.RANGE_TYPE_MINUTE

getPrimaryDimension

public int getPrimaryDimension()
What dimension time progresses if there was no wrapping. SwingConstants.HORIZONTAL or SwingConstants.VERTICAL.

Returns:
What dimension time progresses if there was no wrapping.

setPrimaryDimension

public void setPrimaryDimension(int dim)
Sets the dimension time progresses if there was no wrapping. SwingConstants.HORIZONTAL or SwingConstants.VERTICAL.

Parameters:
dim - What dimension time progresses if there was no wrapping.

getActivityLayouts

public ActivityLayout[] getActivityLayouts()
Returns the currently installed ActivityLayouts.

Returns:
The currently installed ActivityLayouts.
See Also:
DefaultDateArea.addActivityLayout(com.miginfocom.calendar.layout.ActivityLayout)

setActivityLayouts

public void setActivityLayouts(ActivityLayout[] layouts)
Sets the ActivityLayouts.

Parameters:
layouts - The new ActivityLayouts.
See Also:
DefaultDateArea.addActivityLayout(com.miginfocom.calendar.layout.ActivityLayout)

getSnapToMillis

public long getSnapToMillis()
Return what even millisecond to snap to when resizing and moving activities.

Returns:
The millisecond to snap to in milliseconds or 0 if snap is disabled.

setSnapToMillis

public void setSnapToMillis(long millis)
Sets what even millisecond to snap to when resizing and moving activities.

Parameters:
millis - The millisecond to snap to in milliseconds. 0 disables snap.

getCategoryHeader

public CategoryHeaderBean getCategoryHeader()
Returns the one and only category header bean. It will always be above or to the left of the date area and always on the left side if the primary dimension is horizontal and above if primary dimension is vertical.

Returns:
The one and only category header bean or null if none is set.

setCategoryHeader

public void setCategoryHeader(CategoryHeaderBean header)
Sets or disables the category header.

Parameters:
header - the new header or null if it should not be used (i.e. removed).
See Also:
getCategoryHeader()

getNorthDateHeader

public DateHeaderBean getNorthDateHeader()
Returns the date header that is above the date area.

Returns:
The date header that is above the date area or null if none.

setNorthDateHeader

public void setNorthDateHeader(DateHeaderBean header)
Sets the date header that will be above the date area.

Parameters:
header - The date header that will be above the date area or null if none.

getWestDateHeader

public DateHeaderBean getWestDateHeader()
Returns the date header that is to the left the date area.

Returns:
The date header that is to the left the date area or null if none.

setWestDateHeader

public void setWestDateHeader(DateHeaderBean header)
Sets the date header that will be to the left the date area.

Parameters:
header - The date header that will be to the left the date area or null if none.

getSouthDateHeader

public DateHeaderBean getSouthDateHeader()
Returns the date header that is below the date area.

Returns:
The date header that is below the date area or null if none.

setSouthDateHeader

public void setSouthDateHeader(DateHeaderBean header)
Sets the date header that will be below the date area.

Parameters:
header - The date header that will be below the date area or null if none.

getEastDateHeader

public DateHeaderBean getEastDateHeader()
Returns the date header that is to the right the date area.

Returns:
The date header that is to the right the date area or null if none.

setEastDateHeader

public void setEastDateHeader(DateHeaderBean header)
Sets the date header that will be to the right the date area.

Parameters:
header - The date header that will be to the right the date area or null if none.

validateHeaders

public void validateHeaders()

getLabelFont

public java.awt.Font getLabelFont()
Property: The font used to draw the label.

This is a property that affects the visual representation of the label in the cells.

Returns:
The font used to draw the label. Might be null.
See Also:
setLabelFont(java.awt.Font)

setLabelFont

public void setLabelFont(java.awt.Font font)
Property: The font used to draw the label.

This is a property that affects the visual representation of the label in the cells.

Parameters:
font - The font used to draw the label. Might be null.
See Also:
getLabelFont()

getLabelNowFont

public java.awt.Font getLabelNowFont()
Property: The font used to draw the label for the cell that spans the current time.

This is a property that affects the visual representation of the label in the cells.

Returns:
The font used to draw the label. Might be null.
See Also:
setLabelNowFont(java.awt.Font)

setLabelNowFont

public void setLabelNowFont(java.awt.Font font)
Property: The font used to draw the label for the cell that spans the current time.

This is a property that affects the visual representation of the label in the cells.

Parameters:
font - The font used to draw the label. Might be null.
See Also:
getLabelNowFont()

getLabelAntiAlias

public int getLabelAntiAlias()
Property: The anti aliasing hint used when drawing the label. For instance GfxUtil.AA_HINT_ON.

Returns:
The current hint. May be null.
See Also:
GfxUtil.confAntiAliasingHint(java.awt.Graphics2D, boolean, int)

setLabelAntiAlias

public void setLabelAntiAlias(int hint)
Property: The anti aliasing hint used when drawing the label. For instance GfxUtil.AA_HINT_ON.

Parameters:
hint - The new hint.
See Also:
GfxUtil.confAntiAliasingHint(java.awt.Graphics2D, boolean, int)

getLabelBackground

public java.awt.Paint getLabelBackground()
Property: The Paint used to draw the background of the label. It will draw the whole bounds that is specified with setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect).

This is a property that affects the visual representation of the label in the cells.

Returns:
The paint used to draw the background of the label. If null no background will be painted.
See Also:
setLabelBackground(java.awt.Paint)

setLabelBackground

public void setLabelBackground(java.awt.Paint paint)
Property: The Paint used to draw the background of the label. It will draw the whole bounds that is specified with setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect).

This is a property that affects the visual representation of the label in the cells.

Parameters:
paint - The paint. May be null.
See Also:
getLabelBackground()

getLabelNowBackground

public java.awt.Paint getLabelNowBackground()
Property: The Paint used to draw the background of the label for the cell that spans the current time. It will draw the whole bounds that is specified with setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect).

This is a property that affects the visual representation of the label in the cells.

Returns:
The paint used to draw the background of the label. If null no background will be painted.
See Also:
setLabelBackground(java.awt.Paint)

setLabelNowBackground

public void setLabelNowBackground(java.awt.Paint paint)
Property: The Paint used to draw the background of the label for the cell that spans the current time. It will draw the whole bounds that is specified with setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect).

This is a property that affects the visual representation of the label in the cells.

Parameters:
paint - The paint. May be null.
See Also:
getLabelBackground()

getLabelBorder

public javax.swing.border.Border getLabelBorder()
Property: The border that is painted around the label.

This is a property that affects the visual representation of the label in the cells.

Returns:
The border that is painted around the label. null means that the label will not be drawn at all, but the background might
See Also:
setLabelBorder(Border)

setLabelBorder

public void setLabelBorder(javax.swing.border.Border b)
Property: The border that is painted around the label.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
b - The border that is painted around the label. May be null.
See Also:
getLabelBorder()

getLabelNowBorder

public javax.swing.border.Border getLabelNowBorder()
Property: The border that is painted around the label for the cell that spans the current time.

This is a property that affects the visual representation of the label in the cells.

Returns:
The border that is painted around the label. null means that the label will not be drawn at all, but the background might still be for instance.
See Also:
setLabelBorder(Border)

setLabelNowBorder

public void setLabelNowBorder(javax.swing.border.Border b)
Property: The border that is painted around the label for the cell that spans the current time.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
b - The border that is painted around the label. May be null.
See Also:
getLabelBorder()

getLabelForeground

public java.awt.Color getLabelForeground()
Property: The paint that is used to draw the label.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Paint used to draw the label. null means that the label will not be drawn at all, but the background might still be for instance.
See Also:
setLabelForeground(Color)

setLabelForeground

public void setLabelForeground(java.awt.Color c)
Property: The paint that is used to draw the label.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
c - The color that is used to draw the label. May be null.
See Also:
getLabelForeground()

getLabelShadowForeground

public java.awt.Color getLabelShadowForeground()
Property: The color that is used to draw the label shadow.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Color used to draw the label shadow. null means that the label shadow will not be drawn at all, but the background might still be for instance.
Since:
6.5
See Also:
setLabelShadowForeground(Color)

setLabelShadowForeground

public void setLabelShadowForeground(java.awt.Color c)
Property: The color that is used to draw the label shadow.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
c - The color that is used to draw the label shadow. May be null.
Since:
6.5
See Also:
getLabelShadowForeground()

getLabelShadowOffset

public java.awt.Point getLabelShadowOffset()
Property: The relative offset that is used to draw the label shadow.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Point used to displace the label shadow. null means that the label shadow will not be drawn at all, but the background might still be for instance. Default is new Point(0, 1).
Since:
6.5
See Also:
setLabelShadowForeground(Color)

setLabelShadowOffset

public void setLabelShadowOffset(java.awt.Point p)
Property: The relative offset that is used to draw the label shadow.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
p - Thecurrent value, may be null. Default is new Point(0, 1).
Since:
6.5
See Also:
getLabelShadowForeground()

getLabelNowShadowForeground

public java.awt.Color getLabelNowShadowForeground()
Property: The color that is used to draw the label shadow for the NOW date.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Color used to draw the label shadow. null means that the label shadow will not be drawn at all, but the background might still be for instance.
Since:
6.5
See Also:
setLabelNowShadowForeground(Color)

setLabelNowShadowForeground

public void setLabelNowShadowForeground(java.awt.Color c)
Property: The color that is used to draw the label shadow for the NOW date.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
c - The color that is used to draw the label shadow. May be null.
Since:
6.5
See Also:
getLabelNowShadowForeground()

getLabelNowShadowOffset

public java.awt.Point getLabelNowShadowOffset()
Property: The relative Offset that is used to draw the label shadow for the NOW date.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Point used to displace the label shadow. null means that the label shadow will not be drawn at all, but the background might still be for instance. Default is new Point(0, 1).
Since:
6.5
See Also:
setLabelNowShadowForeground(Color)

setLabelNowShadowOffset

public void setLabelNowShadowOffset(java.awt.Point p)
Property: The relative Offset that is used to draw the label shadow for the NOW date.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
p - Thecurrent value, may be null. Default is new Point(0, 1).
Since:
6.5
See Also:
getLabelNowShadowForeground()

getLabelNowForeground

public java.awt.Color getLabelNowForeground()
Property: The paint that is used to draw the label for the cell that spans the current time.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Paint used to draw the label. null means that the label will not be drawn at all, but the background might still be for instance.
Since:
6.5
See Also:
setLabelForeground(Color)

setLabelNowForeground

public void setLabelNowForeground(java.awt.Color c)
Property: The paint that is used to draw the label for the cell that spans the current time.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
c - The color that is used to draw the label. May be null.
Since:
6.5
See Also:
getLabelForeground()

setLabelNowPlaceRect

public void setLabelNowPlaceRect(PlaceRect c)
Property: Optional correction to the cell rectangle. For instance to make the today cell bigger or smaller.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
c - The color that is used to draw the label. May be null.
Since:
6.5
See Also:
getLabelNowPlaceRect()

getLabelNowPlaceRect

public PlaceRect getLabelNowPlaceRect()
Property: Optional correction to the cell rectangle. For instance to make the today cell bigger or smaller.

This is a property that affects the visual representation of the label in the cells.

Returns:
The Paint used to draw the label. null means that the label will not be drawn at all, but the background might still be for instance.
Since:
6.5
See Also:
setLabelNowPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)

getLabelPlaceRect

public PlaceRect getLabelPlaceRect()
Property: Denotes the bounds that the label should get. The PlaceRect will be given the bounds of the cell and return/convert that to the bounds that the label should have.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Returns:
The specifivation
See Also:
setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)

setLabelPlaceRect

public void setLabelPlaceRect(PlaceRect placeRect)
Property: Denotes the bounds that the label should get. The PlaceRect object will be given the bounds of the cell and return/convert that to the bounds that the label should have.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
placeRect - The new bounds spec. May be null.
See Also:
getLabelPlaceRect()

getLabelAlignX

public AtRefRangeNumber getLabelAlignX()
Property: The horizontal alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)). It can be a fixed number of pixels from either end or relative (say 50% in, which means centered). There are a number of subclasses to this interface such as AtStart, AtEnd and AtFraction.

E.g. new AtFraction(0.5f) or new AtStart(10f).

This is a property that affects the visual representation of the label in the cells.

Returns:
The current alignment. Not null.
See Also:
setLabelAlignX(com.miginfocom.util.gfx.geometry.numbers.AtRefRangeNumber)

setLabelAlignX

public void setLabelAlignX(AtRefRangeNumber x)
Property: The horizontal alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)). It can be a fixed number of pixels from either end or relative (say 50% in, which means centered). There are a number of subclasses to this interface such as AtStart, AtEnd and AtFraction.

E.g. new AtFraction(0.5f) or new AtStart(10f).

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
x - The new horizontal alignment. Not null.
See Also:
getLabelAlignX()

getLabelAlignY

public AtRefRangeNumber getLabelAlignY()
Property: The vertical alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)). It can be a fixed number of pixels from either end or relative (say 50% in, which means centered). There are a number of subclasses to this interface such as AtStart, AtEnd and AtFraction.

E.g. new AtFraction(0.5f) or new AtStart(10f).

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Returns:
The current alignment. Not null.
See Also:
setLabelAlignY(com.miginfocom.util.gfx.geometry.numbers.AtRefRangeNumber)

setLabelAlignY

public void setLabelAlignY(AtRefRangeNumber y)
Property: The vertical alignment the label should have within the bounds denoted by the PlaceRact (setLabelPlaceRect(com.miginfocom.util.gfx.geometry.PlaceRect)). It can be a fixed number of pixels from either end or relative (say 50% in, which means centered). There are a number of subclasses to this interface such as AtStart, AtEnd and AtFraction.

E.g. new AtFraction(0.5f) or new AtStart(10f).

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
y - The new vertical alignment. Not null.
See Also:
getLabelAlignY()

getLabelDateFormat

public java.lang.String getLabelDateFormat()
Property: The date format that specifies the text that will be the label. The start date/time that the cell spans will be formatted with this date format and the result will be the label.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Returns:
The current date format. May be null.
See Also:
setLabelDateFormat(String)

setLabelDateFormat

public void setLabelDateFormat(java.lang.String format)
Property: The date format that specifies the text that will be the label. The start date/time that the cell spans will be formatted with this date format and the result will be the label.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
format - The new date format. May be null which will make the label not show.
See Also:
getLabelDateFormat()

getLabelNowDateFormat

public java.lang.String getLabelNowDateFormat()
Property: The date format that specifies the text that will be the label for the cell that spans the current time. The start date/time that the cell spans will be formatted with this date format and the result will be the label.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Returns:
The current date format. May be null.
See Also:
setLabelNowDateFormat(String)

setLabelNowDateFormat

public void setLabelNowDateFormat(java.lang.String format)
Property: The date format that specifies the text that will be the label for the cell that spans the current time. The start date/time that the cell spans will be formatted with this date format and the result will be the label.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
format - The new date format. May be null which will make the label not show.
See Also:
getLabelNowDateFormat()

getLabelNowRangeType

public java.lang.Integer getLabelNowRangeType()
Property: The range type to round the "now" date to. Can for instance be set to DateRangeI.RANGE_TYPE_MONTH to make all the cells in a month be cosidered "now" and get the "now" font/background/foreground.

Returns:
The current range type or null if not set. E.g. DateRangeI.RANGE_TYPE_MONTH.

setLabelNowRangeType

public void setLabelNowRangeType(java.lang.Integer rangeType)
Property: The range type to round the "now" date to. Can for instance be set to DateRangeI.RANGE_TYPE_MONTH to make all the cells in a month be cosidered "now" and get the "now" font/background/foreground.

Parameters:
rangeType - E.g. DateRangeI.RANGE_TYPE_MONTH.

getLabelFirstDateFormat

public java.lang.String getLabelFirstDateFormat()
Property: Date format for the "first" of something, e.g. first day of the month.

Returns:
Date format for the "first" of something, e.g. first day of the month.
Since:
6.0

setLabelFirstDateFormat

public void setLabelFirstDateFormat(java.lang.String format)
Property: Date format for the "first" of something, e.g. first day of the month.

Parameters:
format - Date format for the "first" of something, e.g. first day of the month.
Since:
6.0

getLabelFirstInField

public int getLabelFirstInField()
Property: If getFirstDateFormat() is != this is the Calendar field that is used to know what's "first".

Returns:
The range type. E.g. Calendar.DAY_OF_MONTH.
Since:
6.0

setLabelFirstInField

public void setLabelFirstInField(int calField)
Property: If getFirstDateFormat() is != this is the Calendar field that is used to know what's "first".

Parameters:
calField - The range type. E.g. Calendar.DAY_OF_MONTH.
Since:
6.0

getLabelCellModulo

public int getLabelCellModulo()
Property: This property make is possible to show every second or third (for instance) cell label instead if the default every one. A value of 2 will show every second label etc.

This is a property that affects the visual representation of the label in the cells.

Returns:
The current modulo.
See Also:
setLabelCellModulo(int)

setLabelCellModulo

public void setLabelCellModulo(int i)
Property: This property make is possible to show every second or third (for instance) cell label instead if the default every one. A value of 2 will show every second label etc.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
i - The new modulo. 1 is default and wil paint every one.
See Also:
getLabelCellModulo()

getLabelMinimumCellSize

public java.awt.Dimension getLabelMinimumCellSize()
Property: If the cell is smaller than this size, in any dimension, the label will not be drawn. This can be used to hide the label if the cells get to be too small to show the label in an acceptable way.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Returns:
The current minimum cell size. May be null.
See Also:
setLabelMinimumCellSize(java.awt.Dimension)

setLabelMinimumCellSize

public void setLabelMinimumCellSize(java.awt.Dimension size)
Property: If the cell is smaller than this size, in any dimension, the label will not be drawn. This can be used to hide the label if the cells get to be too small to show the label in an acceptable way.

This is a property that affects the visual representation of the label in the cells. Setting the value to null will normally make this label not appear at all.

Parameters:
size - The new minumum size. May be null in which case the label is always shown.
See Also:
getLabelMinimumCellSize()

getNoExpandedFolderGridLine

public boolean getNoExpandedFolderGridLine()
Property: If the grid lines around a folded (collapsed) folder sub row should be merged to one. This is to avoid the double grid lines that would be visible around rows with size 0 otherwise. It is purely a visual setting and won't affect any data or functionality.

Returns:
The current state.

setNoExpandedFolderGridLine

public void setNoExpandedFolderGridLine(boolean b)
Property: If the grid lines around a folded (collapsed) folder sub row should be merged to one. This is to avoid the double grid lines that would be visible around rows with size 0 otherwise. It is purely a visual setting and won't affect any data or functionality.

Parameters:
b - The new state. Default if false.

getHorizontalGridLinePaintEven

public java.awt.Paint getHorizontalGridLinePaintEven()
Property: The paint used to draw the even (0, 2, 4...) horizontal grid lines.

Returns:
The current paint. May be null.

setHorizontalGridLinePaintEven

public void setHorizontalGridLinePaintEven(java.awt.Paint paint)
Property: The paint used to draw the even (0, 2, 4...) horizontal grid lines.

Parameters:
paint - The new paint. May be null.

getHorizontalGridLinePaintOdd

public java.awt.Paint getHorizontalGridLinePaintOdd()
Property: The paint used to draw the odd (1, 3, 5...) horizontal grid lines.

Returns:
The current paint. May be null.

setHorizontalGridLinePaintOdd

public void setHorizontalGridLinePaintOdd(java.awt.Paint paint)
Property: The paint used to draw the odd (1, 3, 5...) horizontal grid lines.

Parameters:
paint - The new paint. May be null.

getHorizontalGridLineShowFirst

public boolean getHorizontalGridLineShowFirst()
Property: If the indicated grid line should be visible or not (default).

Returns:
The current value. false is default.

setHorizontalGridLineShowFirst

public void setHorizontalGridLineShowFirst(boolean b)
Property: If the indicated grid line should be visible or not (default).

Parameters:
b - The new value. false is default.

getHorizontalGridLineShowLast

public boolean getHorizontalGridLineShowLast()
Property: If the indicated grid line should be visible or not (default).

Returns:
The current value. false is default.

setHorizontalGridLineShowLast

public void setHorizontalGridLineShowLast(boolean b)
Property: If the indicated grid line should be visible or not (default).

Parameters:
b - The new value. false is default.

getVerticalGridLinePaintEven

public java.awt.Paint getVerticalGridLinePaintEven()
Property: The paint used to draw the even (0, 2, 4...) vertical grid lines.

Returns:
The current paint. May be null.

setVerticalGridLinePaintEven

public void setVerticalGridLinePaintEven(java.awt.Paint paint)
Property: The paint used to draw the even (0, 2, 4...) vertical grid lines.

Parameters:
paint - The new paint. May be null.

getVerticalGridLinePaintOdd

public java.awt.Paint getVerticalGridLinePaintOdd()
Property: The paint used to draw the odd (1, 3, 5...) vertical grid lines.

Returns:
The current paint. May be null.

setVerticalGridLinePaintOdd

public void setVerticalGridLinePaintOdd(java.awt.Paint paint)
Property: The paint used to draw the odd (1, 3, 5...) vertical grid lines.

Parameters:
paint - The new paint. May be null.

getVerticalGridLineShowFirst

public boolean getVerticalGridLineShowFirst()
Property: If the indicated grid line should be visible or not (default).

Returns:
The current value. false is default.

setVerticalGridLineShowFirst

public void setVerticalGridLineShowFirst(boolean b)
Property: If the indicated grid line should be visible or not (default).

Parameters:
b - The new value. false is default.

getVerticalGridLineShowLast

public boolean getVerticalGridLineShowLast()
Property: If the indicated grid line should be visible or not (default).

Returns:
The current value. false is default.

setVerticalGridLineShowLast

public void setVerticalGridLineShowLast(boolean b)
Property: If the indicated grid line should be visible or not (default).

Parameters:
b - The new value. false is default.

getSubRowGridLinePaint

public java.awt.Paint getSubRowGridLinePaint()
Property: The paint used to draw sub row divider grid lines. This will only be in the secondary dimension since sub rows can only exist in the secondary dimension.

Returns:
The current paint. May be null.

setSubRowGridLinePaint

public void setSubRowGridLinePaint(java.awt.Paint paint)
Property: The paint used to draw sub row divider grid lines. This will only be in the secondary dimension since sub rows can only exist in the secondary dimension.

Parameters:
paint - The new paint. may be null.

getHorizontalGridLineExceptions

public GridLineException[] getHorizontalGridLineExceptions()
Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way. Examples of exceptions is:
You can have several exceptions (as this property is an array) each capable of the above list and if the first exception is not a "hit" then the next one will be evaluated and so on until the array is finnished and the grid line used will be the default one.

To really understand how flexible and powerful this feature is see the "Repetitions" section in the FAQ document.

Returns:
The exceptions or zero length if no exteptions to the grid lines exist (default). Never null.

setHorizontalGridLineExceptions

public void setHorizontalGridLineExceptions(GridLineException[] exceptions)
Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way. Examples of exceptions is:
You can have several exceptions (as this property is an array) each capable of the above list and if the first exception is not a "hit" then the next one will be evaluated and so on until the array is finnished and the grid line used will be the default one.

To really understand how flexible and powerful this feature is see the "Repetitions" section in the FAQ document.

Parameters:
exceptions - The exceptions or zero length if no exteptions to the grid lines exist (default). Never null.

getVerticalGridLineExceptions

public GridLineException[] getVerticalGridLineExceptions()
Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way. Examples of exceptions is:
You can have several exceptions (as this property is an array) each capable of the above list and if the first exception is not a "hit" then the next one will be evaluated and so on until the array is finnished and the grid line used will be the default one.

To really understand how flexible and powerful this feature is see the "Repetitions" section in the FAQ document.

Returns:
The exceptions or zero length if no exteptions to the grid lines exist (default). Never null.

setVerticalGridLineExceptions

public void setVerticalGridLineExceptions(GridLineException[] exceptions)
Property: Grid line exceptions makes it very fleible to override the gridline size and color in a structured way. Examples of exceptions is:
You can have several exceptions (as this property is an array) each capable of the above list and if the first exception is not a "hit" then the next one will be evaluated and so on until the array is finnished and the grid line used will be the default one.

To really understand how flexible and powerful this feature is see the "Repetitions" section in the FAQ document.

Parameters:
exceptions - The exceptions or zero length if no exteptions to the grid lines exist (default). Never null.

getSelectionMouseOverPaint

public java.awt.Paint getSelectionMouseOverPaint()
Property: The paint used to fill the cells that the mouse is over. null indicated no mouse over painting.

Returns:
The current paint. May be null.
See Also:
DefaultDateArea.setDateRangeSelection(com.miginfocom.util.dates.DateRangeI, int, boolean)

setSelectionMouseOverPaint

public void setSelectionMouseOverPaint(java.awt.Paint paint)
Property: The paint used to fill the cells that the mouse is over. null indicated no mouse over painting.

Parameters:
paint - The new paint. May be null.
See Also:
DefaultDateArea.setDateRangeSelection(com.miginfocom.util.dates.DateRangeI, int, boolean)

getSelectionMousePressedPaint

public java.awt.Paint getSelectionMousePressedPaint()
Property: The paint used to fill the cells that the is pressed over (e.g. temporary selection). null indicated no mouse press painting.

Returns:
The current paint. May be null.
See Also:
DefaultDateArea.setDateRangeSelection(com.miginfocom.util.dates.DateRangeI, int, boolean)

setSelectionMousePressedPaint

public void setSelectionMousePressedPaint(java.awt.Paint paint)
Property: The paint used to fill the cells that the is pressed over (e.g. temporary selection). null indicated no mouse press painting.

Parameters:
paint - The new paint. May be null.
See Also:
DefaultDateArea.setDateRangeSelection(com.miginfocom.util.dates.DateRangeI, int, boolean)

getSelectionPaint

public java.awt.Paint getSelectionPaint()
Property: The paint used to fill the cells that are selected. null indicated no selection painting.

Returns:
The current paint. May be null.
See Also:
DefaultDateArea.setDateRangeSelection(com.miginfocom.util.dates.DateRangeI, int, boolean)

setSelectionPaint

public void setSelectionPaint(java.awt.Paint paint)
Property: The paint used to fill the cells that are selected. null indicated no selection painting.

Parameters:
paint - The new paint. May be null.
See Also:
DefaultDateArea.setDateRangeSelection(com.miginfocom.util.dates.DateRangeI, int, boolean)

getSelectablePaint

public java.awt.Paint getSelectablePaint()
Property: The paint used to fill the cells that are marked as selectable. null indicated no selectable painting.

Returns:
The current paint. May be null.
See Also:
DefaultDateArea.setSelectableRange(com.miginfocom.util.dates.DateRangeI)

setSelectablePaint

public void setSelectablePaint(java.awt.Paint paint)
Property: The paint used to fill the cells that are marked as selectable. null indicated no selectable painting.

Parameters:
paint - The new paint. May be null.
See Also:
DefaultDateArea.setSelectableRange(com.miginfocom.util.dates.DateRangeI)

getSelectionBoundaryType

public int getSelectionBoundaryType()
Property: The type of date range (e.g. day, hour, week) that selectionw will be rounded to. For instance if set to DateRangeI.RANGE_TYPE_DAY only full days can be selected, one can not select just a couple of hours.

Returns:
The current boundary type. E.g. DateRangeI.RANGE_TYPE_WEEK.

setSelectionBoundaryType

public void setSelectionBoundaryType(int rangeType)
Property: The type of date range (e.g. day, hour, week) that selectionw will be rounded to. For instance if set to DateRangeI.RANGE_TYPE_DAY only full days can be selected, one can not select just a couple of hours.

Parameters:
rangeType - The new boundary type. E.g. DateRangeI.RANGE_TYPE_HOUR.

getOddRowPaint

public java.awt.Paint getOddRowPaint()
Property: The paint to paint for all odd rows. May be null.

Returns:
The current paint. May be null.

setOddRowPaint

public void setOddRowPaint(java.awt.Paint paint)
Property: The paint to paint for all odd rows. May be null.

Parameters:
paint - The new paint. May be null.

getOddColumnPaint

public java.awt.Paint getOddColumnPaint()
Property: The paint to paint for all odd columns. May be null.

Returns:
The current paint. May be null.

setOddColumnPaint

public void setOddColumnPaint(java.awt.Paint paint)
Property: The paint to paint for all odd columns. May be null.

Parameters:
paint - The new paint. May be null.

getEvenBoundaryPaint

public java.awt.Paint getEvenBoundaryPaint()
Property: The paint used to fill all even (0, 2, 4...) date ranges of the date area. For instance every even month. The odd date ranges will get the background color of the date area since they are not painted at all. Use getEvenRangeType() and getEvenRangeTypeCount() to set the range type/count.

Returns:
The current paint. May be null.
See Also:
getEvenRangeType(), getEvenRangeTypeCount()

setEvenBoundaryPaint

public void setEvenBoundaryPaint(java.awt.Paint paint)
Property: The paint used to fill all even (0, 2, 4...) date ranges of the date area. For instance every even month. The odd date ranges will get the background color of the date area since they are not painted at all. Use getEvenRangeType() and getEvenRangeTypeCount() to set the range type/count.

Parameters:
paint - The new paint. May be null.
See Also:
setEvenRangeType(int), setEvenRangeTypeCount(int)

getEvenRangeType

public int getEvenRangeType()
Property: The date range type (i.e. Unit. E.g. day, week, month) that the paint boundary have. If for instance every second month should be painted in another color this property should be set to DateRangeI.RANGE_TYPE_MONTH.

Returns:
The current date range type. E.g. DateRangeI.RANGE_TYPE_MONTH.

setEvenRangeType

public void setEvenRangeType(int rangeType)
Property: The date range type (i.e. Unit. E.g. day, week, month) that the paint boundary have. If for instance every second month should be painted in another color this property should be set to DateRangeI.RANGE_TYPE_MONTH.

Parameters:
rangeType - The new date range type. E.g. DateRangeI.RANGE_TYPE_MONTH.

getEvenRangeTypeCount

public int getEvenRangeTypeCount()
Property: How many of getEvenRangeType() that should be bunched up and be called as one. If for instance this value is 3 and the type is DateRangetI.RANGE_TYPE_DAY then day 0, 1, 2 will be painted with the even paint. 3, 4, 5 will not be painted. 6, 7, 8 will be painted with the even painte again and so on.

Returns:
The current date range type count.

setEvenRangeTypeCount

public void setEvenRangeTypeCount(int count)
Property: How many of getEvenRangeType() that should be bunched up and be called as one. If for instance this value is 3 and the type is DateRangetI.RANGE_TYPE_DAY then day 0, 1, 2 will be painted with the even paint. 3, 4, 5 will not be painted. 6, 7, 8 will be painted with the even painte again and so on.

Parameters:
count - The new date range type count.

getDividerPaint

public java.awt.Paint getDividerPaint()
Property: The paint used to draw separator lines between some date ranges, for instance months.

Returns:
The current paint. May be null.
See Also:
getDividerRangeType()

setDividerPaint

public void setDividerPaint(java.awt.Paint paint)
Property: The paint used to draw separator lines between some date ranges, for instance months.

Parameters:
paint - The new paint. May be null.
See Also:
setDividerRangeType(int)

getDividerRangeType

public int getDividerRangeType()
Property: The type of the divider range (e.g. day, week, month). If the divider should be drawn between months for instance this value should be DateRangeI.RANGE_TYPE_MONTH.

Returns:
The current divider date range type. E.g. DateRangeI.RANGE_TYPE_MONTH.

setDividerRangeType

public void setDividerRangeType(int rangeType)
Property: The type of the divider range (e.g. day, week, month). If the divider should be drawn between months for instance this value should be DateRangeI.RANGE_TYPE_MONTH.

Parameters:
rangeType - The new divider date range type. E.g. DateRangeI.RANGE_TYPE_MONTH.

isActivitiesSupported

public boolean isActivitiesSupported()
Property: If activities should be handled by this date area or not. Setting to false will optimize the repaint cycle some.

Returns:
The current value. Default is true.
Since:
6.5
See Also:
DefaultDateArea.setActivitiesSupported(boolean)

setActivitiesSupported

public void setActivitiesSupported(boolean b)
Property: If activities should be handled by this date area or not. Setting to false will optimize the repaint cycle some.

Parameters:
b - The new value. Default is true.
Since:
6.5
See Also:
DefaultDateArea.setActivitiesSupported(boolean)

getLayoutOptimizeBoundary

public java.lang.Integer getLayoutOptimizeBoundary()
Property: When an activity is changed the activites that overlaps it will be layed out again. If the visual bounds of the activity extends layout-wise outside the base date range of the activity more activities needs to be re-layed out. Normally this is not done but by changing this property to a boundary type (e.g. DateRangeI.RANGE_TYPE_DAY the affected layout date range is rounded upwards to this boundary. null means exact and no rounding.

Returns:
The current value. Default is null.
Since:
6.5

setLayoutOptimizeBoundary

public void setLayoutOptimizeBoundary(java.lang.Integer boundary)
Property: When an activity is changed the activites that overlaps it will be layed out again. If the visual bounds of the activity extends layout-wise outside the base date range of the activity more activities needs to be re-layed out. Normally this is not done but by changing this property to a boundary type (e.g. DateRangeI.RANGE_TYPE_DAY the affected layout date range is rounded upwards to this boundary. null means exact and no rounding.

Parameters:
boundary - The current value. Default is null.
Since:
6.5

getMouseOverActivitiesOntop

public boolean getMouseOverActivitiesOntop()
Property: If Activites that have the mouse hovering over them should be painted on top of other activities.

Returns:
The current value. Default is false.

setMouseOverActivitiesOntop

public void setMouseOverActivitiesOntop(boolean b)
Property: If Activites that have the mouse hovering over them should be painted on top of other activities.

Parameters:
b - The new value. Default is false.

getSelectedActivitiesOntop

public boolean getSelectedActivitiesOntop()
Property: If Activites that are selected should be painted on top of other activities.

Returns:
The current value. Default is false.

setSelectedActivitiesOntop

public void setSelectedActivitiesOntop(boolean b)
Property: If Activites that are selected should be painted on top of other activities.

Parameters:
b - The new value. Default is false.

getActivityDepositoryContext

public java.lang.String getActivityDepositoryContext()
Property: The context used as a key in the ActivityDepository to get the activities that this date area should show. In the depository activities can optionally be put in different "containers" which are adressed by this context. The default context is null.

Returns:
The current context. Default is null.

setActivityDepositoryContext

public void setActivityDepositoryContext(java.lang.String context)
Property: The context used as a key in the ActivityDepository to get the activities that this date area should show. In the depository activities can optionally be put in different "containers" which are adressed by this context. The default context is null.

Parameters:
context - The new context. Default is null.

isShowNoFitIcon

public boolean isShowNoFitIcon()
Property: If the little icon that shows that not all activities have fitted within a date range (normally a day). Mouse presses on this icon, as well as how the icon/AShape should look like is handled by the DefaultDateArea that this JavBean aggregates. It is gettable by getDefaultDateArea().

To register a listener for mouse events register a InteractionListener on the date area.

To change the AShape used for the no fit shape call DefaultDateArea.setDefaultNoFitShape(com.miginfocom.ashape.shapes.RootAShape) after calling this method (this method sets it to default).

This method basically set the shape to null or AShapeUtil.createDefaultNoFitShape(DefaultDateArea.NO_FIT_EVENT_PROPERTY) depending on b.

Returns:
If the not fit icon will be shown. Basically checks if the shape is set to null.

setShowNoFitIcon

public void setShowNoFitIcon(boolean b)
Property: If the little icon that shows that not all activities have fitted within a date range (normally a day). Mouse presses on this icon, as well as how the icon/AShape should look like is handled by the DefaultDateArea that this JavBean aggregates. It is gettable by getDefaultDateArea().

To register a listener for mouse events register a InteractionListener on the date area.

To change the AShape used for the no fit shape call DefaultDateArea.setDefaultNoFitShape(com.miginfocom.ashape.shapes.RootAShape) after calling this method (this method sets it to default).

Parameters:
b - If the not fit icon will be shown. Basically checks if the shape is set to null.

getSelectionType

public int getSelectionType()
Property: The type of selection that can be done on the date area background. This has nothing to do with activity selection.

Returns:
The old selection type. DateArea.SELECTION_TYPE_NORMAL or DateArea.SELECTION_TYPE_NONE.

setSelectionType

public void setSelectionType(int type)
Property: The type of selection that can be done on the date area background. This has nothing to do with activity selection.

Parameters:
type - If the date area cells can be selected or not. DateArea.SELECTION_TYPE_NORMAL or DateArea.SELECTION_TYPE_NONE.

getBackgroundPaint

public java.awt.Paint getBackgroundPaint()
Property: The background paint in the date area. Will override the normal background Color so that Paint objects can be used instead.

Returns:
The current background paint. May be null.

setBackgroundPaint

public void setBackgroundPaint(java.awt.Paint p)
Property: The background paint in the date area. Will override the normal background Color so that Paint objects can be used instead.

Parameters:
p - The new background paint. May be null.

getBackgroundPaintViewport

public boolean getBackgroundPaintViewport()
If the background paint should oly paint the view port. This means that for instance a gradient will span the viewport (the visible part in a scroll pane) and not the whole component.

Note that if the background is a Paint (and not a Color) the scrolling may be slower since the viewport needs to be repainted in full when scrolling.

Returns:
The current value. Default is true.

setBackgroundPaintViewport

public void setBackgroundPaintViewport(boolean b)
If the background paint should oly paint the view port. This means that for instance a gradient will span the viewport (the visible part in a scroll pane) and not the whole component.

Note that if the background is a Paint (and not a Color) the scrolling may be slower since the viewport needs to be repainted in full when scrolling.

Parameters:
b - The new value. Default is true.

getDateAreaInnerBorder

public javax.swing.border.Border getDateAreaInnerBorder()
Property: The inner border around the date area. The border vill be set on the view so that parts of it will be covered if there is scrolling.

Returns:
The current border. May be null.
See Also:
getDateAreaOuterBorder()

setDateAreaInnerBorder

public void setDateAreaInnerBorder(javax.swing.border.Border b)
Property: The inner border around the date area. The border vill be set on the view so that parts of it will be covered if there is scrolling.

Parameters:
b - The new border. May be null.
See Also:
setDateAreaOuterBorder(javax.swing.border.Border)

getDateAreaOuterBorder

public javax.swing.border.Border getDateAreaOuterBorder()
Property: The outer border around the date area. The border will be installed on the scroll pane so that it will normally always be shown fully even if the view is partly scrolled away (invisible).

Returns:
The current border. May be null.
See Also:
getDateAreaInnerBorder()

setDateAreaOuterBorder

public void setDateAreaOuterBorder(javax.swing.border.Border b)
Property: The outer border around the date area. The border will be installed on the scroll pane so that it will normally always be shown fully even if the view is partly scrolled away (invisible).

Parameters:
b - The new border. May be null.
See Also:
setDateAreaInnerBorder(javax.swing.border.Border)

addActivityDragResizeListener

public void addActivityDragResizeListener(ActivityDragResizeListener l)
This call is transmitted to the DefaultDateArea.addActivityDragResizeListener(com.miginfocom.calendar.datearea.ActivityDragResizeListener)


addActivityDragResizeListener

public void addActivityDragResizeListener(ActivityDragResizeListener l,
                                          boolean asWeakRef)
This call is transmitted to the DefaultDateArea.addActivityDragResizeListener(com.miginfocom.calendar.datearea.ActivityDragResizeListener, boolean)


removeActivityDragResizeListener

public void removeActivityDragResizeListener(ActivityDragResizeListener l)
This call is transmitted to the DefaultDateArea.removeActivityDragResizeListener(com.miginfocom.calendar.datearea.ActivityDragResizeListener)


addDateChangeListener

public void addDateChangeListener(DateChangeListener l)
This call is transmitted to the DefaultDateArea.addDateChangeListener(com.miginfocom.util.dates.DateChangeListener)


addDateChangeListener

public void addDateChangeListener(DateChangeListener l,
                                  boolean asWeakRef)
This call is transmitted to the DefaultDateArea.addDateChangeListener(com.miginfocom.util.dates.DateChangeListener, boolean)


removeDateChangeListener

public void removeDateChangeListener(DateChangeListener l)
This call is transmitted to the DefaultDateArea.removeDateChangeListener(com.miginfocom.util.dates.DateChangeListener)


addInteractionListener

public void addInteractionListener(InteractionListener l)
This call is transmitted to the DefaultDateArea.addInteractionListener(com.miginfocom.ashape.interaction.InteractionListener)


addInteractionListener

public void addInteractionListener(InteractionListener l,
                                   boolean asWeakRef)
This call is transmitted to the DefaultDateArea.addInteractionListener(com.miginfocom.ashape.interaction.InteractionListener, boolean)


removeInteractionListener

public void removeInteractionListener(InteractionListener l)
This call is transmitted to the DefaultDateArea.removeInteractionListener(com.miginfocom.ashape.interaction.InteractionListener).


addActivityMoveListener

public void addActivityMoveListener(ActivityMoveListener l)
This call is transmitted to the DefaultDateArea.addActivityMoveListener(com.miginfocom.calendar.datearea.ActivityMoveListener)


addActivityMoveListener

public void addActivityMoveListener(ActivityMoveListener l,
                                    boolean asWeakRef)
This call is transmitted to the DefaultDateArea.addActivityMoveListener(com.miginfocom.calendar.datearea.ActivityMoveListener, boolean)


removeActivityMoveListener

public void removeActivityMoveListener(ActivityMoveListener l)
This call is transmitted to the DefaultDateArea.removeActivityMoveListener(com.miginfocom.calendar.datearea.ActivityMoveListener)


addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)
Overrides:
addMouseListener in class java.awt.Component

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)
Overrides:
addMouseMotionListener in class java.awt.Component

addMouseWheelListener

public void addMouseWheelListener(java.awt.event.MouseWheelListener l)
Overrides:
addMouseWheelListener in class java.awt.Component

addKeyListener

public void addKeyListener(java.awt.event.KeyListener l)
Overrides:
addKeyListener in class java.awt.Component

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener l)
Overrides:
removeKeyListener in class java.awt.Component

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener l)
Overrides:
removeMouseListener in class java.awt.Component

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)
Overrides:
removeMouseMotionListener in class java.awt.Component

removeMouseWheelListener

public void removeMouseWheelListener(java.awt.event.MouseWheelListener l)
Overrides:
removeMouseWheelListener in class java.awt.Component


Copyright © 2009 MiG InfoCom AB. All Rights Reserved.