com.sap.ui.commons.client
Class RoadMapStep

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.commons.client.RoadMapStep

public class RoadMapStep
extends com.sap.ui.core.client.Element

The class RoadMapStep is the GWT wrapper for the Phoenix control: sap.ui.commons.RoadMapStep.

Subcontrol of the RoadMap control

• Properties
  • label : String
    Label of the step
  • enabled : boolean
    The step can be click or expanded if it contains substeps
  • expanded : boolean
    The step is by default display expanded. Relevant only when it has substeps
  • visible : boolean
    Step is visible
• Aggregations
  • subSteps : com.sap.ui.commons.client.RoadMapStep
    Substeps for the current step. Will be display only if the step is expanded. If not special arrows will show the presence of substeps. Curretnly only one substep level supported.
• Associations
• Events

For further parameters see {@link com.sap.ui.core.client.Element

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.RoadMapStep)

Constructor Summary

protected

RoadMapStep() constructs the class RoadMapStep hidden due to JavaScriptObject restriction

Method Summary

RoadMapStep	addSubStep(RoadMapStep subStep) Appends a subStep to the aggregation subSteps.
static RoadMapStep	create() creates a new instance of the class RoadMapStep
static RoadMapStep	create(String idOrConfig) creates a new instance of the class RoadMapStep
static RoadMapStep	create(String id, String config) creates a new instance of the class RoadMapStep
RoadMapStep	destroySubSteps() Destroys all the subSteps in the SubSteps-aggregation.
String	getLabel() Getter for property label Label of the step
com.sap.ui.core.client.js.JsArray<RoadMapStep>	getSubSteps() Getter for aggregation subSteps Substeps for the current step.
int	indexOfSubStep(RoadMapStep subStep) Checks for the provided com.sap.ui.commons.client.RoadMapStep in the subSteps-aggregation and returns its index if found or -1 otherwise.
RoadMapStep	insertSubStep(RoadMapStep subStep, int index) Inserts some subStep into the aggregation named subSteps.
boolean	isEnabled() Getter for property enabled The step can be click or expanded if it contains substeps
boolean	isExpanded() Getter for property expanded The step is by default display expanded.
boolean	isVisible() Getter for property visible Step is visible
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RoadMapStep>>	removeAllSubSteps() Removes all the items in the subSteps-aggregation.
com.sap.ui.core.client.js.JsArray<RoadMapStep>	removeSubStep(int index) Removes a subStep from the aggregation named subSteps.
RoadMapStep	setEnabled(boolean value) Setter for property enabled Default value is: true
RoadMapStep	setExpanded(boolean value) Setter for property expanded Default value is: false
RoadMapStep	setLabel(String value) Setter for property label
RoadMapStep	setVisible(boolean value) Setter for property visible Default value is: true

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RoadMapStep

protected RoadMapStep()

constructs the class RoadMapStep
hidden due to JavaScriptObject restriction

Method Detail

create

public static RoadMapStep create()

creates a new instance of the class RoadMapStep

create

public static RoadMapStep create(String idOrConfig)

creates a new instance of the class RoadMapStep

Parameters:

id - id of the RoadMapStep or configuration JSON string

create

public static RoadMapStep create(String id,
                                 String config)

creates a new instance of the class RoadMapStep

Parameters:

id - id of the RoadMapStep

config - configuration JSON string

getLabel

public final String getLabel()

Getter for property label Label of the step

Returns:

the value of property label

setLabel

public final RoadMapStep setLabel(String value)

Setter for property label

Parameters:

value - String

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled The step can be click or expanded if it contains substeps

Returns:

the value of property enabled

setEnabled

public final RoadMapStep setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isExpanded

public final boolean isExpanded()

Getter for property expanded The step is by default display expanded. Relevant only when it has substeps

Returns:

the value of property expanded

setExpanded

public final RoadMapStep setExpanded(boolean value)

Setter for property expanded
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Step is visible

Returns:

the value of property visible

setVisible

public final RoadMapStep setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getSubSteps

public final com.sap.ui.core.client.js.JsArray<RoadMapStep> getSubSteps()

Getter for aggregation subSteps Substeps for the current step. Will be display only if the step is expanded. If not special arrows will show the presence of substeps. Curretnly only one substep level supported.

Returns:

com.sap.ui.commons.client.RoadMapStep[]

insertSubStep

public final RoadMapStep insertSubStep(RoadMapStep subStep,
                                       int index)

Inserts some subStep into the aggregation named subSteps.

Parameters:

subStep - the subStep to insert

index - int the 0-based index the subStep should be inserted at.

Returns:

this to allow method chaining

addSubStep

public final RoadMapStep addSubStep(RoadMapStep subStep)

Appends a subStep to the aggregation subSteps.

Parameters:

subStep - com.sap.ui.commons.client.RoadMapStep the subStep to add

Returns:

this to allow method chaining

removeSubStep

public final com.sap.ui.core.client.js.JsArray<RoadMapStep> removeSubStep(int index)

Removes a subStep from the aggregation named subSteps.

Parameters:

index - int the position of the subStep to remove.

Returns:

reference to this instance

removeAllSubSteps

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RoadMapStep>> removeAllSubSteps()

Removes all the items in the subSteps-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfSubStep

public final int indexOfSubStep(RoadMapStep subStep)

Checks for the provided com.sap.ui.commons.client.RoadMapStep in the subSteps-aggregation and returns its index if found or -1 otherwise.

Parameters:

subStep - the subStep whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroySubSteps

public final RoadMapStep destroySubSteps()

Destroys all the subSteps in the SubSteps-aggregation.

Returns:

this to allow method chaining