Class ViewTitleBarProperties
- java.lang.Object
-
- net.infonode.properties.propertymap.PropertyMapContainer
-
- net.infonode.docking.properties.ViewTitleBarProperties
-
public class ViewTitleBarProperties extends PropertyMapContainer
Properties and property values for a view title bar.- Since:
- IDW 1.4.0
-
-
Field Summary
Fields Modifier and Type Field Description static IntegerProperty
CONTENT_TITLE_BAR_GAP
Content title bar gap propertystatic DirectionProperty
DIRECTION
Direction propertystatic PropertyMapProperty
FOCUSED_PROPERTIES
Focused properties.static HoverListenerProperty
HOVER_LISTENER
Hover listener propertystatic DimensionProviderProperty
MINIMUM_SIZE_PROVIDER
Title bar minimum size propertystatic PropertyMapProperty
NORMAL_PROPERTIES
Normal propertiesstatic DirectionProperty
ORIENTATION
Orientation propertystatic PropertyMapGroup
PROPERTIES
Property group containing all view title bar properties.static BooleanProperty
VISIBLE
Visible property
-
Constructor Summary
Constructors Constructor Description ViewTitleBarProperties()
Creates an empty property object.ViewTitleBarProperties(ViewTitleBarProperties inheritFrom)
Creates a property object that inherit values from another property object.ViewTitleBarProperties(PropertyMap map)
Creates a property object containing the map.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ViewTitleBarProperties
addSuperObject(ViewTitleBarProperties properties)
Adds a super object from which property values are inherited.int
getContentTitleBarGap()
Returns the gap between the view's content and the title barDirection
getDirection()
Returns the layout directionViewTitleBarStateProperties
getFocusedProperties()
Returns the property values for the title bar's focused stateHoverListener
getHoverListener()
Gets the hover listener that will be triggered when the title bar is hovered by the mouse.DimensionProvider
getMinimumSizeProvider()
Gets the dimension provider for the title bar's minimum sizeViewTitleBarStateProperties
getNormalProperties()
Returns the property values for the title bar's normal stateDirection
getOrientation()
Returns the orientation i.e.boolean
getVisible()
Returns if the title bar should be visible or notViewTitleBarProperties
removeSuperObject(ViewTitleBarProperties superObject)
Removes a super object.ViewTitleBarProperties
setContentTitleBarGap(int gap)
Sets the gap between the view's content and the title barViewTitleBarProperties
setDirection(Direction direction)
Sets the layout directionViewTitleBarProperties
setHoverListener(HoverListener listener)
Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.ViewTitleBarProperties
setMinimumSizeProvider(DimensionProvider size)
Sets the title bar's minimum size dimension providerViewTitleBarProperties
setOrientation(Direction orientation)
Sets the orientation i.e.ViewTitleBarProperties
setVisible(boolean visible)
Sets if the title bar should be visible or not-
Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
-
-
-
Field Detail
-
PROPERTIES
public static final PropertyMapGroup PROPERTIES
Property group containing all view title bar properties.
-
NORMAL_PROPERTIES
public static final PropertyMapProperty NORMAL_PROPERTIES
Normal properties- See Also:
getNormalProperties()
-
FOCUSED_PROPERTIES
public static final PropertyMapProperty FOCUSED_PROPERTIES
Focused properties. Added as super object to normal properties when view has focus- See Also:
getFocusedProperties()
-
VISIBLE
public static final BooleanProperty VISIBLE
Visible property- See Also:
setVisible(boolean)
,getVisible()
-
MINIMUM_SIZE_PROVIDER
public static final DimensionProviderProperty MINIMUM_SIZE_PROVIDER
Title bar minimum size property
-
CONTENT_TITLE_BAR_GAP
public static final IntegerProperty CONTENT_TITLE_BAR_GAP
Content title bar gap property
-
ORIENTATION
public static final DirectionProperty ORIENTATION
Orientation property
-
DIRECTION
public static final DirectionProperty DIRECTION
Direction property
-
HOVER_LISTENER
public static final HoverListenerProperty HOVER_LISTENER
Hover listener property
-
-
Constructor Detail
-
ViewTitleBarProperties
public ViewTitleBarProperties()
Creates an empty property object.
-
ViewTitleBarProperties
public ViewTitleBarProperties(PropertyMap map)
Creates a property object containing the map.- Parameters:
map
- the property map
-
ViewTitleBarProperties
public ViewTitleBarProperties(ViewTitleBarProperties inheritFrom)
Creates a property object that inherit values from another property object.- Parameters:
inheritFrom
- the object from which to inherit property values
-
-
Method Detail
-
addSuperObject
public ViewTitleBarProperties addSuperObject(ViewTitleBarProperties properties)
Adds a super object from which property values are inherited.- Parameters:
properties
- the object from which to inherit property values- Returns:
- this
-
removeSuperObject
public ViewTitleBarProperties removeSuperObject(ViewTitleBarProperties superObject)
Removes a super object.- Parameters:
superObject
- the super object to remove- Returns:
- this
-
getNormalProperties
public ViewTitleBarStateProperties getNormalProperties()
Returns the property values for the title bar's normal state- Returns:
- the property values for the title bar's normal state
-
getFocusedProperties
public ViewTitleBarStateProperties getFocusedProperties()
Returns the property values for the title bar's focused state
Note:These properties are added as super object to the normal properties when the view has focus.
- Returns:
- the property values for the title bar's focused state
-
setVisible
public ViewTitleBarProperties setVisible(boolean visible)
Sets if the title bar should be visible or not- Parameters:
visible
- True for visible, otherwise false- Returns:
- this
-
getVisible
public boolean getVisible()
Returns if the title bar should be visible or not- Returns:
- True if visible, otherwise false
-
setMinimumSizeProvider
public ViewTitleBarProperties setMinimumSizeProvider(DimensionProvider size)
Sets the title bar's minimum size dimension provider- Parameters:
size
- the minimum size dimension provider or null if title bar's default minimum size should be used instead- Returns:
- this ViewTitleBarProperties
-
getMinimumSizeProvider
public DimensionProvider getMinimumSizeProvider()
Gets the dimension provider for the title bar's minimum size- Returns:
- the minimum size provider or null if default title bar minimum size is to be used instead
-
setContentTitleBarGap
public ViewTitleBarProperties setContentTitleBarGap(int gap)
Sets the gap between the view's content and the title bar- Parameters:
gap
- gap in pixels- Returns:
- this
-
getContentTitleBarGap
public int getContentTitleBarGap()
Returns the gap between the view's content and the title bar- Returns:
- gap in pixels
-
setOrientation
public ViewTitleBarProperties setOrientation(Direction orientation)
Sets the orientation i.e. on what side of the view's content the title bar will be placed- Parameters:
orientation
- the orientation- Returns:
- this
-
getOrientation
public Direction getOrientation()
Returns the orientation i.e. on what side of the view's content the title bar will be placed- Returns:
- the orientation
-
setDirection
public ViewTitleBarProperties setDirection(Direction direction)
Sets the layout direction
The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.
- Parameters:
direction
- the layout direction- Returns:
- this
-
getDirection
public Direction getDirection()
Returns the layout direction
The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.
- Returns:
- the layout direction
-
setHoverListener
public ViewTitleBarProperties setHoverListener(HoverListener listener)
Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.
The view that contains the title bar will be the source of the hover event sent to the hover listener.
- Parameters:
listener
- the hover listener- Returns:
- this
- See Also:
HoverEvent
-
getHoverListener
public HoverListener getHoverListener()
Gets the hover listener that will be triggered when the title bar is hovered by the mouse.
The view that contains the title bar will be the source of the hover event sent to the hover listener.
- Returns:
- the hover listener
- See Also:
HoverEvent
-
-