Class Lane
- All Implemented Interfaces:
HasHandlers
Timeline view, or in a day view when showDayLanes is true. Each lane is a row or column,
respectively, that can contain a set of CalendarEvents. CalendarEvents are
placed in lanes by matching the name property to the value of
the Calendar.laneNameField property on the
CalendarEvent. Lanes are typically used to show tasks assigned to different people, broadcasts planned for different channels, and similar displays.
-
Field Summary
Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe base name for the CSS class applied toeventswhen they're rendered in this lane.The base style-name forlane-fieldsdisplayed in this Lane.InTimelines, the height of this Lane's row.getName()To determine whether a CalendarEvent should be placed in this lane, the value of this attribute is compared with theCalendar.laneNameFieldproperty on the CalendarEvent.static LanegetOrCreateRef(JavaScriptObject jsObj) The base style-name for normal cells in this Lane.Lane[]getTitle()Title to show for this lane.getWidth()When set on a Lane being displayed in aday viewas a result ofCalendar.showDayLanesbeing set, dictates the width of the Lane's column.setEventStyleName(String eventStyleName) The base name for the CSS class applied toeventswhen they're rendered in this lane.setFieldStyleName(String fieldStyleName) The base style-name forlane-fieldsdisplayed in this Lane.InTimelines, the height of this Lane's row.To determine whether a CalendarEvent should be placed in this lane, the value of this attribute is compared with theCalendar.laneNameFieldproperty on the CalendarEvent.setStyleName(String styleName) The base style-name for normal cells in this Lane.setSublanes(Lane... sublanes) Title to show for this lane.When set on a Lane being displayed in aday viewas a result ofCalendar.showDayLanesbeing set, dictates the width of the Lane's column.Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
-
Constructor Details
-
Lane
public Lane() -
Lane
-
Lane
-
-
Method Details
-
getOrCreateRef
-
setEventStyleName
The base name for the CSS class applied toeventswhen they're rendered in this lane. SeeCalendar.eventStyleName.If set directly on a
sublane, overrides the corresponding value on the parentlane. SeegetEventCanvasStyle()for more information.- Parameters:
eventStyleName- New eventStyleName value. Default value is null- Returns:
Laneinstance, for chaining setter calls- See Also:
-
getEventStyleName
The base name for the CSS class applied toeventswhen they're rendered in this lane. SeeCalendar.eventStyleName.If set directly on a
sublane, overrides the corresponding value on the parentlane. SeegetEventCanvasStyle()for more information.- Returns:
- Current eventStyleName value. Default value is null
- See Also:
-
setFieldStyleName
The base style-name forlane-fieldsdisplayed in this Lane.- Parameters:
fieldStyleName- New fieldStyleName value. Default value is null- Returns:
Laneinstance, for chaining setter calls- See Also:
-
getFieldStyleName
The base style-name forlane-fieldsdisplayed in this Lane.- Returns:
- Current fieldStyleName value. Default value is null
- See Also:
-
setHeight
InTimelines, the height of this Lane's row. Has no effect when set on a Lane being displayed in aday viewas a result ofCalendar.showDayLanesbeing true.If set directly on a
sublane, overrides the default behavior of dividing the height equally among the lane's sublanes. Each sublane is still initially assigned an equal slice of the parent height, and the value for this sublane is then updated. So the overall height of the parent lane will change by the delta between the initial slice and the specified one.- Parameters:
height- New height value. Default value is null- Returns:
Laneinstance, for chaining setter calls
-
getHeight
InTimelines, the height of this Lane's row. Has no effect when set on a Lane being displayed in aday viewas a result ofCalendar.showDayLanesbeing true.If set directly on a
sublane, overrides the default behavior of dividing the height equally among the lane's sublanes. Each sublane is still initially assigned an equal slice of the parent height, and the value for this sublane is then updated. So the overall height of the parent lane will change by the delta between the initial slice and the specified one.- Returns:
- Current height value. Default value is null
-
setName
To determine whether a CalendarEvent should be placed in this lane, the value of this attribute is compared with theCalendar.laneNameFieldproperty on the CalendarEvent.- Parameters:
name- New name value. Default value is null- Returns:
Laneinstance, for chaining setter calls
-
getName
To determine whether a CalendarEvent should be placed in this lane, the value of this attribute is compared with theCalendar.laneNameFieldproperty on the CalendarEvent.- Returns:
- Current name value. Default value is null
-
setStyleName
The base style-name for normal cells in this Lane.- Parameters:
styleName- New styleName value. Default value is null- Returns:
Laneinstance, for chaining setter calls- See Also:
-
getStyleName
The base style-name for normal cells in this Lane.- Returns:
- Current styleName value. Default value is null
- See Also:
-
setSublanes
Array ofLaneobjects that will share the available space in the parent Lane, vertically intimelinesand horizontally inday views.Only one level of sublanes is supported, so this attribute only has an effect on
top-level lanes.Note that this feature is mutually exclusive with the
auto arrangementof events that share time.- Parameters:
sublanes- New sublanes value. Default value is null- Returns:
Laneinstance, for chaining setter calls
-
getSublanes
Array ofLaneobjects that will share the available space in the parent Lane, vertically intimelinesand horizontally inday views.Only one level of sublanes is supported, so this attribute only has an effect on
top-level lanes.Note that this feature is mutually exclusive with the
auto arrangementof events that share time.- Returns:
- Current sublanes value. Default value is null
-
setTitle
Title to show for this lane. Has no effect if set directly onsublanes.- Parameters:
title- New title value. Default value is null- Returns:
Laneinstance, for chaining setter calls- See Also:
-
getTitle
Title to show for this lane. Has no effect if set directly onsublanes.- Returns:
- Current title value. Default value is null
- See Also:
-
setWidth
When set on a Lane being displayed in aday viewas a result ofCalendar.showDayLanesbeing set, dictates the width of the Lane's column. Has no effect inTimelines.If set directly on a
sublane, overrides the default behavior of dividing the width equally among the lane's sublanes. Each sublane is still initially assigned an equal slice of the original parent width, and the value for this sublane is then updated. So the overall width of the parent lane will change by the delta between the initial slice and the specified one.- Parameters:
width- New width value. Default value is null- Returns:
Laneinstance, for chaining setter calls
-
getWidth
When set on a Lane being displayed in aday viewas a result ofCalendar.showDayLanesbeing set, dictates the width of the Lane's column. Has no effect inTimelines.If set directly on a
sublane, overrides the default behavior of dividing the width equally among the lane's sublanes. Each sublane is still initially assigned an equal slice of the original parent width, and the value for this sublane is then updated. So the overall width of the parent lane will change by the delta between the initial slice and the specified one.- Returns:
- Current width value. Default value is null
-