Class AbstractSettings
java.lang.Object
org.eclipse.nebula.widgets.ganttchart.AbstractSettings
- All Implemented Interfaces:
ISettings
,ISettings2
- Direct Known Subclasses:
DefaultSettings
,GanttTester.TestSettings
public abstract class AbstractSettings extends java.lang.Object implements ISettings2
-
Field Summary
Fields inherited from interface org.eclipse.nebula.widgets.ganttchart.ISettings
CONNECTION_ARROW_RIGHT_TO_LEFT, CONNECTION_ARROW_RIGHT_TO_TOP, CONNECTION_BIRDS_FLIGHT_PATH, CONNECTION_MS_PROJECT_STYLE, DEFAULT_CONNECTION_ARROW, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, VIEW_D_DAY, VIEW_DAY, VIEW_MINUTE, VIEW_MONTH, VIEW_WEEK, VIEW_YEAR, ZOOM_DAY_MAX, ZOOM_DAY_MEDIUM, ZOOM_DAY_NORMAL, ZOOM_HOURS_MAX, ZOOM_HOURS_MEDIUM, ZOOM_HOURS_NORMAL, ZOOM_MINUTES_MAX, ZOOM_MINUTES_MEDIUM, ZOOM_MINUTES_NORMAL, ZOOM_MONTH_MAX, ZOOM_MONTH_MEDIUM, ZOOM_MONTH_NORMAL, ZOOM_SECONDS_MAX, ZOOM_SECONDS_MEDIUM, ZOOM_SECONDS_NORMAL, ZOOM_YEAR_MAX, ZOOM_YEAR_MEDIUM, ZOOM_YEAR_NORMAL, ZOOM_YEAR_SMALL, ZOOM_YEAR_VERY_SMALL
-
Constructor Summary
Constructors Constructor Description AbstractSettings()
-
Method Summary
Modifier and Type Method Description boolean
adjustForLetters()
Letters have different width.boolean
allowArrowKeysToScrollChart()
Whether arrow keys are enabled to scroll chart left/right/up/down.boolean
allowBlankAreaDragAndDropToMoveDates()
If true, it lets the move forwards or backwards in time by clicking in a "blank" area and dragging the mouse.boolean
allowBlankAreaVerticalDragAndDropToMoveChart()
Relies onISettings.allowBlankAreaDragAndDropToMoveDates()
being true.boolean
allowCheckpointResizing()
Whether checkpoints can be resized (assuming resizing is onISettings.enableResizing()
).boolean
allowHeaderSelection()
Whether selecting dates in the header is allowed by clicking the date.boolean
allowInfiniteHorizontalScrollBar()
Whether to mimic Microsoft © Project's infinite scrollbar which lets users scroll into the future or past indefinitely.boolean
allowPhaseOverlap()
When phases are resized or moved, whether an overlap resize/move should be accepted or not.boolean
allowScopeMenu()
Whether scopes can show a right click menu or not.boolean
alwaysDragAllEvents()
The default behaviour in GanttChart on moving an event is that only the current dragged event is moved unless you press the SHIFT key.boolean
drawEventsDownToTheHourAndMinute()
If this returns true, events are never rounded up to their nearest hour/minute when shown in the chart, but will always show down to the minute even in any mid-zoomed and fully-zoomed out view (this does not do anything to the normal minute view).boolean
drawEventString()
Global configuration to specify if the text of GanttEvents should be rendered or not.boolean
drawFillsToBottomWhenUsingGanttSections()
Whether to draw fills and vertical lines etc to the bottom when GanttSections are used.boolean
drawFullPercentageBar()
The percentage bar always draws as a line in the center of the event but normally it only draws the part that displays the % complete.boolean
drawGanttSectionBarToBottom()
Whether the GanttSection bar should draw all the way down or not.boolean
drawHeader()
Whether to draw the header or not.boolean
drawHorizontalLines()
Whether to draw horizontal lines between the events.boolean
drawLockedDateMarks()
When dates are locked down to a certain day, the chart will draw a special marker on the lock start and end dates to point out that it's locked between certain constraints.boolean
drawSectionBar()
Configure whether the section bar should be rendered.boolean
drawSectionDetails()
Configure whether there should be an additional area to the section bar that shows additional section detail information.boolean
drawSelectionMarkerAroundSelectedEvent()
If true, draws a dotted selection marker around the currently selected event to visualize the selection.boolean
drawVerticalLines()
The vertical lines are the lines that divide days and weeks etc.boolean
enableAddEvent()
boolean
enableAutoScroll()
Whether to enable auto scroll which causes the chart to scroll either left or right when events are dragged or resized beyond the bounds of the chart.boolean
enableDragAndDrop()
Whether event drag-and-drop is turned on or off.boolean
enableLastDraw()
See IGanttEventListener's lastDraw(GC gc) method method info.boolean
enableResizing()
Whether event-resizing is turned on or off.boolean
enableTodayLineUpdater()
Start the updating tread for TodayLine (red line marking current time)boolean
enableZooming()
If zooming in/out should be enabled or disabled.boolean
fireEmptyEventSelection()
whetherIGanttEventListener.eventSelected(GanttEvent, java.util.List, org.eclipse.swt.events.MouseEvent)
should also be called on empty selectionboolean
flipBlankAreaDragDirection()
If for some reason the drag left vs. drag right directions feel reversed, simply flip this to switch them around.boolean
forceMouseWheelVerticalScroll()
In SWT 3.5 it seems the mousewheel is not interpreted the same as in previous versions.int
getAdvancedTooltipXOffset()
Advanced tooltips are shells and by default they pop up where the mouse pointer is.int
getArrowConnectionType()
What type of arrow connection to draw.int
getArrowHeadEventSpacer()
Returns the space between the head of the dependency arrowhead and the event.int
getArrowHeadVerticalAdjuster()
If you for some reason wish to move the arrow head up or down vertically, setting a number here will modify the vertical "extra".int
getCalendarStartupDateOffset()
Date offset of the startup date that the calendar should start at.java.lang.String
getDateFormat()
The date format to use when displaying dates in string format.java.lang.String
getDayHeaderTextDisplayFormatBottom()
The SimpleDateFormat of the text shown in the bottom header for the day view.java.lang.String
getDayHeaderTextDisplayFormatTop()
The SimpleDateFormat of the text shown in the top header for the day view.int
getDayHorizontalSpacing()
Returns the spacing from the top where the day letter is printed.int
getDayVerticalSpacing()
Returns the space from the left of the border where the day letter is printed.int
getDayWidth()
Returns the width for each day that is drawn.java.util.Calendar
getDDayRootCalendar()
It's highly suggested you use the default implementation of this method.int
getDDaySplitCount()
The value where D-days have their "weeks" so to speak, this is used to calculate the numbers shown in both headers, where the top header is displaying each "set" whereas the bottom one shows numbers from 0 to the number returned by this method.java.lang.String
getDefaultAdvancedTooltipHelpText()
The default help text shown in the advanced tooltip.java.lang.String
getDefaultAdvancedTooltipText()
The default tooltip shown in the advanced tooltip.java.lang.String
getDefaultAdvancedTooltipTextExtended()
The default extended tooltip shown in the advanced tooltip.java.lang.String
getDefaultAdvancedTooltipTitle()
The default title text shown in the advanced tooltip.org.eclipse.swt.graphics.Image
getDefaultAdvandedTooltipHelpImage()
The default help image used in the advanced tooltip.org.eclipse.swt.graphics.Image
getDefaultAdvandedTooltipImage()
The default image used in the advanced tooltip.org.eclipse.swt.graphics.Color
getDefaultEventColor()
The default color for an event when there is none set on the event itself.org.eclipse.swt.graphics.Color
getDefaultGradientEventColor()
The default gradient color for an event (if gradients are turned on).java.util.Locale
getDefaultLocale()
Locale used for calendars and wherever needed.int
getDragAllModifierKey()
The keyboard modifier key (also known as a hint) used to determine when it's a drag-all-linked-eventsISettings.moveLinkedEventsWhenEventsAreMoved()
event or just a normal drag.int
getEventHeight()
Returns the height for each event, including checkpoints.int
getEventPercentageBarHeight()
Returns the height of the bar that is drawn inside the events that represents the percentage done.int
getEventsBottomSpacer()
Bottom spacer between the bottom event and the section divider when using GanttSections.int
getEventSpacer()
Returns the vertical space between each event.int
getEventsTopSpacer()
Top spacer between the top pixel and the beginning of the first event.int
getHeaderDayHeight()
Returns the height of the header section that displays the days.int
getHeaderMonthHeight()
Returns the height of the header section that displays the month names.java.lang.String
getHourDateFormat()
The date format to use when displaying dates in string format in the hours view.int
getInitialView()
What view is used when the chart is initially drawn.int
getInitialZoomLevel()
What initial zoom level is used when the chart is initially drawn.org.eclipse.swt.graphics.Image
getLockImage()
Returns the image used for displaying something as locked in the GANTT chart.int
getMinimumSectionHeight()
Minimum height of sections.java.lang.String
getMinuteDateFormat()
The date format to use when displaying dates in string format in the minutes view.java.lang.String
getMinuteHeaderTextDisplayFormatBottom()
The SimpleDateFormat of the text shown in the bottom header for the minute view.java.lang.String
getMinuteHeaderTextDisplayFormatTop()
The SimpleDateFormat of the text shown in the top header for the minute view.int
getMinZoomLevel()
Returns the minimum zoom level.int
getMonthDayWidth()
Returns the width for each day that is drawn in the monthly view.java.lang.String
getMonthHeaderTextDisplayFormatBottom()
The SimpleDateFormat of the text shown in the bottom header for the month view.java.lang.String
getMonthHeaderTextDisplayFormatTop()
The SimpleDateFormat of the text shown in the top header for the month view.int
getMoveAreaNegativeSensitivity()
Returns the number of pixels off each side of an event towards the center of it that is ignored when trying to move an event.int
getNumberOfDaysToAppendForEndOfDay()
Normally a day is calculated as day_starts->day_ends, which means that to make an event that starts and ends on the same day count as "anything", +1 is added by default to make the event actually show up on the chart.int
getPercentageBarAlpha()
The Alpha level of the percentage complete bar.java.util.Calendar
getPeriodEnd()
Specify a period end.java.util.Calendar
getPeriodStart()
Specify a period start.int
getPhasesHeaderHeight()
When drawingGanttPhase
s this is the header height used for displaying the names of these phases.int
getRemainderPercentageBarAlpha()
The Alpha level of the remaining percentage complete bar.int
getResizeBorderSensitivity()
Returns the number of pixels off each side of an event that is the area for which the resize cursor is shown.int
getReverseDependencyLineHorizontalSpacer()
If you plan on using reverse dependencies, this value will be interesting.int
getRevisedLineSpacer()
The distance from the event top (and event bottom) that is used to draw the line portraying revised start and end dates.int
getSectionBarDividerHeight()
The height of the bar drawn between sections.int
getSectionBarWidth()
Width of the section bar.ISectionDetailContentReplacer
getSectionDetailContentReplacer()
Returns the custom section detail generator which generates the section detail out of custom data for a GanttSection.java.lang.String
getSectionDetailText()
The detail information that should be rendered in the section detail area.java.lang.String
getSectionDetailTitle()
The section detail area title that should be rendered in the section detail area.int
getSectionDetailWidth()
int
getSectionSide()
Which side the section bar should be drawn on.int
getSectionTextSpacer()
If the name of any section is so large that it basically defines the size of the section, this value is used to space out the text slightly so that the section borders don't hug the text.java.util.Calendar
getStartupCalendarDate()
Returns the position that the calendar should start on when first created.java.lang.String
getTextDisplayFormat()
Decides how the string behind the event is displayed.int
getTextSpacerConnected()
Returns the space between the actual event and the text that is written after the event when the event has a connecting line extending from it.int
getTextSpacerNonConnected()
Returns the space between the actual event and the text that is written after the event when the event has no connecting line extending from it.int
getTodayLineStyle()
The default line style of the line showing where today's date is.int
getTodayLineVerticalOffset()
The vertical offset from the top for the today line calculated from the bottom part of the header.int
getTodayLineWidth()
The width of the line showing where today's date is.IToolTipContentReplacer
getToolTipContentReplacer()
Returns the custom tool tip generator which generates the tooltip out of custom data for a GanttEvent.boolean
getUseAdvancedTooltips()
Whether to use Advanced Tooltips by default.int
getVerticalDragResistance()
For events that can be dragged vertically, this is the "resistance" in pixels before the event "lets go" of it's horizontal location.int
getVerticalEventDragging()
What style of vertical event dragging that is enabled.int
getVerticalTickMarkOffset()
The vertical offset from top for the tick marks in the top header.java.lang.String
getWeekHeaderTextDisplayFormatBottom()
The SimpleDateFormat of the text shown in the bottom header for the week view.java.lang.String
getWeekHeaderTextDisplayFormatTop()
The SimpleDateFormat of the text shown in the top header for the week view.java.lang.String
getYearHeaderTextDisplayFormatBottom()
The SimpleDateFormat of the text shown in the bottom header for the year view.java.lang.String
getYearHeaderTextDisplayFormatTop()
The SimpleDateFormat of the text shown in the top header for the year view.int
getYearMonthDayWidth()
Returns the width for each day that is drawn in the yearly view.int
getZoomWheelModifierKey()
The keyboard modifier key combined with the scroll wheel to make the chart zoom.boolean
lockHeaderOnVerticalScroll()
Whether the header should always be visible regardless of vertical scroll position.boolean
moveAndResizeOnlyDependentEventsThatAreLaterThanLinkedMoveEvent()
If this returns true, only linked events that come after the source drag event (time/date-wise) will be moved/resized (normally all linked events are moved/resized regardless of time/date).boolean
moveLinkedEventsWhenEventsAreMoved()
Whether users can hold downSHIFT
(or whatever the settings say) to move an event, and all dependent events will move with the selected event.boolean
onVerticalDragDropShowInsertMarker()
Whether an insert marker should be shown for where the dragged event will end up when a vertical drag/drop is in progress.boolean
printFooter()
Configure whether a footer should be added to the print pages or not.boolean
printSelectedVerticallyComplete()
On printing a GanttChart it is possible to select to print only the selected area.boolean
roundHourlyEventsOffToNearestHour()
Whether to round off minutes on events to nearest hour.boolean
scaleImageToDayWidth()
Whether to allow an image to exceed the width of one day when zooming in / out.boolean
scrollChartVerticallyOnMouseWheel()
Whether the chart should scroll vertically when the mouse wheel is used.boolean
shiftHorizontalCenteredEventString()
If you want to show the event String within the event rectangle by setting the horizontalTextLocation of the GanttEvent to SWT.CENTER, there are cases that break the visualization.boolean
showArrows()
If to draw arrows on connecting lines or not.boolean
showBarsIn3D()
Whether to show events in 3D (meaning, a drop shadow is drawn below and to the right of the event)boolean
showBoldScopeText()
Whether the name of the scope is drawn in bold or plain.boolean
showDateTips()
Whether to show date tooltips when events are moved or resized.boolean
showDateTipsOnScrolling()
Whether to show a date tooltip when scrolling horizontally (changing dates) and vertically.boolean
showDefaultMenuItemsOnEventRightClick()
Whether to show the default set of menu items on the right click menus of events.boolean
showDeleteMenuOption()
Whether to show the delete menu option in the right click menu.boolean
showGradientEventBars()
Whether to draw the color on the events using gradients.boolean
showHolidayToolTips()
Configure whether a tooltip pops up when hovering the mouse over a holidayboolean
showMenuItemsOnRightClick()
Whether to show any menu items at all when right clicking an event or a chart.boolean
showNumberOfDaysOnBars()
Whether to show a "plaque" on the event bars that displays a number of how many days the event spans over.boolean
showOnlyDependenciesForSelectedItems()
Whether to only show the dependency connections only when an event is selected, as opposed to always showing the lines.boolean
showPlannedDates()
Whether to draw lines that show where the revised dates would have been on the chart (assuming revised dates are set).boolean
showPropertiesMenuOption()
Whether to show the properties menu option in the right click menu.boolean
showResizeDateTipOnBorders()
Whether the date tooltip box (if turned on) when resizing should hug the border of the event on the left or right side or if it should be simply stick somewhat to the event resize location.boolean
showSectionDetailMore()
boolean
showToolTips()
Whether to show tooltips when mouse is lingering over events.boolean
showZoomLevelBox()
Whether when a user zooms in or out (only viaCTRL
(or whatever the settings say) +Scroll Wheel
) to display a box in the bottom left corner that shows the zoom level.boolean
startCalendarOnFirstDayOfWeek()
Moves the calendar to start on the first day of the week of the either current date or the date set inISettings.getStartupCalendarDate()
boolean
useSplitArrowConnections()
If you plan on using reverse dependencies, you may want to flag this to true.boolean
zoomToMousePointerDateOnWheelZooming()
When you zoom in with the mouse, it can either act as a normal zoom (uses leftmost date as start date) or it can zoom in where the mouse pointer is at the time of the zoom in.
-
Constructor Details
-
AbstractSettings
public AbstractSettings()
-
-
Method Details
-
getDateFormat
public java.lang.String getDateFormat()Description copied from interface:ISettings
The date format to use when displaying dates in string format.- Specified by:
getDateFormat
in interfaceISettings
- Returns:
- Date format. Default is month/day/year.
- See Also:
DateFormat
,DateFormatSymbols
-
getHourDateFormat
public java.lang.String getHourDateFormat()Description copied from interface:ISettings
The date format to use when displaying dates in string format in the hours view.- Specified by:
getHourDateFormat
in interfaceISettings
- Returns:
- Date format. Default is month/day/year/ hh:mm.
- See Also:
DateFormat
,DateFormatSymbols
-
getMinuteDateFormat
public java.lang.String getMinuteDateFormat()Description copied from interface:ISettings2
The date format to use when displaying dates in string format in the minutes view.- Specified by:
getMinuteDateFormat
in interfaceISettings2
- Returns:
- Date format. Default is month/day/year/ hh:mm:ss.
- See Also:
DateFormat
,DateFormatSymbols
-
getWeekHeaderTextDisplayFormatTop
public java.lang.String getWeekHeaderTextDisplayFormatTop()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the top header for the week view.- Specified by:
getWeekHeaderTextDisplayFormatTop
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getMonthHeaderTextDisplayFormatTop
public java.lang.String getMonthHeaderTextDisplayFormatTop()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the top header for the month view.- Specified by:
getMonthHeaderTextDisplayFormatTop
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getDayHeaderTextDisplayFormatTop
public java.lang.String getDayHeaderTextDisplayFormatTop()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the top header for the day view.- Specified by:
getDayHeaderTextDisplayFormatTop
in interfaceISettings
- Returns:
SimpleDateFormat
string. May not be null.
-
getMinuteHeaderTextDisplayFormatTop
public java.lang.String getMinuteHeaderTextDisplayFormatTop()Description copied from interface:ISettings2
The SimpleDateFormat of the text shown in the top header for the minute view.- Specified by:
getMinuteHeaderTextDisplayFormatTop
in interfaceISettings2
- Returns:
SimpleDateFormat
string. May not be null.
-
getYearHeaderTextDisplayFormatTop
public java.lang.String getYearHeaderTextDisplayFormatTop()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the top header for the year view.- Specified by:
getYearHeaderTextDisplayFormatTop
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getDayHeaderTextDisplayFormatBottom
public java.lang.String getDayHeaderTextDisplayFormatBottom()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the bottom header for the day view.- Specified by:
getDayHeaderTextDisplayFormatBottom
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getMinuteHeaderTextDisplayFormatBottom
public java.lang.String getMinuteHeaderTextDisplayFormatBottom()Description copied from interface:ISettings2
The SimpleDateFormat of the text shown in the bottom header for the minute view.- Specified by:
getMinuteHeaderTextDisplayFormatBottom
in interfaceISettings2
- Returns:
- SimpleDateFormat string. May not be null.
-
getMonthHeaderTextDisplayFormatBottom
public java.lang.String getMonthHeaderTextDisplayFormatBottom()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the bottom header for the month view.- Specified by:
getMonthHeaderTextDisplayFormatBottom
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getWeekHeaderTextDisplayFormatBottom
public java.lang.String getWeekHeaderTextDisplayFormatBottom()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the bottom header for the week view.- Specified by:
getWeekHeaderTextDisplayFormatBottom
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getYearHeaderTextDisplayFormatBottom
public java.lang.String getYearHeaderTextDisplayFormatBottom()Description copied from interface:ISettings
The SimpleDateFormat of the text shown in the bottom header for the year view.- Specified by:
getYearHeaderTextDisplayFormatBottom
in interfaceISettings
- Returns:
- SimpleDateFormat string. May not be null.
-
getDefaultEventColor
public org.eclipse.swt.graphics.Color getDefaultEventColor()Description copied from interface:ISettings
The default color for an event when there is none set on the event itself.- Specified by:
getDefaultEventColor
in interfaceISettings
- Returns:
- Event color. Default is gray.
-
getDefaultGradientEventColor
public org.eclipse.swt.graphics.Color getDefaultGradientEventColor()Description copied from interface:ISettings
The default gradient color for an event (if gradients are turned on).- Specified by:
getDefaultGradientEventColor
in interfaceISettings
- Returns:
- Event gradient color. Default is white-ish.
-
showPropertiesMenuOption
public boolean showPropertiesMenuOption()Description copied from interface:ISettings
Whether to show the properties menu option in the right click menu. When clicked the event will be reported to IGanttEventListener.- Specified by:
showPropertiesMenuOption
in interfaceISettings
- Returns:
- True if to show the menu item. Default is true.
- See Also:
IGanttEventListener#eventPropertiesSelected(GanttEvent)
-
showDeleteMenuOption
public boolean showDeleteMenuOption()Description copied from interface:ISettings
Whether to show the delete menu option in the right click menu. When clicked the event will be reported to IGanttEventListener.- Specified by:
showDeleteMenuOption
in interfaceISettings
- Returns:
- True if to show the menu item. Default is true.
- See Also:
IGanttEventListener.eventsDeleteRequest(java.util.List, org.eclipse.swt.events.MouseEvent)
-
adjustForLetters
public boolean adjustForLetters()Description copied from interface:ISettings
Letters have different width. If turned on, this will try to make all day letters appear centered, whereas if turned off, letter width will be ignored.- Specified by:
adjustForLetters
in interfaceISettings
- Returns:
- true if to adjust for letter widths. Default is true.
-
enableAutoScroll
public boolean enableAutoScroll()Description copied from interface:ISettings
Whether to enable auto scroll which causes the chart to scroll either left or right when events are dragged or resized beyond the bounds of the chart.- Specified by:
enableAutoScroll
in interfaceISettings
- Returns:
- true if to enable. Default is true.
-
enableResizing
public boolean enableResizing()Description copied from interface:ISettings
Whether event-resizing is turned on or off.- Specified by:
enableResizing
in interfaceISettings
- Returns:
- true if turned on. If turned off, event resizing is not possible. Default is true.
-
getArrowConnectionType
public int getArrowConnectionType()Description copied from interface:ISettings
What type of arrow connection to draw. There are three types:ISettings.CONNECTION_ARROW_RIGHT_TO_TOP
- Arrow line (and arrow head if turned on) will be drawn into the events top and bottom corners.ISettings.CONNECTION_ARROW_RIGHT_TO_LEFT
- Arrow line (and arrow head if turned on) will be drawn into the events middle left or right side.ISettings.CONNECTION_MS_PROJECT_STYLE
- Arrow line (and arrow head if turned on) will be drawn as logically as possible from above event to below. Lines are rounded in corners and arrows will go to middle to top of below event or to side depending on where event is situated.ISettings.CONNECTION_BIRDS_FLIGHT_PATH
- Straight "as the bird flies" line between events without any bends.
- Specified by:
getArrowConnectionType
in interfaceISettings
- Returns:
- Arrow head type. Default is
CONNECTION_MS_PROJECT_STYLE
. - See Also:
ISettings.CONNECTION_MS_PROJECT_STYLE
-
getDayHorizontalSpacing
public int getDayHorizontalSpacing()Description copied from interface:ISettings
Returns the spacing from the top where the day letter is printed.- Specified by:
getDayHorizontalSpacing
in interfaceISettings
- Returns:
- Pixel value. Default is 4.
-
getDayVerticalSpacing
public int getDayVerticalSpacing()Description copied from interface:ISettings
Returns the space from the left of the border where the day letter is printed.- Specified by:
getDayVerticalSpacing
in interfaceISettings
- Returns:
- Pixel value. Default is 3.
-
getDayWidth
public int getDayWidth()Description copied from interface:ISettings
Returns the width for each day that is drawn. Zoom levels use multipliers with these numbers.- Specified by:
getDayWidth
in interfaceISettings
- Returns:
- Pixel value. Default is 16.
-
getEventHeight
public int getEventHeight()Description copied from interface:ISettings
Returns the height for each event, including checkpoints.- Specified by:
getEventHeight
in interfaceISettings
- Returns:
- Pixel value. Default is 12.
-
getEventPercentageBarHeight
public int getEventPercentageBarHeight()Description copied from interface:ISettings
Returns the height of the bar that is drawn inside the events that represents the percentage done.Note: If the event height is an even number, this number does best being odd, and vice versa.
- Specified by:
getEventPercentageBarHeight
in interfaceISettings
- Returns:
- Pixel value. Default is 3.
-
getHeaderMonthHeight
public int getHeaderMonthHeight()Description copied from interface:ISettings
Returns the height of the header section that displays the month names.- Specified by:
getHeaderMonthHeight
in interfaceISettings
- Returns:
- Pixel value. Default is 18.
-
getHeaderDayHeight
public int getHeaderDayHeight()Description copied from interface:ISettings
Returns the height of the header section that displays the days.- Specified by:
getHeaderDayHeight
in interfaceISettings
- Returns:
- Pixel value. Default is 18.
-
getInitialView
public int getInitialView()Description copied from interface:ISettings
What view is used when the chart is initially drawn. Options are:- Specified by:
getInitialView
in interfaceISettings
- Returns:
- Initial view. Default is VIEW_WEEK.
-
getInitialZoomLevel
public int getInitialZoomLevel()Description copied from interface:ISettings
What initial zoom level is used when the chart is initially drawn. Options are:ISettings.ZOOM_SECONDS_MAX
ISettings.ZOOM_SECONDS_MEDIUM
ISettings.ZOOM_SECONDS_NORMAL
ISettings.ZOOM_MINUTES_MAX
ISettings.ZOOM_MINUTES_MEDIUM
ISettings.ZOOM_MINUTES_NORMAL
ISettings.ZOOM_HOURS_MAX
ISettings.ZOOM_HOURS_MEDIUM
ISettings.ZOOM_HOURS_NORMAL
ISettings.ZOOM_DAY_MAX
ISettings.ZOOM_DAY_MEDIUM
ISettings.ZOOM_DAY_NORMAL
ISettings.ZOOM_MONTH_MAX
ISettings.ZOOM_MONTH_MEDIUM
ISettings.ZOOM_MONTH_NORMAL
ISettings.ZOOM_YEAR_MAX
ISettings.ZOOM_YEAR_MEDIUM
ISettings.ZOOM_YEAR_NORMAL
ISettings.ZOOM_YEAR_SMALL
ISettings.ZOOM_YEAR_VERY_SMALL
- Specified by:
getInitialZoomLevel
in interfaceISettings
- Returns:
- Zoom level. Default is
ISettings.ZOOM_DAY_NORMAL
- See Also:
ISettings.ZOOM_DAY_MAX
-
getMonthDayWidth
public int getMonthDayWidth()Description copied from interface:ISettings
Returns the width for each day that is drawn in the monthly view. Zoom levels use multipliers with these numbers.- Specified by:
getMonthDayWidth
in interfaceISettings
- Returns:
- Pixel value. Default is 6.
-
getResizeBorderSensitivity
public int getResizeBorderSensitivity()Description copied from interface:ISettings
Returns the number of pixels off each side of an event that is the area for which the resize cursor is shown. If people find it hard to grab events, increase this number.- Specified by:
getResizeBorderSensitivity
in interfaceISettings
- Returns:
- Pixel value. Default is 3.
-
getTextSpacerConnected
public int getTextSpacerConnected()Description copied from interface:ISettings
Returns the space between the actual event and the text that is written after the event when the event has a connecting line extending from it.- Specified by:
getTextSpacerConnected
in interfaceISettings
- Returns:
- Pixel value. Default is 9.
-
getTextSpacerNonConnected
public int getTextSpacerNonConnected()Description copied from interface:ISettings
Returns the space between the actual event and the text that is written after the event when the event has no connecting line extending from it.- Specified by:
getTextSpacerNonConnected
in interfaceISettings
- Returns:
- Pixel value. Default is 9.
-
getYearMonthDayWidth
public int getYearMonthDayWidth()Description copied from interface:ISettings
Returns the width for each day that is drawn in the yearly view. Zoom levels use multipliers with these numbers.WARNING: Setting this value below 3 will cause an infinite loop and probable application crash. This happens as internal size calculations end up on 0 width (rounded) values.
- Specified by:
getYearMonthDayWidth
in interfaceISettings
- Returns:
- Pixel value. Default is 3.
-
moveLinkedEventsWhenEventsAreMoved
public boolean moveLinkedEventsWhenEventsAreMoved()Description copied from interface:ISettings
Whether users can hold downSHIFT
(or whatever the settings say) to move an event, and all dependent events will move with the selected event.- Specified by:
moveLinkedEventsWhenEventsAreMoved
in interfaceISettings
- Returns:
- true if to move all linked events. Default is true.
- See Also:
ISettings.getDragAllModifierKey()
-
showArrows
public boolean showArrows()Description copied from interface:ISettings
If to draw arrows on connecting lines or not.- Specified by:
showArrows
in interfaceISettings
- Returns:
- true if to show arrowheads on connecting lines. Default is true.
-
showBarsIn3D
public boolean showBarsIn3D()Description copied from interface:ISettings
Whether to show events in 3D (meaning, a drop shadow is drawn below and to the right of the event)- Specified by:
showBarsIn3D
in interfaceISettings
- Returns:
- true if to show events in 3D. Default is true.
-
showBoldScopeText
public boolean showBoldScopeText()Description copied from interface:ISettings
Whether the name of the scope is drawn in bold or plain.- Specified by:
showBoldScopeText
in interfaceISettings
- Returns:
- true if bold. Default is true.
-
showDateTips
public boolean showDateTips()Description copied from interface:ISettings
Whether to show date tooltips when events are moved or resized.- Specified by:
showDateTips
in interfaceISettings
- Returns:
- true if to show tooltips. Default is true.
-
showPlannedDates
public boolean showPlannedDates()Description copied from interface:ISettings
Whether to draw lines that show where the revised dates would have been on the chart (assuming revised dates are set).- Specified by:
showPlannedDates
in interfaceISettings
- Returns:
- true if to draw lines for the revised dates. Default is false.
-
showGradientEventBars
public boolean showGradientEventBars()Description copied from interface:ISettings
Whether to draw the color on the events using gradients. The colors are controlled by setting the following two variables on the GanttEvent.GanttEvent.setGradientStatusColor(Color)
andGanttEvent.setStatusColor(Color)
.- Specified by:
showGradientEventBars
in interfaceISettings
- Returns:
- true if to draw with gradients. Default is true.
- See Also:
GanttEvent.setGradientStatusColor(Color)
,GanttEvent.setStatusColor(Color)
-
showNumberOfDaysOnBars
public boolean showNumberOfDaysOnBars()Description copied from interface:ISettings
Whether to show a "plaque" on the event bars that displays a number of how many days the event spans over.- Specified by:
showNumberOfDaysOnBars
in interfaceISettings
- Returns:
- true if to show the plaque. Default is false.
-
showOnlyDependenciesForSelectedItems
public boolean showOnlyDependenciesForSelectedItems()Description copied from interface:ISettings
Whether to only show the dependency connections only when an event is selected, as opposed to always showing the lines.- Specified by:
showOnlyDependenciesForSelectedItems
in interfaceISettings
- Returns:
- true if to show them only on selections. Default is false.
-
showToolTips
public boolean showToolTips()Description copied from interface:ISettings
Whether to show tooltips when mouse is lingering over events.- Specified by:
showToolTips
in interfaceISettings
- Returns:
- true if to show tooltips. Default is true.
-
getEventSpacer
public int getEventSpacer()Description copied from interface:ISettings
Returns the vertical space between each event.- Specified by:
getEventSpacer
in interfaceISettings
- Returns:
- Pixel value. Default is 12.
-
enableDragAndDrop
public boolean enableDragAndDrop()Description copied from interface:ISettings
Whether event drag-and-drop is turned on or off.- Specified by:
enableDragAndDrop
in interfaceISettings
- Returns:
- true if turned on. If turned off, drag and drop is not possible. Default is true.
-
showZoomLevelBox
public boolean showZoomLevelBox()Description copied from interface:ISettings
Whether when a user zooms in or out (only viaCTRL
(or whatever the settings say) +Scroll Wheel
) to display a box in the bottom left corner that shows the zoom level.- Specified by:
showZoomLevelBox
in interfaceISettings
- Returns:
- true if to show a box when zooming. Default is true.
- See Also:
ISettings.getZoomWheelModifierKey()
-
allowInfiniteHorizontalScrollBar
public boolean allowInfiniteHorizontalScrollBar()Description copied from interface:ISettings
Whether to mimic Microsoft © Project's infinite scrollbar which lets users scroll into the future or past indefinitely. If turned off, the scrollbar will reflect the range of the oldest event's start date, to the latest event end date.- Specified by:
allowInfiniteHorizontalScrollBar
in interfaceISettings
- Returns:
- true if to turn on infinite scrollbar. Default is true.
-
showResizeDateTipOnBorders
public boolean showResizeDateTipOnBorders()Description copied from interface:ISettings
Whether the date tooltip box (if turned on) when resizing should hug the border of the event on the left or right side or if it should be simply stick somewhat to the event resize location.- Specified by:
showResizeDateTipOnBorders
in interfaceISettings
- Returns:
- true if to stick to the resize sides. Default is true.
-
allowBlankAreaDragAndDropToMoveDates
public boolean allowBlankAreaDragAndDropToMoveDates()Description copied from interface:ISettings
If true, it lets the move forwards or backwards in time by clicking in a "blank" area and dragging the mouse. Similar to the hand tool in Photoshop or Acrobat.- Specified by:
allowBlankAreaDragAndDropToMoveDates
in interfaceISettings
- Returns:
- true if to allow clear-area drag. Default is true.
-
allowBlankAreaVerticalDragAndDropToMoveChart
public boolean allowBlankAreaVerticalDragAndDropToMoveChart()Description copied from interface:ISettings
Relies onISettings.allowBlankAreaDragAndDropToMoveDates()
being true. If so, this will additionally determine if the user can blank-area drag the chart in a vertical manner to move the chart in that direction as well. Holding down the shift key will double the speed of the vertical drag- Specified by:
allowBlankAreaVerticalDragAndDropToMoveChart
in interfaceISettings
- Returns:
- true to allow clear-area vertical drag. Default is false (as it can be confusing at first try).
-
flipBlankAreaDragDirection
public boolean flipBlankAreaDragDirection()Description copied from interface:ISettings
If for some reason the drag left vs. drag right directions feel reversed, simply flip this to switch them around. Only active ifISettings.allowBlankAreaDragAndDropToMoveDates()
is active.- Specified by:
flipBlankAreaDragDirection
in interfaceISettings
- Returns:
- true if to flip them around. Default is false.
- See Also:
ISettings.allowBlankAreaDragAndDropToMoveDates()
-
drawSelectionMarkerAroundSelectedEvent
public boolean drawSelectionMarkerAroundSelectedEvent()Description copied from interface:ISettings
If true, draws a dotted selection marker around the currently selected event to visualize the selection.- Specified by:
drawSelectionMarkerAroundSelectedEvent
in interfaceISettings
- Returns:
- true if to show a selection marker. Default is true.
-
allowCheckpointResizing
public boolean allowCheckpointResizing()Description copied from interface:ISettings
Whether checkpoints can be resized (assuming resizing is onISettings.enableResizing()
).- Specified by:
allowCheckpointResizing
in interfaceISettings
- Returns:
- true if checkpoints can be resized. Default is false.
- See Also:
ISettings.enableResizing()
-
showMenuItemsOnRightClick
public boolean showMenuItemsOnRightClick()Description copied from interface:ISettings
Whether to show any menu items at all when right clicking an event or a chart.- Specified by:
showMenuItemsOnRightClick
in interfaceISettings
- Returns:
- true if to show menu items on right click. Default is true.
-
getArrowHeadEventSpacer
public int getArrowHeadEventSpacer()Description copied from interface:ISettings
Returns the space between the head of the dependency arrowhead and the event.- Specified by:
getArrowHeadEventSpacer
in interfaceISettings
- Returns:
- pixel space. Default is 1.
-
getArrowHeadVerticalAdjuster
public int getArrowHeadVerticalAdjuster()Description copied from interface:ISettings
If you for some reason wish to move the arrow head up or down vertically, setting a number here will modify the vertical "extra".- Specified by:
getArrowHeadVerticalAdjuster
in interfaceISettings
- Returns:
- pixel length. Default is 0.
-
getStartupCalendarDate
public java.util.Calendar getStartupCalendarDate()Description copied from interface:ISettings
Returns the position that the calendar should start on when first created. If null, the current date will be used. Please remember to use a Locale when you create your Calendar object, ideally the same as used in the settingsISettings.getDefaultLocale()
.- Specified by:
getStartupCalendarDate
in interfaceISettings
- Returns:
- Calendar, or null.
-
getCalendarStartupDateOffset
public int getCalendarStartupDateOffset()Description copied from interface:ISettings
Date offset of the startup date that the calendar should start at. By default, you probably do not want this to be 0 as that will hug the leftmost side of the widget. It's suggested to set a negative value.- Specified by:
getCalendarStartupDateOffset
in interfaceISettings
- Returns:
- date offset in number of days. Default is -4.
-
startCalendarOnFirstDayOfWeek
public boolean startCalendarOnFirstDayOfWeek()Description copied from interface:ISettings
Moves the calendar to start on the first day of the week of the either current date or the date set inISettings.getStartupCalendarDate()
Please note, if theISettings.getCalendarStartupDateOffset()
is set to other than zero, these two methods will most likely clash. This setting has no effect on D-Day charts.- Specified by:
startCalendarOnFirstDayOfWeek
in interfaceISettings
- Returns:
- true whether calendar should start on the first day of the week. Default is false.
- See Also:
ISettings.getCalendarStartupDateOffset()
,ISettings.getStartupCalendarDate()
-
getMoveAreaNegativeSensitivity
public int getMoveAreaNegativeSensitivity()Description copied from interface:ISettings
Returns the number of pixels off each side of an event towards the center of it that is ignored when trying to move an event. This is to help resize distinguish from a move cursor and to help users find the two different areas.- Specified by:
getMoveAreaNegativeSensitivity
in interfaceISettings
- Returns:
- Pixel value. Default is 6. Remember that this value is handled in a negative calculation, but it should be a positive value.
-
enableZooming
public boolean enableZooming()Description copied from interface:ISettings
If zooming in/out should be enabled or disabled.- Specified by:
enableZooming
in interfaceISettings
- Returns:
- true if enabled. Default is true.
-
getLockImage
public org.eclipse.swt.graphics.Image getLockImage()Description copied from interface:ISettings
Returns the image used for displaying something as locked in the GANTT chart.- Specified by:
getLockImage
in interfaceISettings
- Returns:
- Image or null. Default is the
lock_tiny.gif
image in the package.
-
getTextDisplayFormat
public java.lang.String getTextDisplayFormat()Description copied from interface:ISettings
Decides how the string behind the event is displayed. You may override this individually by setting the GanttEvent parameter by the same name.- #name# = Name of event
- #pc# = Percentage complete
- #sd# = Start date
- #ed# = End date
- #rs# = Revised start date
- #re# = Revised end date
- #days# = Number of days event spans over
- #reviseddays# = Number of revised days event spans over
- Specified by:
getTextDisplayFormat
in interfaceISettings
- Returns:
- String format. Default is "#name# (#pc#%)"
- See Also:
GanttEvent.setTextDisplayFormat(String)
-
getRevisedLineSpacer
public int getRevisedLineSpacer()Description copied from interface:ISettings
The distance from the event top (and event bottom) that is used to draw the line portraying revised start and end dates.- Specified by:
getRevisedLineSpacer
in interfaceISettings
- Returns:
- Pixel spacing. Default is 3.
-
getDefaultAdvandedTooltipHelpImage
public org.eclipse.swt.graphics.Image getDefaultAdvandedTooltipHelpImage()Description copied from interface:ISettings
The default help image used in the advanced tooltip. Null if none.- Specified by:
getDefaultAdvandedTooltipHelpImage
in interfaceISettings
- Returns:
- Image or null. Default is null.
-
getDefaultAdvandedTooltipImage
public org.eclipse.swt.graphics.Image getDefaultAdvandedTooltipImage()Description copied from interface:ISettings
The default image used in the advanced tooltip. Null if none.- Specified by:
getDefaultAdvandedTooltipImage
in interfaceISettings
- Returns:
- Image or null. Default is null.
-
roundHourlyEventsOffToNearestHour
public boolean roundHourlyEventsOffToNearestHour()Description copied from interface:ISettings
Whether to round off minutes on events to nearest hour.- Specified by:
roundHourlyEventsOffToNearestHour
in interfaceISettings
- Returns:
- true if yes. Default is false.
-
getDefaultAdvancedTooltipHelpText
public java.lang.String getDefaultAdvancedTooltipHelpText()Description copied from interface:ISettings
The default help text shown in the advanced tooltip.- Specified by:
getDefaultAdvancedTooltipHelpText
in interfaceISettings
- Returns:
- String or null. Default is null.
-
getDefaultAdvancedTooltipTitle
public java.lang.String getDefaultAdvancedTooltipTitle()Description copied from interface:ISettings
The default title text shown in the advanced tooltip.- Specified by:
getDefaultAdvancedTooltipTitle
in interfaceISettings
- Returns:
- String or null. Default is null.
-
getDefaultAdvancedTooltipTextExtended
public java.lang.String getDefaultAdvancedTooltipTextExtended()Description copied from interface:ISettings
The default extended tooltip shown in the advanced tooltip. Extended tooltips are used when the GanttEvent has revised dates.- Specified by:
getDefaultAdvancedTooltipTextExtended
in interfaceISettings
- Returns:
- String or null. Default is a text showing the dates, revised dates and percentage complete.
-
getDefaultAdvancedTooltipText
public java.lang.String getDefaultAdvancedTooltipText()Description copied from interface:ISettings
The default tooltip shown in the advanced tooltip. Normal tooltips are used when the GanttEvent has no revised dates and also for scopes, images and checkpoints.- Specified by:
getDefaultAdvancedTooltipText
in interfaceISettings
- Returns:
- String or null. Default is a text showing the dates and percentage complete.
-
getTodayLineStyle
public int getTodayLineStyle()Description copied from interface:ISettings
The default line style of the line showing where today's date is.- Specified by:
getTodayLineStyle
in interfaceISettings
- Returns:
- SWT.LINE_ style. Default is SWT.LINE_SOLID.
-
getTodayLineWidth
public int getTodayLineWidth()Description copied from interface:ISettings
The width of the line showing where today's date is.- Specified by:
getTodayLineWidth
in interfaceISettings
- Returns:
- line width. Default is 2.
-
getTodayLineVerticalOffset
public int getTodayLineVerticalOffset()Description copied from interface:ISettings
The vertical offset from the top for the today line calculated from the bottom part of the header.- Specified by:
getTodayLineVerticalOffset
in interfaceISettings
- Returns:
- Vertical offset. Default is the height of the bottom header.
-
getVerticalTickMarkOffset
public int getVerticalTickMarkOffset()Description copied from interface:ISettings
The vertical offset from top for the tick marks in the top header.- Specified by:
getVerticalTickMarkOffset
in interfaceISettings
- Returns:
- Default is the height of the top header minus 5.
-
drawHeader
public boolean drawHeader()Description copied from interface:ISettings
Whether to draw the header or not. If this returns false, all header-related settings will be ignored.- Specified by:
drawHeader
in interfaceISettings
- Returns:
- true if to draw header. Default is true.
-
getEventsTopSpacer
public int getEventsTopSpacer()Description copied from interface:ISettings
Top spacer between the top pixel and the beginning of the first event. The top pixel will be either the height of the header (if drawn) or 0 if the header is not drawn.- Specified by:
getEventsTopSpacer
in interfaceISettings
- Returns:
- top spacer value. Default is 12.
-
getEventsBottomSpacer
public int getEventsBottomSpacer()Description copied from interface:ISettings
Bottom spacer between the bottom event and the section divider when using GanttSections. For non GanttSection usage, this setting is ignored.- Specified by:
getEventsBottomSpacer
in interfaceISettings
- Returns:
- bottom spacer value. Default is 12.
-
getSectionBarDividerHeight
public int getSectionBarDividerHeight()Description copied from interface:ISettings
The height of the bar drawn between sections.- Specified by:
getSectionBarDividerHeight
in interfaceISettings
- Returns:
- height. Default is 5.
-
getSectionBarWidth
public int getSectionBarWidth()Description copied from interface:ISettings
Width of the section bar.- Specified by:
getSectionBarWidth
in interfaceISettings
- Returns:
- width. Default is 20.
-
getMinimumSectionHeight
public int getMinimumSectionHeight()Description copied from interface:ISettings
Minimum height of sections. Normally the minimum height is calculated by:1. Space the section name takes up vertically
2. Space all contained events take up including various event spacers.If the two calculations above are smaller than the value returned by this method, the height returned from this method will be used.
- Specified by:
getMinimumSectionHeight
in interfaceISettings
- Returns:
- minimum section height (larger or equals to zero). Default is 80.
-
drawFullPercentageBar
public boolean drawFullPercentageBar()Description copied from interface:ISettings
The percentage bar always draws as a line in the center of the event but normally it only draws the part that displays the % complete. If this returns true it will draw that part, but also the remainder. You can set the color for the remainder different than that from the actual percentage complete as well.- Specified by:
drawFullPercentageBar
in interfaceISettings
- Returns:
- true if to draw the entire bar. Default is true.
-
getPercentageBarAlpha
public int getPercentageBarAlpha()Description copied from interface:ISettings
The Alpha level of the percentage complete bar. Only draws if Alpha is turned on.- Specified by:
getPercentageBarAlpha
in interfaceISettings
- Returns:
- Alpha value. Default is 255.
-
getRemainderPercentageBarAlpha
public int getRemainderPercentageBarAlpha()Description copied from interface:ISettings
The Alpha level of the remaining percentage complete bar. Only draws if Alpha is turned on.- Specified by:
getRemainderPercentageBarAlpha
in interfaceISettings
- Returns:
- Alpha value. Default is 70.
-
getAdvancedTooltipXOffset
public int getAdvancedTooltipXOffset()Description copied from interface:ISettings
Advanced tooltips are shells and by default they pop up where the mouse pointer is. To not block the pointer, an offset is used.- Specified by:
getAdvancedTooltipXOffset
in interfaceISettings
- Returns:
- horizontal offset. Default is 15.
-
getDragAllModifierKey
public int getDragAllModifierKey()Description copied from interface:ISettings
The keyboard modifier key (also known as a hint) used to determine when it's a drag-all-linked-eventsISettings.moveLinkedEventsWhenEventsAreMoved()
event or just a normal drag.- Specified by:
getDragAllModifierKey
in interfaceISettings
- Returns:
- Keyboard modifier. Default is
SWT.SHIFT
(the shift key) - See Also:
ISettings.moveLinkedEventsWhenEventsAreMoved()
-
getZoomWheelModifierKey
public int getZoomWheelModifierKey()Description copied from interface:ISettings
The keyboard modifier key combined with the scroll wheel to make the chart zoom.- Specified by:
getZoomWheelModifierKey
in interfaceISettings
- Returns:
- Keyboard modifier. Default is
SWT.MOD1
(usually theCTRL
key)
-
getDefaultLocale
public java.util.Locale getDefaultLocale()Description copied from interface:ISettings
Locale used for calendars and wherever needed.- Specified by:
getDefaultLocale
in interfaceISettings
- Returns:
- Locale. Default is Locale.getDefault().
-
getUseAdvancedTooltips
public boolean getUseAdvancedTooltips()Description copied from interface:ISettings
Whether to use Advanced Tooltips by default.- Specified by:
getUseAdvancedTooltips
in interfaceISettings
- Returns:
- True whether to use advanced tooltips. Default is true.
-
enableLastDraw
public boolean enableLastDraw()Description copied from interface:ISettings
See IGanttEventListener's lastDraw(GC gc) method method info.- Specified by:
enableLastDraw
in interfaceISettings
- Returns:
- true whether to enable the last draw functionality. Default is false.
- See Also:
IGanttEventListener.lastDraw(org.eclipse.swt.graphics.GC)
-
useSplitArrowConnections
public boolean useSplitArrowConnections()Description copied from interface:ISettings
If you plan on using reverse dependencies, you may want to flag this to true. This makes normal connections draw the arrow to the top left corner of the target event, and if it's a reverse dependency, it draw the arrow to the bottom left of target events. That way any overlapping event don't have arrows drawing in the exact same spot which makes it much easier to view the chart.- Specified by:
useSplitArrowConnections
in interfaceISettings
- Returns:
- true to split arrows. Default is false.
-
getReverseDependencyLineHorizontalSpacer
public int getReverseDependencyLineHorizontalSpacer()Description copied from interface:ISettings
If you plan on using reverse dependencies, this value will be interesting. If this value returns 0 and you have both a normal-direction dependency and a reverse one, their vertical lines will overlap. By setting this value to greater than zero that vertical line will be spaced out for reverse dependencies. The value is how much extra it will be spaced.- Specified by:
getReverseDependencyLineHorizontalSpacer
in interfaceISettings
- Returns:
- spacer value. Default is 2.
-
drawVerticalLines
public boolean drawVerticalLines()Description copied from interface:ISettings
The vertical lines are the lines that divide days and weeks etc.- Specified by:
drawVerticalLines
in interfaceISettings
- Returns:
- true if to draw vertical lines. Default is true.
- See Also:
GanttComposite#setDrawVerticalLinesOverride(Boolean)
-
drawHorizontalLines
public boolean drawHorizontalLines()Description copied from interface:ISettings
Whether to draw horizontal lines between the events. Useful for where you have a tree/table on the left and wish events to be easier to see when they are lined up with the tree items.- Specified by:
drawHorizontalLines
in interfaceISettings
- Returns:
- true to show horizontal lines. Default is false;
- See Also:
GanttComposite#setDrawHorizontalLinesOverride(Boolean)
-
getSectionSide
public int getSectionSide()Description copied from interface:ISettings
Which side the section bar should be drawn on.
You may use one ofSWT.LEFT
orSWT.RIGHT
.- Specified by:
getSectionSide
in interfaceISettings
- Returns:
- section bar side. Default is
SWT.LEFT
.
-
drawLockedDateMarks
public boolean drawLockedDateMarks()Description copied from interface:ISettings
When dates are locked down to a certain day, the chart will draw a special marker on the lock start and end dates to point out that it's locked between certain constraints.- Specified by:
drawLockedDateMarks
in interfaceISettings
- Returns:
- Whether to draw markers for date-range-locked events. Default is true.
-
showDateTipsOnScrolling
public boolean showDateTipsOnScrolling()Description copied from interface:ISettings
Whether to show a date tooltip when scrolling horizontally (changing dates) and vertically. The tooltip will show just above the bottom horizontal toolbar. Note that if showDateTips() returns false, this tip will not show.- Specified by:
showDateTipsOnScrolling
in interfaceISettings
- Returns:
- true whether to show date tooltips when scrolling through dates. Default is true.
- See Also:
ISettings.showDateTips()
-
drawFillsToBottomWhenUsingGanttSections
public boolean drawFillsToBottomWhenUsingGanttSections()Description copied from interface:ISettings
Whether to draw fills and vertical lines etc to the bottom when GanttSections are used.- Specified by:
drawFillsToBottomWhenUsingGanttSections
in interfaceISettings
- Returns:
- true to draw everything all the way down. Default is false.
-
drawGanttSectionBarToBottom
public boolean drawGanttSectionBarToBottom()Description copied from interface:ISettings
Whether the GanttSection bar should draw all the way down or not.- Specified by:
drawGanttSectionBarToBottom
in interfaceISettings
- Returns:
- true to draw all the way down. Default is false.
-
lockHeaderOnVerticalScroll
public boolean lockHeaderOnVerticalScroll()Description copied from interface:ISettings
Whether the header should always be visible regardless of vertical scroll position. Basically a "fixed header" feature.- Specified by:
lockHeaderOnVerticalScroll
in interfaceISettings
- Returns:
- true whether to lock the header. Default is false.
-
showDefaultMenuItemsOnEventRightClick
public boolean showDefaultMenuItemsOnEventRightClick()Description copied from interface:ISettings
Whether to show the default set of menu items on the right click menus of events. If false, the menu will be blank allowing you to set all items from scratch.- Specified by:
showDefaultMenuItemsOnEventRightClick
in interfaceISettings
- Returns:
- true to show default menu items along with custom ones on right click. Default is true.
- See Also:
ISettings.showMenuItemsOnRightClick()
,ISettings.showPropertiesMenuOption()
,ISettings.showDeleteMenuOption()
,GanttEvent.getMenu()
-
allowScopeMenu
public boolean allowScopeMenu()Description copied from interface:ISettings
Whether scopes can show a right click menu or not. By default scopes are non-active objects that simply draw according to their children. By allowing a menu to be shown on the scope you can still perform custom events if you so wish (such as show/hide all children).- Specified by:
allowScopeMenu
in interfaceISettings
- Returns:
- true to allow menus on scopes. Default is false.
- See Also:
GanttEvent.getMenu()
,GanttEvent.showAllChildren()
,GanttEvent.hideAllChildren()
-
allowHeaderSelection
public boolean allowHeaderSelection()Description copied from interface:ISettings
Whether selecting dates in the header is allowed by clicking the date. Events will be fired on selection events. Note that not all views have this feature, only those that actually show full dates, as that's where it makes most sense.- Specified by:
allowHeaderSelection
in interfaceISettings
- Returns:
- true to allow header selection. Default is true.
-
zoomToMousePointerDateOnWheelZooming
public boolean zoomToMousePointerDateOnWheelZooming()Description copied from interface:ISettings
When you zoom in with the mouse, it can either act as a normal zoom (uses leftmost date as start date) or it can zoom in where the mouse pointer is at the time of the zoom in. For some the first make more sense than the other and vice versa. Default is that the zoom in is where the mouse pointer is (true).- Specified by:
zoomToMousePointerDateOnWheelZooming
in interfaceISettings
-
getDDayRootCalendar
public java.util.Calendar getDDayRootCalendar()Description copied from interface:ISettings
It's highly suggested you use the default implementation of this method. Basically, this method needs to return a zeroed-down calendar (hours, minutes etc) that will be used as the D-day root calendar. As D-days aren't dates (except internally), this Calendar simply needs to be any "stable" date. By default it uses January 1st, [current year], 0h 0m 0s 0ms. (it uses the current year as days-between calculations otherwise get very large).- Specified by:
getDDayRootCalendar
in interfaceISettings
- Returns:
- Calendar
-
getDDaySplitCount
public int getDDaySplitCount()Description copied from interface:ISettings
The value where D-days have their "weeks" so to speak, this is used to calculate the numbers shown in both headers, where the top header is displaying each "set" whereas the bottom one shows numbers from 0 to the number returned by this method.- Specified by:
getDDaySplitCount
in interfaceISettings
- Returns:
- Split count number. Default is 10 which shows sets from 0 to 9.
-
drawEventsDownToTheHourAndMinute
public boolean drawEventsDownToTheHourAndMinute()Description copied from interface:ISettings
If this returns true, events are never rounded up to their nearest hour/minute when shown in the chart, but will always show down to the minute even in any mid-zoomed and fully-zoomed out view (this does not do anything to the normal minute view). Default is false.- Specified by:
drawEventsDownToTheHourAndMinute
in interfaceISettings
- Returns:
- true to draw event location down to the hour and minute
-
moveAndResizeOnlyDependentEventsThatAreLaterThanLinkedMoveEvent
public boolean moveAndResizeOnlyDependentEventsThatAreLaterThanLinkedMoveEvent()Description copied from interface:ISettings
If this returns true, only linked events that come after the source drag event (time/date-wise) will be moved/resized (normally all linked events are moved/resized regardless of time/date).- Specified by:
moveAndResizeOnlyDependentEventsThatAreLaterThanLinkedMoveEvent
in interfaceISettings
- Returns:
- true to only move/resize "later" events on dependent linked event moves/resizes. Default is false.
-
forceMouseWheelVerticalScroll
public boolean forceMouseWheelVerticalScroll()Description copied from interface:ISettings
In SWT 3.5 it seems the mousewheel is not interpreted the same as in previous versions. If you notice that when scrolling the mousewheel the chart does not actually scroll vertically, flag this to true to force it to scroll the chart. This is forced to true on *NIX machines (not Mac).- Specified by:
forceMouseWheelVerticalScroll
in interfaceISettings
- Returns:
- true to force the mousewheel to scroll the chart. Default is false.
- See Also:
ISettings.scrollChartVerticallyOnMouseWheel()
-
getSectionTextSpacer
public int getSectionTextSpacer()Description copied from interface:ISettings
If the name of any section is so large that it basically defines the size of the section, this value is used to space out the text slightly so that the section borders don't hug the text. If you want to save on some real-estate set this value to 0.- Specified by:
getSectionTextSpacer
in interfaceISettings
- Returns:
- Default is 30.
-
getPhasesHeaderHeight
public int getPhasesHeaderHeight()Description copied from interface:ISettings
When drawingGanttPhase
s this is the header height used for displaying the names of these phases.- Specified by:
getPhasesHeaderHeight
in interfaceISettings
- Returns:
- Default is 18
-
allowPhaseOverlap
public boolean allowPhaseOverlap()Description copied from interface:ISettings
When phases are resized or moved, whether an overlap resize/move should be accepted or not. If false (default), a resize will simply stop at the next phase border, whereas a move that is dropped on top of a different phase will be undone (no event is fired for this).- Specified by:
allowPhaseOverlap
in interfaceISettings
- Returns:
- Default is false
-
getVerticalEventDragging
public int getVerticalEventDragging()Description copied from interface:ISettings
What style of vertical event dragging that is enabled. For the "resistance" before a vertical drag takes place you can change this withISettings.getVerticalDragResistance()
.- Specified by:
getVerticalEventDragging
in interfaceISettings
- Returns:
- One of the options in
VerticalDragModes
. Default isVerticalDragModes.NO_VERTICAL_DRAG
-
getVerticalDragResistance
public int getVerticalDragResistance()Description copied from interface:ISettings
For events that can be dragged vertically, this is the "resistance" in pixels before the event "lets go" of it's horizontal location. Once it's let go it will stick to the mouse cursor.- Specified by:
getVerticalDragResistance
in interfaceISettings
- Returns:
- A pixel range of resistance. Default is 15px.
-
onVerticalDragDropShowInsertMarker
public boolean onVerticalDragDropShowInsertMarker()Description copied from interface:ISettings
Whether an insert marker should be shown for where the dragged event will end up when a vertical drag/drop is in progress.- Specified by:
onVerticalDragDropShowInsertMarker
in interfaceISettings
- Returns:
- true to show a marker. Default is true.
-
scaleImageToDayWidth
public boolean scaleImageToDayWidth()Description copied from interface:ISettings
Whether to allow an image to exceed the width of one day when zooming in / out.- Specified by:
scaleImageToDayWidth
in interfaceISettings
- Returns:
- true to keep within day width. Default is true.
-
allowArrowKeysToScrollChart
public boolean allowArrowKeysToScrollChart()Description copied from interface:ISettings
Whether arrow keys are enabled to scroll chart left/right/up/down.- Specified by:
allowArrowKeysToScrollChart
in interfaceISettings
- Returns:
- true to allow arrow keys to move the chart. Default is false.
-
getNumberOfDaysToAppendForEndOfDay
public int getNumberOfDaysToAppendForEndOfDay()Description copied from interface:ISettings
Normally a day is calculated as day_starts->day_ends, which means that to make an event that starts and ends on the same day count as "anything", +1 is added by default to make the event actually show up on the chart. Should you for some reason need to override this, change this number to 0 or whatever you may need.- Specified by:
getNumberOfDaysToAppendForEndOfDay
in interfaceISettings
- Returns:
- Number of days to count for a start and end date that is the same date. Default is 1.
-
scrollChartVerticallyOnMouseWheel
public boolean scrollChartVerticallyOnMouseWheel()Description copied from interface:ISettings
Whether the chart should scroll vertically when the mouse wheel is used. If you notice excessive scrolling on SWT versions earlier than 3.5, you may want to turn this off- Specified by:
scrollChartVerticallyOnMouseWheel
in interfaceISettings
- Returns:
- true to scroll chart vertically. Default is true.
-
getToolTipContentReplacer
Description copied from interface:ISettings
Returns the custom tool tip generator which generates the tooltip out of custom data for a GanttEvent.- Specified by:
getToolTipContentReplacer
in interfaceISettings
- Returns:
-
getMinZoomLevel
public int getMinZoomLevel()Description copied from interface:ISettings
Returns the minimum zoom level. Default should returnISettings.MIN_ZOOM_LEVEL
- Specified by:
getMinZoomLevel
in interfaceISettings
- Returns:
-
getPeriodStart
public java.util.Calendar getPeriodStart()Description copied from interface:ISettings
Specify a period start. Returning another value thannull
will result in rendering an additional line to the chart indicating a period start in the gantt itself.- Specified by:
getPeriodStart
in interfaceISettings
- Returns:
-
getPeriodEnd
public java.util.Calendar getPeriodEnd()Description copied from interface:ISettings
Specify a period end. Returning another value thannull
will result in rendering an additional line to the chart indicating a period end in the gantt itself.- Specified by:
getPeriodEnd
in interfaceISettings
- Returns:
-
shiftHorizontalCenteredEventString
public boolean shiftHorizontalCenteredEventString()Description copied from interface:ISettings
If you want to show the event String within the event rectangle by setting the horizontalTextLocation of the GanttEvent to SWT.CENTER, there are cases that break the visualization. If your event String is longer than the event in the Gantt, it will look quite strange.If this method returns
true
, the AbstractPaintManager will shift the rendering of the event String to the right if the String length is greater than the event rectangle.- Specified by:
shiftHorizontalCenteredEventString
in interfaceISettings
- Returns:
true
if the event String should be shifted,false
if not
-
enableAddEvent
public boolean enableAddEvent()- Specified by:
enableAddEvent
in interfaceISettings
- Returns:
true
to enable the menu action for adding an event to the GanttChart,false
if this action should not be available to the user.
-
drawEventString
public boolean drawEventString()Description copied from interface:ISettings
Global configuration to specify if the text of GanttEvents should be rendered or not. It is also possible to configure this per GanttEvent via _showText property.- Specified by:
drawEventString
in interfaceISettings
- Returns:
true
if the event text should be rendered,false
if not.
-
alwaysDragAllEvents
public boolean alwaysDragAllEvents()Description copied from interface:ISettings
The default behaviour in GanttChart on moving an event is that only the current dragged event is moved unless you press the SHIFT key. If there are more events selected, still only the dragged one is moved if the SHIFT key is not pressed. With this configuration it is possible to specify if the old default behavior should be used or if all currently selected events should be moved even if the SHIFT key is not pressed.- Specified by:
alwaysDragAllEvents
in interfaceISettings
- Returns:
true
if all selected events should be moved by dragging on of themfalse
if only the current dragged event should be moved.
-
printSelectedVerticallyComplete
public boolean printSelectedVerticallyComplete()Description copied from interface:ISettings
On printing a GanttChart it is possible to select to print only the selected area. For GanttChart this means to print the currently visible area. By default currently visible means vertically AND horizontally visible. This configuration allows to specify whether the vertical part should extend to the whole chart and only the horizontal area should be limited for the visible part.- Specified by:
printSelectedVerticallyComplete
in interfaceISettings
- Returns:
true
if the printed chart should contain the whole chart vertically but only the horizontal visible part of the chart,false
if only the visible part of the chart should be printed, horizontally AND vertically
-
printFooter
public boolean printFooter()Description copied from interface:ISettings
Configure whether a footer should be added to the print pages or not. The footer contains the page number and the date when the print was requested.- Specified by:
printFooter
in interfaceISettings
- Returns:
true
if a footer should be added to the print pages,false
if not
-
drawSectionBar
public boolean drawSectionBar()Description copied from interface:ISettings
Configure whether the section bar should be rendered. It only makes sense to not render the section bar if the section details are enabled.- Specified by:
drawSectionBar
in interfaceISettings
- Returns:
true
if the section bar should be rendered,false
if not
-
drawSectionDetails
public boolean drawSectionDetails()Description copied from interface:ISettings
Configure whether there should be an additional area to the section bar that shows additional section detail information.- Specified by:
drawSectionDetails
in interfaceISettings
- Returns:
true
if additional section detail information should be rendered,false
if not
-
getSectionDetailWidth
public int getSectionDetailWidth()- Specified by:
getSectionDetailWidth
in interfaceISettings
- Returns:
- The width of the section detail area.
-
getSectionDetailTitle
public java.lang.String getSectionDetailTitle()Description copied from interface:ISettings
The section detail area title that should be rendered in the section detail area.- Specified by:
getSectionDetailTitle
in interfaceISettings
- Returns:
- String or null. Default is a bold black text showing the section name.
-
getSectionDetailText
public java.lang.String getSectionDetailText()Description copied from interface:ISettings
The detail information that should be rendered in the section detail area.- Specified by:
getSectionDetailText
in interfaceISettings
- Returns:
- String or null. Default is to show the number of events in that section.
-
getSectionDetailContentReplacer
Description copied from interface:ISettings
Returns the custom section detail generator which generates the section detail out of custom data for a GanttSection.- Specified by:
getSectionDetailContentReplacer
in interfaceISettings
- Returns:
-
showSectionDetailMore
public boolean showSectionDetailMore()- Specified by:
showSectionDetailMore
in interfaceISettings
- Returns:
true
if there should be a "more [+]" shown in the section detail area which allows to register a listener against to show more informations by e.g. opening a dialog.
-
showHolidayToolTips
public boolean showHolidayToolTips()Description copied from interface:ISettings
Configure whether a tooltip pops up when hovering the mouse over a holiday- Specified by:
showHolidayToolTips
in interfaceISettings
- Returns:
true
to show a "holiday" popup with the configured name of the holiday,false
if not (default)
-
enableTodayLineUpdater
public boolean enableTodayLineUpdater()Description copied from interface:ISettings2
Start the updating tread for TodayLine (red line marking current time)- Specified by:
enableTodayLineUpdater
in interfaceISettings2
- Returns:
true
Start Threadfalse
Skip Thread
-
fireEmptyEventSelection
public boolean fireEmptyEventSelection()Description copied from interface:ISettings
whetherIGanttEventListener.eventSelected(GanttEvent, java.util.List, org.eclipse.swt.events.MouseEvent)
should also be called on empty selection- Specified by:
fireEmptyEventSelection
in interfaceISettings
- Returns:
- true to have the event fired. Default is false
-