TimeLineHelper

• Open Markdown

• ---

• Open in ChatGPT
• Open in Claude
• Open in Perplexity

Inheritance: java.lang.Object

public class TimeLineHelper

TimeLineHelper to set property of timeline shape. Compatibility shell over TimeLineProperties: the public API is unchanged (plus getters for the previously write-only properties), the cell access is delegated to the properties class, and refreshTimeLine() is rewritten:

| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| /// The begin/end date text shapes are updated by position without skipping the last /// child, so the end-date text shape is updated as well. ///                                                                                 |
| /// Master-instance markers (milestones, intervals) inside the period keep their /// field \\u9225?the old code overwrote every master-instance child field with the start /// date. Out-of-range markers are deleted instead. /// |
| /// Previously generated interim ticks are removed and regenerated with the interim /// User cells (visTLShape, visInterimType) that real timeline ticks carry, so they /// render as timeline ticks in Visio. ///                 |
| /// Year-scale ticks land on January 1 boundaries, so ranges that cross a year /// boundary are no longer empty for spans under one year. ///                                                                                      |

|

Constructors

Constructor	Description
TimeLineHelper(Shape shape)	TimeLineHelper.

Methods

Method	Description
equals(Object arg0)
getArrowHead()	ArrowHead of timeline shape
getBeginWeek()	Begin week of timeline shape
getClass()
getDateFormatForBE()	DateFormat for start and finish of timeline shape
getDateFormatForIntm()	DateFormat for Intm of timeline shape
getDateFormatStringForBE()	DateFormat String for start and finish of timeline shape
getDateFormatStringForIntm()	DateFormat String for Intm of timeline shape
getDoubleStringFromDateTime(DateTime dateTime)	Convert the date time to double value.
getFiscalStart()	First day of fiscal year
getTimeLineType()	Begin week of timeline shape
getTimePeriodFinish()	Time Period for finish of timeline shape
getTimePeriodStart()	Time Period for start of timeline shape
getTimeScale()	scale of timeline shape
getWeekEnd(DateTime startDate, int weekStart)	getweekstart
hashCode()
isAutoUpdate()	whether to update data for markers (milestones, intervals) as they are moved on timeline
isDisplayBE()	whether to display Begin and End dates on timeline
isDisplayIntm()	whether to display interim date/time ticks on timeline
isDisplayIntmDates()	whether to display interim dates on interim ticks
notify()
notifyAll()
refreshTimeLine()	Refresh time of timeline shapes
setArrowHead(int value)	For the description of this property, please see getArrowHead()
setAutoUpdate(boolean value)	For the description of this property, please see isAutoUpdate()
setBeginWeek(int value)	For the description of this property, please see getBeginWeek()
setDateFormatForBE(int value)	For the description of this property, please see getDateFormatForBE()
setDateFormatForIntm(int value)	For the description of this property, please see getDateFormatForIntm()
setDateFormatStringForBE(String value)	For the description of this property, please see getDateFormatStringForBE()
setDateFormatStringForIntm(String value)	For the description of this property, please see getDateFormatStringForIntm()
setDisplayBE(boolean value)	For the description of this property, please see isDisplayBE()
setDisplayIntm(boolean value)	For the description of this property, please see isDisplayIntm()
setDisplayIntmDates(boolean value)	For the description of this property, please see isDisplayIntmDates()
setFiscalStart(DateTime value)	For the description of this property, please see getFiscalStart()
setTimeLineType(int value)	For the description of this property, please see getTimeLineType()
setTimePeriodFinish(DateTime value)	For the description of this property, please see getTimePeriodFinish()
setTimePeriodStart(DateTime value)	For the description of this property, please see getTimePeriodStart()
setTimeScale(int value)	For the description of this property, please see getTimeScale()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

TimeLineHelper(Shape shape)

public TimeLineHelper(Shape shape)

TimeLineHelper.

Parameters:

Parameter	Type	Description
shape	Shape

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getArrowHead()

public int getArrowHead()

ArrowHead of timeline shape

Returns: int

getBeginWeek()

public int getBeginWeek()

Begin week of timeline shape

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getDateFormatForBE()

public int getDateFormatForBE()

DateFormat for start and finish of timeline shape

Returns: int

getDateFormatForIntm()

public int getDateFormatForIntm()

DateFormat for Intm of timeline shape

Returns: int

getDateFormatStringForBE()

public String getDateFormatStringForBE()

DateFormat String for start and finish of timeline shape

Returns: java.lang.String

getDateFormatStringForIntm()

public String getDateFormatStringForIntm()

DateFormat String for Intm of timeline shape

Returns: java.lang.String

getDoubleStringFromDateTime(DateTime dateTime)

public static String getDoubleStringFromDateTime(DateTime dateTime)

Convert the date time to double value.

Parameters:

Parameter	Type	Description
dateTime	DateTime	The date time.

Returns: java.lang.String -

getFiscalStart()

public DateTime getFiscalStart()

First day of fiscal year

Returns: DateTime

getTimeLineType()

public int getTimeLineType()

Begin week of timeline shape

Returns: int

getTimePeriodFinish()

public DateTime getTimePeriodFinish()

Time Period for finish of timeline shape

Returns: DateTime

getTimePeriodStart()

public DateTime getTimePeriodStart()

Time Period for start of timeline shape

Returns: DateTime

getTimeScale()

public int getTimeScale()

scale of timeline shape

Returns: int

getWeekEnd(DateTime startDate, int weekStart)

public static DateTime getWeekEnd(DateTime startDate, int weekStart)

getweekstart

Parameters:

Parameter	Type	Description
startDate	DateTime
weekStart	int	(0sunday 1monday 2 3 4 5 6)

Returns: DateTime -

hashCode()

public native int hashCode()

Returns: int

isAutoUpdate()

public boolean isAutoUpdate()

whether to update data for markers (milestones, intervals) as they are moved on timeline

Returns: boolean

isDisplayBE()

public boolean isDisplayBE()

whether to display Begin and End dates on timeline

Returns: boolean

isDisplayIntm()

public boolean isDisplayIntm()

whether to display interim date/time ticks on timeline

Returns: boolean

isDisplayIntmDates()

public boolean isDisplayIntmDates()

whether to display interim dates on interim ticks

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

refreshTimeLine()

public void refreshTimeLine()

Refresh time of timeline shapes

setArrowHead(int value)

public void setArrowHead(int value)

For the description of this property, please see getArrowHead()

Parameters:

Parameter	Type	Description
value	int

setAutoUpdate(boolean value)

public void setAutoUpdate(boolean value)

For the description of this property, please see isAutoUpdate()

Parameters:

Parameter	Type	Description
value	boolean

setBeginWeek(int value)

public void setBeginWeek(int value)

For the description of this property, please see getBeginWeek()

Parameters:

Parameter	Type	Description
value	int

setDateFormatForBE(int value)

public void setDateFormatForBE(int value)

For the description of this property, please see getDateFormatForBE()

Parameters:

Parameter	Type	Description
value	int

setDateFormatForIntm(int value)

public void setDateFormatForIntm(int value)

For the description of this property, please see getDateFormatForIntm()

Parameters:

Parameter	Type	Description
value	int

setDateFormatStringForBE(String value)

public void setDateFormatStringForBE(String value)

For the description of this property, please see getDateFormatStringForBE()

Parameters:

Parameter	Type	Description
value	java.lang.String

setDateFormatStringForIntm(String value)

public void setDateFormatStringForIntm(String value)

For the description of this property, please see getDateFormatStringForIntm()

Parameters:

Parameter	Type	Description
value	java.lang.String

setDisplayBE(boolean value)

public void setDisplayBE(boolean value)

For the description of this property, please see isDisplayBE()

Parameters:

Parameter	Type	Description
value	boolean

setDisplayIntm(boolean value)

public void setDisplayIntm(boolean value)

For the description of this property, please see isDisplayIntm()

Parameters:

Parameter	Type	Description
value	boolean

setDisplayIntmDates(boolean value)

public void setDisplayIntmDates(boolean value)

For the description of this property, please see isDisplayIntmDates()

Parameters:

Parameter	Type	Description
value	boolean

setFiscalStart(DateTime value)

public void setFiscalStart(DateTime value)

For the description of this property, please see getFiscalStart()

Parameters:

Parameter	Type	Description
value	DateTime

setTimeLineType(int value)

public void setTimeLineType(int value)

For the description of this property, please see getTimeLineType()

Parameters:

Parameter	Type	Description
value	int

setTimePeriodFinish(DateTime value)

public void setTimePeriodFinish(DateTime value)

For the description of this property, please see getTimePeriodFinish()

Parameters:

Parameter	Type	Description
value	DateTime

setTimePeriodStart(DateTime value)

public void setTimePeriodStart(DateTime value)

For the description of this property, please see getTimePeriodStart()

Parameters:

Parameter	Type	Description
value	DateTime

setTimeScale(int value)

public void setTimeScale(int value)

For the description of this property, please see getTimeScale()

Parameters:

Parameter	Type	Description
value	int

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int